Spring Boot 之 ehcache 快速、简单、易上手的java数据缓存工具

素颜马尾好姑娘i 2023-07-04 14:19 1阅读 0赞

## 一、Spring Boot ehcache 相关依赖 ##

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-cache</artifactId>
    </dependency>
    
    
    <dependency>
        <groupId>net.sf.ehcache</groupId>
        <artifactId>ehcache</artifactId>
    </dependency>

### application.properties ###

ehcache相关配置

#整合spring
    spring.cache.type=ehcache
    #读取ehcache.xml配置
    spring.cache.ehcache.config=classpath:ehcache.xml
    
    #打印日志com.ljj换成项目的包名
    logging.level.com.ljj=debug

### ehcache.xml ###

在资源目录下添加ehcache.xml文件

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd" updateCheck="false">
        
        <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"/>
    
        
        <cache name="userCache" maxElementsInMemory="20000" eternal="true" overflowToDisk="true" diskPersistent="false" timeToLiveSeconds="0" diskExpiryThreadIntervalSeconds="120"/>
    </ehcache>

## 二、整合spring ##

spring boot ehcache的前期准备已经结束，现在开始整合spring使用。  
重点在以下4个注解：

1.  @EnableCaching
2.  @Cacheable
3.  @CachePut
4.  @CacheEvict

### 1.@EnableCaching ###

在spring boot项目启动类或配置类上添加使用缓存注解

### 2.@Cacheable ###

一般在服务层的查询方法上使用。查询的时候会先在缓存上查询key是否存在，不存在则将结果保存到缓存。

@Cacheable(value = "userCache", key = "'userId:'+#id", condition = "#id < 10")
        public User get(Long id) { 
            log.info("查询用户的【id】 = {}", id);
            //假设从数据库读取了用户数据
            //User user = userDao.getUser(id);
            return user;
        }

@Cacheable表明所修饰的方法是可以缓存的。当第一次调用这个方法时，它的结果会被缓存下来，在缓存的有效时间内，以后访问这个方法都直接返回缓存结果，不再执行方法中的代码段。

#### @Cacheable的参数 ####

*  value：缓存位置名称，不能为空。如果使用EHCache，就是ehcache.xml中声明的cache节点的name属性值,指明将值缓存到哪个Cache中。
 *  key：缓存的key，默认为空，既表示使用方法的参数类型及参数值作为key。支持SpEL，如果要引用参数值使用井号加参数名（如：\#id）。
 *  condition：触发条件，只有满足条件的情况才会加入缓存，默认为空，既表示全部都加入缓存，支持SpEL

一般来说，我们的更新操作只需要刷新缓存中的某一个值，所以定义缓存的key值的方式就很重要。key最好是能够唯一，这样我们就可以准确的清除掉特定的缓存，而不会影响到其它缓存。例子中就使用了实体加冒号再加ID组合成key的名称（‘userId:’ + \#id ）。

tip：如果参数为对象的情况，如：User。那么我们可以通过\#user.id来获取对象的属性。

### 3.@CachePut ###

一般在保存或更新方法上使用。此注解用于更新缓存的结果。

@CachePut(value = "userCache", key = "'user:'+#user.id")
        public User saveOrUpdate(User user) { 
            //假设更新了数据库的用户数据
            //userDao.saveOrUpdate(user)
            log.info("保存或用户【user】 = {}", user);
            return user;
        }

与@Cacheable不同，@CachePut不仅会缓存方法的结果，还会执行方法的代码段。它支持的属性和用法都与@Cacheable一致。一个缓存后就不执行代码了，一个还要执行。

### 4.@CacheEvict ###

与@Cacheable功能相反，@CacheEvict表明所修饰的方法是用来删除失效或无用的缓存数据。

@CacheEvict(value = "userCache", key = "'user:'+#id")
        public void delete(Long id) { 
            //假设从数据库删除了用户数据
            //userDao.delete(id);
            log.info("删除用户的【id】 = {}", id);
        }

#### @CacheEvict参数 ####

与@Cacheable参数不同的地方有2处。

1.  condition：触发条件，只有满足条件的情况才会清除缓存，默认为空，支持SpEL
2.  allEntries：true表示清除value中的全部缓存，默认为false

### 测试 ###

@Autowired
        private UserService userService;
    
        @Test
        void saveAndGet() { 
            userService.saveOrUpdate(User.builder().id(4L).realName("user4").build());
            log.debug("获取id为4的用户：{}", userService.get(4L));
        }

因为使用了lombok工具，这里说明一下过程。userService里有上面3个注解的方法。调用saveOrUpdate(User)保存一个User实体持久化到本地，然后通过get(id)获取这个User。在调用get(id)方法的时候并没有触发方法体里的打印方法，因为调用的时候先去缓存里查询了。

## 三、 ehcache介绍 ##

[想了解ehcache的更多介绍可以查看这篇文章！][ehcache]

[ehcache]: https://www.jianshu.com/p/154c82073b07