Merge branch 'master' of https://github.com/JonCook/tutorials

spring-ehcache/.gitignore

@@ -0,0 +1,13 @@
+*.class
+
+#folders#
+/target
+/neoDb*
+/data
+/src/main/webapp/WEB-INF/classes
+*/META-INF/*
+
+# Packaged files #
+*.jar
+*.war
+*.ear

spring-ehcache/README.md

@@ -0,0 +1,8 @@
+## Spring Ehcache
+
+This module contains articles about Spring with Ehcache
+
+### Relevant Articles:
+
+- [Spring Boot Ehcache Example](https://www.baeldung.com/spring-boot-ehcache)
+

spring-ehcache/checkstyle.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE module PUBLIC
+          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+<module name="Checker">
+	<module name="TreeWalker">
+		<module name="AvoidStarImport">
+			<property name="severity" value="warning" />
+		</module>
+	</module>
+</module>

spring-ehcache/pom.xml

@@ -0,0 +1,87 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>spring-ehcache</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <name>spring-ehcache</name>
+    <packaging>jar</packaging>
+
+    <parent>
+        <artifactId>parent-boot-2</artifactId>
+        <groupId>com.baeldung</groupId>
+        <version>0.0.1-SNAPSHOT</version>
+        <relativePath>../parent-boot-2</relativePath>
+    </parent>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-cache</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>javax.cache</groupId>
+            <artifactId>cache-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.ehcache</groupId>
+            <artifactId>ehcache</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <finalName>spring-ehcache</finalName>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
+
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <version>${checkstyle-maven-plugin.version}</version>
+                <configuration>
+                    <configLocation>checkstyle.xml</configLocation>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+    <reporting>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <version>${checkstyle-maven-plugin.version}</version>
+                <configuration>
+                    <configLocation>checkstyle.xml</configLocation>
+                </configuration>
+            </plugin>
+        </plugins>
+    </reporting>
+
+    <properties>
+        <!-- Maven plugins -->
+        <checkstyle-maven-plugin.version>3.0.0</checkstyle-maven-plugin.version>
+        <dependency.locations.enabled>false</dependency.locations.enabled>
+    </properties>
+
+</project>

spring-ehcache/src/main/java/com/baeldung/cachetest/Application.java

@@ -0,0 +1,13 @@
+package com.baeldung.cachetest;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Application {
+
+	public static void main(String[] args) {
+		SpringApplication.run(Application.class, args);
+	}
+
+}

spring-ehcache/src/main/java/com/baeldung/cachetest/config/CacheConfig.java

@@ -0,0 +1,10 @@
+package com.baeldung.cachetest.config;
+
+import org.springframework.cache.annotation.EnableCaching;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@EnableCaching
+public class CacheConfig {
+ 
+}

spring-ehcache/src/main/java/com/baeldung/cachetest/config/CacheEventLogger.java

@@ -0,0 +1,17 @@
+package com.baeldung.cachetest.config;
+
+import org.ehcache.event.CacheEvent;
+import org.ehcache.event.CacheEventListener;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class CacheEventLogger implements CacheEventListener<Object, Object> {
+
+    private static final Logger log = LoggerFactory.getLogger(CacheEventLogger.class);
+
+    @Override
+    public void onEvent(CacheEvent<? extends Object, ? extends Object> cacheEvent) {
+        log.info("Cache event {} for item with key {}. Old value = {}, New value = {}", cacheEvent.getType(), cacheEvent.getKey(), cacheEvent.getOldValue(), cacheEvent.getNewValue());
+    }
+
+}

spring-ehcache/src/main/java/com/baeldung/cachetest/rest/NumberController.java

@@ -0,0 +1,29 @@
+package com.baeldung.cachetest.rest;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import com.baeldung.cachetest.service.NumberService;
+
+@RestController
+@RequestMapping(path = "/number", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
+public class NumberController {
+
+    private final static Logger log = LoggerFactory.getLogger(NumberController.class);
+
+    @Autowired
+    private NumberService numberService;
+
+    @GetMapping(path = "/square/{number}")
+    public String getThing(@PathVariable Long number) {
+        log.info("call numberService to square {}", number);
+        return String.format("{\"square\": %s}", numberService.square(number));
+    }
+
+}

spring-ehcache/src/main/java/com/baeldung/cachetest/service/NumberService.java

@@ -0,0 +1,23 @@
+package com.baeldung.cachetest.service;
+
+import java.math.BigDecimal;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.cache.annotation.Cacheable;
+import org.springframework.stereotype.Service;
+
+@Service
+public class NumberService {
+
+    private final static Logger log = LoggerFactory.getLogger(NumberService.class);
+
+    @Cacheable(value = "squareCache", key = "#number", condition = "#number>10")
+    public BigDecimal square(Long number) {
+        BigDecimal square = BigDecimal.valueOf(number)
+            .multiply(BigDecimal.valueOf(number));
+        log.info("square of {} is {}", number, square);
+        return square;
+    }
+
+}

spring-ehcache/src/main/resources/application.properties

@@ -0,0 +1 @@
+spring.cache.jcache.config=classpath:ehcache.xml

spring-ehcache/src/main/resources/ehcache.xml

@@ -0,0 +1,31 @@
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="http://www.ehcache.org/v3"
+    xmlns:jsr107="http://www.ehcache.org/v3/jsr107"
+    xsi:schemaLocation="
+            http://www.ehcache.org/v3 http://www.ehcache.org/schema/ehcache-core-3.0.xsd
+            http://www.ehcache.org/v3/jsr107 http://www.ehcache.org/schema/ehcache-107-ext-3.0.xsd">
+
+    <cache alias="squareCache">
+        <key-type>java.lang.Long</key-type>
+        <value-type>java.math.BigDecimal</value-type>
+        <expiry>
+            <ttl unit="seconds">30</ttl>
+        </expiry>
+
+        <listeners>
+            <listener>
+                <class>com.baeldung.cachetest.config.CacheEventLogger</class>
+                <event-firing-mode>ASYNCHRONOUS</event-firing-mode>
+                <event-ordering-mode>UNORDERED</event-ordering-mode>
+                <events-to-fire-on>CREATED</events-to-fire-on>
+                <events-to-fire-on>EXPIRED</events-to-fire-on>
+            </listener>
+        </listeners>
+
+        <resources>
+            <heap unit="entries">2</heap>
+            <offheap unit="MB">10</offheap>
+        </resources>
+    </cache>
+
+</config>