@@ -27,6 +27,7 @@ | |||
<module>spring-boot-demo-orm-mybatis-plus</module> | |||
<module>spring-boot-demo-orm-beetlsql</module> | |||
<module>spring-boot-demo-cache-redis</module> | |||
<module>spring-boot-demo-cache-ehcache</module> | |||
<module>spring-boot-demo-email</module> | |||
<module>spring-boot-demo-upload</module> | |||
<module>spring-boot-demo-war</module> | |||
@@ -0,0 +1,25 @@ | |||
/target/ | |||
!.mvn/wrapper/maven-wrapper.jar | |||
### STS ### | |||
.apt_generated | |||
.classpath | |||
.factorypath | |||
.project | |||
.settings | |||
.springBeans | |||
.sts4-cache | |||
### IntelliJ IDEA ### | |||
.idea | |||
*.iws | |||
*.iml | |||
*.ipr | |||
### NetBeans ### | |||
/nbproject/private/ | |||
/build/ | |||
/nbbuild/ | |||
/dist/ | |||
/nbdist/ | |||
/.nb-gradle/ |
@@ -0,0 +1,301 @@ | |||
# spring-boot-demo-cache-ehcache | |||
> 此 demo 主要演示了 Spring Boot 如何集成 ehcache 使用缓存。 | |||
## pom.xml | |||
```xml | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<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-boot-demo-cache-ehcache</artifactId> | |||
<version>1.0.0-SNAPSHOT</version> | |||
<packaging>jar</packaging> | |||
<name>spring-boot-demo-cache-ehcache</name> | |||
<description>Demo project for Spring Boot</description> | |||
<parent> | |||
<groupId>com.xkcoding</groupId> | |||
<artifactId>spring-boot-demo</artifactId> | |||
<version>1.0.0-SNAPSHOT</version> | |||
</parent> | |||
<properties> | |||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | |||
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> | |||
<java.version>1.8</java.version> | |||
</properties> | |||
<dependencies> | |||
<dependency> | |||
<groupId>org.springframework.boot</groupId> | |||
<artifactId>spring-boot-starter</artifactId> | |||
</dependency> | |||
<dependency> | |||
<groupId>org.springframework.boot</groupId> | |||
<artifactId>spring-boot-starter-cache</artifactId> | |||
</dependency> | |||
<dependency> | |||
<groupId>net.sf.ehcache</groupId> | |||
<artifactId>ehcache</artifactId> | |||
</dependency> | |||
<dependency> | |||
<groupId>org.projectlombok</groupId> | |||
<artifactId>lombok</artifactId> | |||
<optional>true</optional> | |||
</dependency> | |||
<dependency> | |||
<groupId>com.google.guava</groupId> | |||
<artifactId>guava</artifactId> | |||
</dependency> | |||
<dependency> | |||
<groupId>org.springframework.boot</groupId> | |||
<artifactId>spring-boot-starter-test</artifactId> | |||
<scope>test</scope> | |||
</dependency> | |||
</dependencies> | |||
<build> | |||
<finalName>spring-boot-demo-cache-ehcache</finalName> | |||
<plugins> | |||
<plugin> | |||
<groupId>org.springframework.boot</groupId> | |||
<artifactId>spring-boot-maven-plugin</artifactId> | |||
</plugin> | |||
</plugins> | |||
</build> | |||
</project> | |||
``` | |||
## SpringBootDemoCacheEhcacheApplication.java | |||
```java | |||
/** | |||
* <p> | |||
* 启动类 | |||
* </p> | |||
* | |||
* @package: com.xkcoding.cache.ehcache | |||
* @description: 启动类 | |||
* @author: yangkai.shen | |||
* @date: Created in 2018/11/16 17:02 | |||
* @copyright: Copyright (c) 2018 | |||
* @version: V1.0 | |||
* @modified: yangkai.shen | |||
*/ | |||
@SpringBootApplication | |||
@EnableCaching | |||
public class SpringBootDemoCacheEhcacheApplication { | |||
public static void main(String[] args) { | |||
SpringApplication.run(SpringBootDemoCacheEhcacheApplication.class, args); | |||
} | |||
} | |||
``` | |||
## application.yml | |||
```yaml | |||
spring: | |||
cache: | |||
type: ehcache | |||
ehcache: | |||
config: classpath:ehcache.xml | |||
logging: | |||
level: | |||
com.xkcoding: debug | |||
``` | |||
## ehcache.xml | |||
```xml | |||
<!-- ehcache配置 --> | |||
<ehcache | |||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |||
xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd" | |||
updateCheck="false"> | |||
<!--缓存路径,用户目录下的base_ehcache目录--> | |||
<diskStore path="user.home/base_ehcache"/> | |||
<defaultCache | |||
maxElementsInMemory="20000" | |||
eternal="false" | |||
timeToIdleSeconds="120" | |||
timeToLiveSeconds="120" | |||
overflowToDisk="true" | |||
maxElementsOnDisk="10000000" | |||
diskPersistent="false" | |||
diskExpiryThreadIntervalSeconds="120" | |||
memoryStoreEvictionPolicy="LRU"/> | |||
<!-- | |||
缓存文件名:user,同样的可以配置多个缓存 | |||
maxElementsInMemory:内存中最多存储 | |||
eternal:外部存储 | |||
overflowToDisk:超出缓存到磁盘 | |||
diskPersistent:磁盘持久化 | |||
timeToLiveSeconds:缓存时间 | |||
diskExpiryThreadIntervalSeconds:磁盘过期时间 | |||
--> | |||
<cache name="user" | |||
maxElementsInMemory="20000" | |||
eternal="true" | |||
overflowToDisk="true" | |||
diskPersistent="false" | |||
timeToLiveSeconds="0" | |||
diskExpiryThreadIntervalSeconds="120"/> | |||
</ehcache> | |||
``` | |||
## UserServiceImpl.java | |||
```java | |||
/** | |||
* <p> | |||
* UserService | |||
* </p> | |||
* | |||
* @package: com.xkcoding.cache.ehcache.service.impl | |||
* @description: UserService | |||
* @author: yangkai.shen | |||
* @date: Created in 2018/11/16 16:54 | |||
* @copyright: Copyright (c) 2018 | |||
* @version: V1.0 | |||
* @modified: yangkai.shen | |||
*/ | |||
@Service | |||
@Slf4j | |||
public class UserServiceImpl implements UserService { | |||
/** | |||
* 模拟数据库 | |||
*/ | |||
private static final Map<Long, User> DATABASES = Maps.newConcurrentMap(); | |||
/** | |||
* 初始化数据 | |||
*/ | |||
static { | |||
DATABASES.put(1L, new User(1L, "user1")); | |||
DATABASES.put(2L, new User(2L, "user2")); | |||
DATABASES.put(3L, new User(3L, "user3")); | |||
} | |||
/** | |||
* 保存或修改用户 | |||
* | |||
* @param user 用户对象 | |||
* @return 操作结果 | |||
*/ | |||
@CachePut(value = "user", key = "#user.id") | |||
@Override | |||
public User saveOrUpdate(User user) { | |||
DATABASES.put(user.getId(), user); | |||
log.info("保存用户【user】= {}", user); | |||
return user; | |||
} | |||
/** | |||
* 获取用户 | |||
* | |||
* @param id key值 | |||
* @return 返回结果 | |||
*/ | |||
@Cacheable(value = "user", key = "#id") | |||
@Override | |||
public User get(Long id) { | |||
// 我们假设从数据库读取 | |||
log.info("查询用户【id】= {}", id); | |||
return DATABASES.get(id); | |||
} | |||
/** | |||
* 删除 | |||
* | |||
* @param id key值 | |||
*/ | |||
@CacheEvict(value = "user", key = "#id") | |||
@Override | |||
public void delete(Long id) { | |||
DATABASES.remove(id); | |||
log.info("删除用户【id】= {}", id); | |||
} | |||
} | |||
``` | |||
## UserServiceTest.java | |||
```java | |||
/** | |||
* <p> | |||
* ehcache缓存测试 | |||
* </p> | |||
* | |||
* @package: com.xkcoding.cache.ehcache.service | |||
* @description: ehcache缓存测试 | |||
* @author: yangkai.shen | |||
* @date: Created in 2018/11/16 16:58 | |||
* @copyright: Copyright (c) 2018 | |||
* @version: V1.0 | |||
* @modified: yangkai.shen | |||
*/ | |||
@Slf4j | |||
public class UserServiceTest extends SpringBootDemoCacheEhcacheApplicationTests { | |||
@Autowired | |||
private UserService userService; | |||
/** | |||
* 获取两次,查看日志验证缓存 | |||
*/ | |||
@Test | |||
public void getTwice() { | |||
// 模拟查询id为1的用户 | |||
User user1 = userService.get(1L); | |||
log.debug("【user1】= {}", user1); | |||
// 再次查询 | |||
User user2 = userService.get(1L); | |||
log.debug("【user2】= {}", user2); | |||
// 查看日志,只打印一次日志,证明缓存生效 | |||
} | |||
/** | |||
* 先存,再查询,查看日志验证缓存 | |||
*/ | |||
@Test | |||
public void getAfterSave() { | |||
userService.saveOrUpdate(new User(4L, "user4")); | |||
User user = userService.get(4L); | |||
log.debug("【user】= {}", user); | |||
// 查看日志,只打印保存用户的日志,查询是未触发查询日志,因此缓存生效 | |||
} | |||
/** | |||
* 测试删除,查看redis是否存在缓存数据 | |||
*/ | |||
@Test | |||
public void deleteUser() { | |||
// 查询一次,使ehcache中存在缓存数据 | |||
userService.get(1L); | |||
// 删除,查看ehcache是否存在缓存数据 | |||
userService.delete(1L); | |||
} | |||
} | |||
``` | |||
## 参考 | |||
- Ehcache 官网:http://www.ehcache.org/documentation/ | |||
- Spring Boot 官方文档:https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-caching-provider-ehcache2 | |||
- 博客:https://juejin.im/post/5b308de9518825748b56ae1d |
@@ -0,0 +1,69 @@ | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<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-boot-demo-cache-ehcache</artifactId> | |||
<version>1.0.0-SNAPSHOT</version> | |||
<packaging>jar</packaging> | |||
<name>spring-boot-demo-cache-ehcache</name> | |||
<description>Demo project for Spring Boot</description> | |||
<parent> | |||
<groupId>com.xkcoding</groupId> | |||
<artifactId>spring-boot-demo</artifactId> | |||
<version>1.0.0-SNAPSHOT</version> | |||
</parent> | |||
<properties> | |||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | |||
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> | |||
<java.version>1.8</java.version> | |||
</properties> | |||
<dependencies> | |||
<dependency> | |||
<groupId>org.springframework.boot</groupId> | |||
<artifactId>spring-boot-starter</artifactId> | |||
</dependency> | |||
<dependency> | |||
<groupId>org.springframework.boot</groupId> | |||
<artifactId>spring-boot-starter-cache</artifactId> | |||
</dependency> | |||
<dependency> | |||
<groupId>net.sf.ehcache</groupId> | |||
<artifactId>ehcache</artifactId> | |||
</dependency> | |||
<dependency> | |||
<groupId>org.projectlombok</groupId> | |||
<artifactId>lombok</artifactId> | |||
<optional>true</optional> | |||
</dependency> | |||
<dependency> | |||
<groupId>com.google.guava</groupId> | |||
<artifactId>guava</artifactId> | |||
</dependency> | |||
<dependency> | |||
<groupId>org.springframework.boot</groupId> | |||
<artifactId>spring-boot-starter-test</artifactId> | |||
<scope>test</scope> | |||
</dependency> | |||
</dependencies> | |||
<build> | |||
<finalName>spring-boot-demo-cache-ehcache</finalName> | |||
<plugins> | |||
<plugin> | |||
<groupId>org.springframework.boot</groupId> | |||
<artifactId>spring-boot-maven-plugin</artifactId> | |||
</plugin> | |||
</plugins> | |||
</build> | |||
</project> |
@@ -0,0 +1,27 @@ | |||
package com.xkcoding.cache.ehcache; | |||
import org.springframework.boot.SpringApplication; | |||
import org.springframework.boot.autoconfigure.SpringBootApplication; | |||
import org.springframework.cache.annotation.EnableCaching; | |||
/** | |||
* <p> | |||
* 启动类 | |||
* </p> | |||
* | |||
* @package: com.xkcoding.cache.ehcache | |||
* @description: 启动类 | |||
* @author: yangkai.shen | |||
* @date: Created in 2018/11/16 17:02 | |||
* @copyright: Copyright (c) 2018 | |||
* @version: V1.0 | |||
* @modified: yangkai.shen | |||
*/ | |||
@SpringBootApplication | |||
@EnableCaching | |||
public class SpringBootDemoCacheEhcacheApplication { | |||
public static void main(String[] args) { | |||
SpringApplication.run(SpringBootDemoCacheEhcacheApplication.class, args); | |||
} | |||
} |
@@ -0,0 +1,35 @@ | |||
package com.xkcoding.cache.ehcache.entity; | |||
import lombok.AllArgsConstructor; | |||
import lombok.Data; | |||
import lombok.NoArgsConstructor; | |||
import java.io.Serializable; | |||
/** | |||
* <p> | |||
* 用户实体 | |||
* </p> | |||
* | |||
* @package: com.xkcoding.cache.ehcache.entity | |||
* @description: 用户实体 | |||
* @author: yangkai.shen | |||
* @date: Created in 2018/11/16 16:53 | |||
* @copyright: Copyright (c) 2018 | |||
* @version: V1.0 | |||
* @modified: yangkai.shen | |||
*/ | |||
@Data | |||
@AllArgsConstructor | |||
@NoArgsConstructor | |||
public class User implements Serializable { | |||
private static final long serialVersionUID = 2892248514883451461L; | |||
/** | |||
* 主键id | |||
*/ | |||
private Long id; | |||
/** | |||
* 姓名 | |||
*/ | |||
private String name; | |||
} |
@@ -0,0 +1,41 @@ | |||
package com.xkcoding.cache.ehcache.service; | |||
import com.xkcoding.cache.ehcache.entity.User; | |||
/** | |||
* <p> | |||
* UserService | |||
* </p> | |||
* | |||
* @package: com.xkcoding.cache.ehcache.service | |||
* @description: UserService | |||
* @author: yangkai.shen | |||
* @date: Created in 2018/11/16 16:53 | |||
* @copyright: Copyright (c) 2018 | |||
* @version: V1.0 | |||
* @modified: yangkai.shen | |||
*/ | |||
public interface UserService { | |||
/** | |||
* 保存或修改用户 | |||
* | |||
* @param user 用户对象 | |||
* @return 操作结果 | |||
*/ | |||
User saveOrUpdate(User user); | |||
/** | |||
* 获取用户 | |||
* | |||
* @param id key值 | |||
* @return 返回结果 | |||
*/ | |||
User get(Long id); | |||
/** | |||
* 删除 | |||
* | |||
* @param id key值 | |||
*/ | |||
void delete(Long id); | |||
} |
@@ -0,0 +1,83 @@ | |||
package com.xkcoding.cache.ehcache.service.impl; | |||
import com.google.common.collect.Maps; | |||
import com.xkcoding.cache.ehcache.entity.User; | |||
import com.xkcoding.cache.ehcache.service.UserService; | |||
import lombok.extern.slf4j.Slf4j; | |||
import org.springframework.cache.annotation.CacheEvict; | |||
import org.springframework.cache.annotation.CachePut; | |||
import org.springframework.cache.annotation.Cacheable; | |||
import org.springframework.stereotype.Service; | |||
import java.util.Map; | |||
/** | |||
* <p> | |||
* UserService | |||
* </p> | |||
* | |||
* @package: com.xkcoding.cache.ehcache.service.impl | |||
* @description: UserService | |||
* @author: yangkai.shen | |||
* @date: Created in 2018/11/16 16:54 | |||
* @copyright: Copyright (c) 2018 | |||
* @version: V1.0 | |||
* @modified: yangkai.shen | |||
*/ | |||
@Service | |||
@Slf4j | |||
public class UserServiceImpl implements UserService { | |||
/** | |||
* 模拟数据库 | |||
*/ | |||
private static final Map<Long, User> DATABASES = Maps.newConcurrentMap(); | |||
/** | |||
* 初始化数据 | |||
*/ | |||
static { | |||
DATABASES.put(1L, new User(1L, "user1")); | |||
DATABASES.put(2L, new User(2L, "user2")); | |||
DATABASES.put(3L, new User(3L, "user3")); | |||
} | |||
/** | |||
* 保存或修改用户 | |||
* | |||
* @param user 用户对象 | |||
* @return 操作结果 | |||
*/ | |||
@CachePut(value = "user", key = "#user.id") | |||
@Override | |||
public User saveOrUpdate(User user) { | |||
DATABASES.put(user.getId(), user); | |||
log.info("保存用户【user】= {}", user); | |||
return user; | |||
} | |||
/** | |||
* 获取用户 | |||
* | |||
* @param id key值 | |||
* @return 返回结果 | |||
*/ | |||
@Cacheable(value = "user", key = "#id") | |||
@Override | |||
public User get(Long id) { | |||
// 我们假设从数据库读取 | |||
log.info("查询用户【id】= {}", id); | |||
return DATABASES.get(id); | |||
} | |||
/** | |||
* 删除 | |||
* | |||
* @param id key值 | |||
*/ | |||
@CacheEvict(value = "user", key = "#id") | |||
@Override | |||
public void delete(Long id) { | |||
DATABASES.remove(id); | |||
log.info("删除用户【id】= {}", id); | |||
} | |||
} |
@@ -0,0 +1,8 @@ | |||
spring: | |||
cache: | |||
type: ehcache | |||
ehcache: | |||
config: classpath:ehcache.xml | |||
logging: | |||
level: | |||
com.xkcoding: debug |
@@ -0,0 +1,37 @@ | |||
<!-- ehcache配置 --> | |||
<ehcache | |||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |||
xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd" | |||
updateCheck="false"> | |||
<!--缓存路径,用户目录下的base_ehcache目录--> | |||
<diskStore path="user.home/base_ehcache"/> | |||
<defaultCache | |||
maxElementsInMemory="20000" | |||
eternal="false" | |||
timeToIdleSeconds="120" | |||
timeToLiveSeconds="120" | |||
overflowToDisk="true" | |||
maxElementsOnDisk="10000000" | |||
diskPersistent="false" | |||
diskExpiryThreadIntervalSeconds="120" | |||
memoryStoreEvictionPolicy="LRU"/> | |||
<!-- | |||
缓存文件名:user,同样的可以配置多个缓存 | |||
maxElementsInMemory:内存中最多存储 | |||
eternal:外部存储 | |||
overflowToDisk:超出缓存到磁盘 | |||
diskPersistent:磁盘持久化 | |||
timeToLiveSeconds:缓存时间 | |||
diskExpiryThreadIntervalSeconds:磁盘过期时间 | |||
--> | |||
<cache name="user" | |||
maxElementsInMemory="20000" | |||
eternal="true" | |||
overflowToDisk="true" | |||
diskPersistent="false" | |||
timeToLiveSeconds="0" | |||
diskExpiryThreadIntervalSeconds="120"/> | |||
</ehcache> |
@@ -0,0 +1,16 @@ | |||
package com.xkcoding.cache.ehcache; | |||
import org.junit.Test; | |||
import org.junit.runner.RunWith; | |||
import org.springframework.boot.test.context.SpringBootTest; | |||
import org.springframework.test.context.junit4.SpringRunner; | |||
@RunWith(SpringRunner.class) | |||
@SpringBootTest | |||
public class SpringBootDemoCacheEhcacheApplicationTests { | |||
@Test | |||
public void contextLoads() { | |||
} | |||
} |
@@ -0,0 +1,65 @@ | |||
package com.xkcoding.cache.ehcache.service; | |||
import com.xkcoding.cache.ehcache.SpringBootDemoCacheEhcacheApplicationTests; | |||
import com.xkcoding.cache.ehcache.entity.User; | |||
import lombok.extern.slf4j.Slf4j; | |||
import org.junit.Test; | |||
import org.springframework.beans.factory.annotation.Autowired; | |||
/** | |||
* <p> | |||
* ehcache缓存测试 | |||
* </p> | |||
* | |||
* @package: com.xkcoding.cache.ehcache.service | |||
* @description: ehcache缓存测试 | |||
* @author: yangkai.shen | |||
* @date: Created in 2018/11/16 16:58 | |||
* @copyright: Copyright (c) 2018 | |||
* @version: V1.0 | |||
* @modified: yangkai.shen | |||
*/ | |||
@Slf4j | |||
public class UserServiceTest extends SpringBootDemoCacheEhcacheApplicationTests { | |||
@Autowired | |||
private UserService userService; | |||
/** | |||
* 获取两次,查看日志验证缓存 | |||
*/ | |||
@Test | |||
public void getTwice() { | |||
// 模拟查询id为1的用户 | |||
User user1 = userService.get(1L); | |||
log.debug("【user1】= {}", user1); | |||
// 再次查询 | |||
User user2 = userService.get(1L); | |||
log.debug("【user2】= {}", user2); | |||
// 查看日志,只打印一次日志,证明缓存生效 | |||
} | |||
/** | |||
* 先存,再查询,查看日志验证缓存 | |||
*/ | |||
@Test | |||
public void getAfterSave() { | |||
userService.saveOrUpdate(new User(4L, "user4")); | |||
User user = userService.get(4L); | |||
log.debug("【user】= {}", user); | |||
// 查看日志,只打印保存用户的日志,查询是未触发查询日志,因此缓存生效 | |||
} | |||
/** | |||
* 测试删除,查看redis是否存在缓存数据 | |||
*/ | |||
@Test | |||
public void deleteUser() { | |||
// 查询一次,使ehcache中存在缓存数据 | |||
userService.get(1L); | |||
// 删除,查看ehcache是否存在缓存数据 | |||
userService.delete(1L); | |||
} | |||
} |