SpringBoot(2.1.1)集成Ehcache（七）

1.注解配置与EhCache使用

1.1 pom文件引入

<!--EhCache使用-->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

 

1.2 新建ehcache.xml 文件

<?xml version="1.0" encoding="UTF-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd"
   updateCheck="false">
   <diskStore path="java.io.tmpdir/Tmp_EhCache" />

   <!-- 默认配置 -->
   <defaultCache maxElementsInMemory="5000" eternal="false"
      timeToIdleSeconds="120" timeToLiveSeconds="120"
      memoryStoreEvictionPolicy="LRU" overflowToDisk="false" />

   <cache name="baseCache" maxElementsInMemory="10000"
      maxElementsOnDisk="100000" />

</ehcache>

 

配置信息介绍

name:缓存名称。  
maxElementsInMemory：缓存最大个数。  
eternal:对象是否永久有效，一但设置了，timeout将不起作用。  
timeToIdleSeconds：设置对象在失效前的允许闲置时间（单位：秒）。仅当eternal=false对象不是永久有效时使用，可选属性，默认值是0，也就是可闲置时间无穷大。  
timeToLiveSeconds：设置对象在失效前允许存活时间（单位：秒）。最大时间介于创建时间和失效时间之间。仅当eternal=false对象不是永久有效时使用，默认是0.，也就是对象存活时间无穷大。  
overflowToDisk：当内存中对象数量达到maxElementsInMemory时，Ehcache将会对象写到磁盘中。  
diskSpoolBufferSizeMB：这个参数设置DiskStore（磁盘缓存）的缓存区大小。默认是30MB。每个Cache都应该有自己的一个缓冲区。  
maxElementsOnDisk：硬盘最大缓存个数。  
diskPersistent：是否缓存虚拟机重启期数据 Whether the disk store persists between restarts of the Virtual Machine. The default value is false.  
diskExpiryThreadIntervalSeconds：磁盘失效线程运行时间间隔，默认是120秒。  
memoryStoreEvictionPolicy：当达到maxElementsInMemory限制时，Ehcache将会根据指定的策略去清理内存。默认策略是LRU（最近最少使用）。你可以设置为FIFO（先进先出）或是LFU（较少使用）。  
 clearOnFlush：内存数量最大时是否清除。

 

1.3 代码使用Cacheable

@CacheConfig(cacheNames = "baseCache")
public interface UsersMapper {

    @Select(" select * from users where id = #{id} ")
    //@Cacheable的value一定要指定
    @Cacheable(value = "cache1")
     Users selectUser(@Param("id") Integer id);

}

controller代码

@RestController
public class UserController {

    @Autowired
    private UsersMapper usersMapper;

    @RequestMapping("/getUser")
    public Users findUserList(@RequestParam Integer id) {
        return usersMapper.selectUser(id);
    }
}

1.4.启动类加注解

@EnableCaching // 开启缓存注解

访问：http://localhost:8080/getUser?id=1

一样的参数只访问一次数据库。

1.5 清除缓存

@Autowired
private CacheManager cacheManager;


@ResponseBody@RequestMapping("/remo")
public String remo() {   
cacheManager.getCache("baseCache").clear();  
 return "success";
}

 

2. @Cacheable详解

@Cacheable可以标记在一个方法上，也可以标记在一个类上。当标记在一个方法上时表示该方法是支持缓存的，当标记在一个类上时则表示该类所有的方法都是支持缓存的。对于一个支持缓存的方法，Spring会在其被调用后将其返回值缓存起来，以保证下次利用同样的参数来执行该方法时可以直接从缓存中获取结果，而不需要再次执行该方法。Spring在缓存方法的返回值时是以键值对进行缓存的，值就是方法的返回结果，至于键的话，Spring又支持两种策略，默认策略和自定义策略，这个稍后会进行说明。需要注意的是当一个支持缓存的方法在对象内部被调用时是不会触发缓存功能的。@Cacheable可以指定三个属性，value、key和condition。

 

2.1  value属性指定Cache名称

       value属性是必须指定的，其表示当前方法的返回值是会被缓存在哪个Cache上的，对应Cache的名称。其可以是一个Cache也可以是多个Cache，当需要指定多个Cache时其是一个数组。

 @Cacheable("cache1")//Cache是发生在cache1上的
   public User find(Integer id) {
      return null;

   }

   @Cacheable({"cache1", "cache2"})//Cache是发生在cache1和cache2上的
   public User find(Integer id) {
      return null;
   }

 

2.2  使用key属性自定义key

       key属性是用来指定Spring缓存方法的返回结果时对应的key的。该属性支持SpringEL表达式。当我们没有指定该属性时，Spring将使用默认策略生成key。我们这里先来看看自定义策略，至于默认策略会在后文单独介绍。

       自定义策略是指我们可以通过Spring的EL表达式来指定我们的key。这里的EL表达式可以使用方法参数及它们对应的属性。使用方法参数时我们可以直接使用“#参数名”或者“#p参数index”。下面是几个使用参数作为key的示例。

  @Cacheable(value="users", key="#id")
   public User find(Integer id) {
      return null;
   }

   @Cacheable(value="users", key="#p0")
   public User find(Integer id) {
      return null;
   }

   @Cacheable(value="users", key="#user.id")
   public User find(User user) {
      return null;
   }

   @Cacheable(value="users", key="#p0.id")
   public User find(User user) {
      return null;

   }

 

 除了上述使用方法参数作为key之外，Spring还为我们提供了一个root对象可以用来生成key。通过该root对象我们可以获取到以下信息。

属性名称	描述	示例
methodName	当前方法名	#root.methodName
method	当前方法	#root.method.name
target	当前被调用的对象	#root.target
targetClass	当前被调用的对象的class	#root.targetClass
args	当前方法参数组成的数组	#root.args[0]
caches	当前被调用的方法使用的Cache	#root.caches[0].name

       当我们要使用root对象的属性作为key时我们也可以将“#root”省略，因为Spring默认使用的就是root对象的属性。如：

   @Cacheable(value={"users", "xxx"}, key="caches[1].name")
   public User find(User user) {
      return null;
   }