小鱿鱼 2020-02-12
本文讲解Spring Boot与EhCache的整合。
EhCache 是一个纯Java的进程内缓存框架,具有快速、精干等特点,是Hibernate中默认CacheProvider。Ehcache是一种广泛使用的开源Java分布式缓存。主要面向通用缓存,Java EE和轻量级容器。它具有内存和磁盘存储,缓存加载器,缓存扩展,缓存异常处理程序,一个gzip缓存servlet过滤器,支持REST和SOAP api等特点。
<?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> <groupId>com.yiidian</groupId> <artifactId>ch03_10_springboot_ehcache</artifactId> <version>1.0-SNAPSHOT</version> <!-- 导入springboot父工程. 注意:任何的SpringBoot工程都必须有的!!! --> <!-- 父工程的作用:锁定起步的依赖的版本号,并没有真正到依赖 --> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.11.RELEASE</version> </parent> <dependencies> <!--web起步依赖--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--springboot 集成 junit 起步依赖--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <version>2.1.6.RELEASE</version> <scope>test</scope> </dependency> <!-- 缓存坐标 --> <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-cache --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-cache</artifactId> <version>2.1.11.RELEASE</version> </dependency> <!-- Ehcache支持 --> <dependency> <groupId>net.sf.ehcache</groupId> <artifactId>ehcache</artifactId> <version>2.10.6</version> </dependency> </dependencies> </project>
在resources目录下建立ehcache.xml
,内容如下:
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../config/ehcache.xsd"> <diskStore path="java.io.tmpdir"/> <!-- defaultCache: 默认配置 --> <defaultCache maxElementsInMemory="10000" eternal="false" timeToIdleSeconds="120" timeToLiveSeconds="120" maxElementsOnDisk="10000000" diskExpiryThreadIntervalSeconds="120" memoryStoreEvictionPolicy="LRU"> <persistence strategy="localTempSwap"/> </defaultCache> <!-- 缓存名称为customer的配置 --> <cache name="customer" maxElementsInMemory="10000" eternal="false" timeToIdleSeconds="120" timeToLiveSeconds="120" maxElementsOnDisk="10000000" diskExpiryThreadIntervalSeconds="120" memoryStoreEvictionPolicy="LRU"> <persistence strategy="localTempSwap"/> </cache> </ehcache>
参数说明:
#配置EhCache的配置 spring: cache: ehcache: config: ehcache.xml # 读取ehcache.xml配置
package com.yiidian; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.boot.web.servlet.ServletListenerRegistrationBean; import org.springframework.boot.web.servlet.ServletRegistrationBean; import org.springframework.cache.annotation.EnableCaching; import org.springframework.context.annotation.Bean; /** * Spring Boot引导类 * 一点教程网 - www.yiidian.com */ @SpringBootApplication @EnableCaching // 开启缓存 public class MyBootApplication { public static void main(String[] args) { SpringApplication.run(MyBootApplication.class,args); } }
引导类中需要添加@EnableCaching注解,开启缓存功能
package com.yiidian.service; import com.yiidian.domain.Customer; import org.springframework.cache.annotation.Cacheable; import org.springframework.stereotype.Service; /** * 业务层 *一点教程网 - www.yiidian.com */ @Service public class CustomerService { @Cacheable(value = "customer",key = "#id") public Customer findById(Integer id){ System.out.println("执行了UserService获取User"); Customer customer = new Customer(); customer.setId(1); customer.setName("小明"); customer.setGender("男"); customer.setTelephone("13244445555"); return customer; } }
@Cacheable的属性:
package com.yiidian.test; import com.yiidian.MyBootApplication; import com.yiidian.service.CustomerService; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * SpringBoot整合EhCache * 一点教程网 - www.yiidian.com */ @RunWith(SpringJUnit4ClassRunner.class) @SpringBootTest(classes = MyBootApplication.class) public class EhCacheDemo { @Autowired private CustomerService customerService; @Test public void test1(){ //查询第一次 System.out.println(customerService.findById(1)); //查询第二次 System.out.println(customerService.findById(1)); } }
从结果可以看出,第一次调用Service的时候,到Service内部获取数据。但是第二次调用Service时已经不需要从Service获取数据,证明第一次查询的时候已经把Customer对象缓存到EhCache中。
@Cacheable/@CachePut/@CacheEvict 主要的参数:
@Cacheable注解会先查询是否已经有缓存,有会使用缓存,没有则会执行方法并缓存。
@Cacheable(value = "customer" ,key = "targetClass + methodName +#p0") public List<Customer> queryAll(Customer cust) { return customerDao.findAllByUid(cust); }
当我们需要缓存的地方越来越多,你可以使用@CacheConfig(cacheNames = {"myCache"})注解来统一指定value的值,这时可省略value,如果你在你的方法依旧写上了value,那么依然以方法的value值为准。
使用方法如下:
@CacheConfig(cacheNames = {"myCache"}) public class UserServiceImpl implements UserService { @Override @Cacheable(key = "targetClass + methodName +#p0")//此处没写value public List<BotRelation> findUsers(int num) { return userDao.findUsers(num); } ..... }
@CachePut注解的作用 主要针对方法配置,能够根据方法的请求参数对其结果进行缓存,和 @Cacheable 不同的是,它每次都会触发真实方法的调用 。简单来说就是用户更新缓存数据。但需要注意的是该注解的value 和 key 必须与要更新的缓存相同,也就是与@Cacheable 相同。示例:
@CachePut(value = "customer", key = "targetClass + #p0") public Customer updata(Customer cust) { Customer customer = customerDao.findAllById(cust.getId()); customer.updata(cust); return customer ; } @Cacheable(value = "customer", key = "targetClass +#p0")//清空缓存 public Customer save(Customer cust) { customerDao.save(cust); return cust; }
@CachEvict 的作用 主要针对方法配置,能够根据一定的条件对缓存进行清空 。
@Cacheable(value = "customer",key = "#p0.id") public Customer save(Customer cust) { customerDao.save(cust); return job; } //清除一条缓存,key为要清空的数据 @CacheEvict(value="customer",key="#id") public void delect(int id) { customerDao.deleteAllById(id); } //方法调用后清空所有缓存 @CacheEvict(value="customerCache",allEntries=true) public void delectAll() { customerDao.deleteAll(); } //方法调用前清空所有缓存 @CacheEvict(value="customerCache",beforeInvocation=true) public void delectAll() { customerDao.deleteAll(); }
欢迎关注我的公众号::一点教程。获得独家整理的学习资源和日常干货推送。
如果您对我的系列教程感兴趣,也可以关注我的网站:yiidian.com