SpringBoot之缓存

灰太狼 2022-05-18 03:08 173阅读 0赞

Spring从3.1开始定义了`org.springframework.cache.Cache`和`org.springframework.cache.CacheManager`接口来统一不同的缓存技术，并支持使用JCache（JSR-107）注解简化我们开发；

Cache接口为缓存的组件规范定义，包含缓存的各种操作集合；  
Cache接口下Spring提供了各种xxxCache的实现；如RedisCache，EhCacheCache , ConcurrentMapCache等；

每次调用需要缓存功能的方法时，Spring会检查指定参数的指定的目标方法是否已经被调用过；如果有就直接从缓存中获取方法调用后的结果，如果没有就调用方法并缓存结果后返回给用户。下次调用直接从缓存中获取。

使用Spring缓存抽象时我们需要关注以下两点；

1.  确定方法需要被缓存以及他们的缓存策略
2.  从缓存中读取之前缓存存储的数据

![这里写图片描述][70]

* 将方法的运行结果进行缓存，以后再要相同的数据，直接从缓存中获取，不用调用方法；
     * CacheManager管理多个Cache组件，对缓存的真正CRUD操作是在Cache组件中进行的，每一个缓存组件有自己唯一的名字
     *
     *
     * 原理：
     *   1、自动配置类；CacheAutoConfiguration
     *   2、缓存的配置类
     *   org.springframework.boot.autoconfigure.cache.GenericCacheConfiguration
     *   org.springframework.boot.autoconfigure.cache.JCacheCacheConfiguration
     *   org.springframework.boot.autoconfigure.cache.EhCacheCacheConfiguration
     *   org.springframework.boot.autoconfigure.cache.HazelcastCacheConfiguration
     *   org.springframework.boot.autoconfigure.cache.InfinispanCacheConfiguration
     *   org.springframework.boot.autoconfigure.cache.CouchbaseCacheConfiguration
     *   org.springframework.boot.autoconfigure.cache.RedisCacheConfiguration
     *   org.springframework.boot.autoconfigure.cache.CaffeineCacheConfiguration
     *   org.springframework.boot.autoconfigure.cache.GuavaCacheConfiguration
     *   org.springframework.boot.autoconfigure.cache.SimpleCacheConfiguration【默认】
     *   org.springframework.boot.autoconfigure.cache.NoOpCacheConfiguration
     * 
     *   3、默认生效的配置类：SimpleCacheConfiguration；
     *
     *   4、给容器中注册了一个CacheManager：ConcurrentMapCacheManager
     *   5、可以获取和创建ConcurrentMapCache类型的缓存组件；它的作用将数据保存在ConcurrentMap中
     *
     *   运行流程：
     *   @Cacheable：
     *   1、方法运行之前，先去查询Cache（缓存组件），按照cacheNames指定的名字获取；
     *      （CacheManager先获取相应的缓存），第一次获取缓存，如果没有Cache组件会自动创建。
     *   2、去Cache中查找缓存的内容，使用一个key，默认就是方法的参数；
     *      key是按照某种策略生成的；默认是使用keyGenerator生成的，默认使用SimpleKeyGenerator生成key；
     *          SimpleKeyGenerator生成key的默认策略；
     *                  如果没有参数；key=new SimpleKey()；
     *                  如果有一个参数：key=参数的值
     *                  如果有多个参数：key=new SimpleKey(params)；
     *   3、没有查到缓存，就调用目标方法；
     *   4、将目标方法返回的结果，放进缓存中
     *
     *   @Cacheable标注的方法执行之前先来检查缓存中有没有这个数据，默认按照参数的值作为key去查询缓存，
     *   如果没有，就运行方法并将结果放入缓存；以后再来调用，就可以直接使用缓存中的数据

# 几个重要概念&缓存注解 #

<table> 
 <thead> 
  <tr> 
   <th>Tables</th> 
   <th align="center">Are</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>CacheManager</td> 
   <td align="center">缓存管理器，管理各种缓存（Cache）组件</td> 
  </tr> 
  <tr> 
   <td>Cache</td> 
   <td align="center">缓存接口，定义缓存操作。实现有：RedisCache、EhCacheCache、ConcurrentMapCache等</td> 
  </tr> 
  <tr> 
   <td>@EnableCaching</td> 
   <td align="center">开启基于注解的缓存</td> 
  </tr> 
  <tr> 
   <td>@Cacheable</td> 
   <td align="center">主要针对方法配置，能够根据方法的请求参数对其结果进行缓存</td> 
  </tr> 
  <tr> 
   <td>@CacheEvict</td> 
   <td align="center">清空缓存</td> 
  </tr> 
  <tr> 
   <td>@CachePut</td> 
   <td align="center">保证方法被调用，又希望结果被缓存</td> 
  </tr> 
  <tr> 
   <td>keyGenerator</td> 
   <td align="center">缓存数据时key生成策略</td> 
  </tr> 
  <tr> 
   <td>serialize</td> 
   <td align="center">缓存数据时value序列化策略</td> 
  </tr> 
 </tbody> 
</table>

# 重要注解 #

## @EnableCaching ##

标注在启动类上，开启缓存注解

## @Cacheable ##

*   @Cacheable标注的方法执行之前先来检查缓存中有没有这个数据，默认按照参数的值作为key去查询缓存，
     *   如果没有就运行方法并将结果放入缓存；以后再来调用就可以直接使用缓存中的数据；
     *
     *   核心：
     *      1）、使用CacheManager【ConcurrentMapCacheManager】按照名字得到Cache【ConcurrentMapCache】组件
     *      2）、key使用keyGenerator生成的，默认是SimpleKeyGenerator
     *
     *   几个属性：
     *      cacheNames/value：指定缓存组件的名字，将方法的返回结果放在哪个缓存中，是数组的方式，可以指定多个缓存；
     *
     *      key：缓存数据使用的key，可以用它来指定。默认是使用方法参数的值  1-方法的返回值
     *              编写SpEL :  #id ：参数id的值  ===》 #a0  #p0  #root.args[0]
     *              getEmp[2] == #root.methodName+'['+#id+']'
     *
     *      keyGenerator：key的生成器；可以自己指定key的生成器的组件id，比如keyGenerator="myKeyGenerator"
     *              key/keyGenerator：二选一使用;
     *
     *      cacheManager：指定缓存管理器；或者cacheResolver指定获取解析器
     *
     *      condition：指定符合条件的情况下才缓存；
     *              condition = "#id>0"
     *              condition = "#a0>1"：第一个参数的值>1的时候才进行缓存
     *
     *      unless:否定缓存；当unless指定的条件为true，方法的返回值就不会被缓存；可以获取到结果进行判断
     *              unless = "#result == null"，当查询结果为空时，不进行缓存
     *              unless = "#a0==2"，如果第一个参数的值是2，结果不缓存
     * 
     *      sync：是否使用异步模式

## @CachePut ##

* @CachePut：既调用方法，又更新缓存数据，即同步更新缓存
     * 修改了数据库的某个数据，同时更新缓存；
     * 
     * 运行时机：
     *  1、先调用目标方法
     *  2、将目标方法的结果缓存起来
     *
     * 测试步骤：
     *  1、查询1号员工，查到的结果会放在缓存中；
     *          key：1  value：lastName：张三
     *  2、以后查询还是之前的结果
     *  3、更新1号员工；【lastName:zhangsan，gender:0】
     *          将方法的返回值也放进缓存了；
     *          key：传入的employee对象  值：返回的employee对象；
     *  4、查询1号员工？
     *      应该是更新后的员工；
     *          key = "#employee.id":使用传入的参数的员工id；
     *          key = "#result.id"：使用返回后的id
     *          注意：@Cacheable的key是不能用#result，因为其key在调用方法之前就生成了
     * 
     *      为什么是没更新之前的缓存？【1号员工没有在缓存中更新】
     *      需要注意：放入缓存的key需要一致，才能更新

## @CacheEvict ##

* @CacheEvict：缓存清除
     * 
     *  key：指定要清除的数据
     * 
     *  allEntries：指定是否清除这个缓存中所有的数据，默认为false
     * 
     *  beforeInvocation：缓存的清除是否在方法执行之前执行
     *      默认为false：代表缓存清除操作是在方法执行之后执行；如果出现异常，缓存就不会清除
     *
     *  beforeInvocation = true：
     *      代表清除缓存操作是在方法运行之前执行，无论方法是否出现异常，缓存都清除

## @Caching ##

用于组合前面三个注解，实现复杂的缓存机制。

源码：

@Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Inherited @Documented public @interface Caching { 
        Cacheable[] cacheable() default {};
    
        CachePut[] put() default {};
    
        CacheEvict[] evict() default {};
    }

用法：

@Caching(
             cacheable = {
                 @Cacheable(...)
             },
             put = {
                 @CachePut(...),
                 @CachePut(...)
             },
             evict = {
                 @CacheEvict(...)
             }
    )

## @CacheConfig ##

标注于类上，统一指定该类下所有方法的共同属性

源码：

@Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface CacheConfig { 
        String[] cacheNames() default {};
    
        String keyGenerator() default "";
    
        String cacheManager() default "";
    
        String cacheResolver() default "";
    }

--------------------

# 自定义主键生成策略 #

@Configuration
    public class MyCacheConfig {
    
        @Bean("myKeyGenerator")
        public KeyGenerator keyGenerator(){
            return new KeyGenerator(){
                @Override
                public Object generate(Object target, Method method, Object... params) {
                    return method.getName()+"["+ Arrays.asList(params).toString()+"]";
                }
            };
        }
    }

[70]: /images/20220518/54698915080c4b5086923b64a1d1b083.png