Spring cache 理解

待我称王封你为后i 2021-10-01 00:40 317阅读 0赞

今天在做项目的时候，有个用户的名字怎么刷新都拿不到，因为公司使用的是 微服务，而且各个服务端之间有各自的缓存 redis，因此，查了3个微服务，而且把相关的 redis key 值清空掉，依旧是没有效果，最后有个眼尖的同事发现我这边的代码里有 @Cacheable 这货存在，应该是别的同事优化接口的时候加上的，导致没有处理 Spring 缓存，既然看到了这个 API ，当然要理解一番，要不浪费这么多时间呢。

### Spring cache ###

Spring 自3.1版本引入了 ==注解缓存==，也就是我们通常说的 Spring cache，这里我们要注意下，Spring 的缓存与我们通常意义上的缓存差别很多，他不是一个具体的实现方案，而是对缓存的一种操作方法，为什么这么说呢？

*  这是Spring 自带的，并没有相关的持久性方法之类
 *  这是作为一种框架对缓存的使用，不能大规模的在项目中替换 诸如 redis 之类的缓存
 *  最后一点，也就是最重要的，Spring cache 是基于 AOP的，所以一旦项目停掉或者重启，那么我们的缓存也就没有了，更别提容灾了，所以场景适合才是最重要的。
 *  ==因为是基于 AOP，所以 在方法内部或者非 public 方法不支持==

废话说完，我们来正文

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

先看概念

**@Cacheable** 针对方法配置，根据方法的请求参数对结果缓存，也就是说白了根据 key 获取结果

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

**@CachePut** 针对方法配置，根据方法的请求参数对结果缓存，也就是说白了根据 key 获取结果,和 @Cacheable 不同的是 每次都会触发真实方法的调用

大家key发现，@CachePut 和 @Cacheable 用法是相同的，只是触发真实方法不同

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

**@CacheEvict** 针对方法配置，能对缓存清空，也就是和redis 中的 ddl 一样

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>缓存的名称，在 spring 配置文件中定义，必须指定至少一个</td> 
   <td>例如：@Cacheable(value=”usercache”) 或者 @Cacheable(value={”key1”,”key2”}</td> 
  </tr> 
  <tr> 
   <td>key</td> 
   <td>缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合</td> 
   <td>例如：@Cacheable(value=”usercache”,key=”#userName”)</td> 
  </tr> 
  <tr> 
   <td>condition</td> 
   <td>缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存</td> 
   <td>例如@Cacheable(value=”usercache”,condition=”#userName.length()&gt;2”) 缓存用户名字长度大于 2 的</td> 
  </tr> 
  <tr> 
   <td>allEntries</td> 
   <td>是否清空所有缓存内容，缺省为 false，如果指定为 true，则方法调用后将立即清空所有缓存</td> 
   <td>例如：@CachEvict(value=”usercache”,allEntries=true)</td> 
  </tr> 
  <tr> 
   <td>beforeInvocation</td> 
   <td>是否在方法执行前就清空，缺省为 false，如果指定为 true，则在方法还没有执行的时候就清空缓存，缺省情况下，如果方法执行抛出异常，则不会清空缓存</td> 
   <td>例如：@CachEvict(value=”usercache”，beforeInvocation=true)</td> 
  </tr> 
 </tbody> 
</table>

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

### 实例：（基于Spring boot） ###

@Cacheable(value = "conders", unless = "#result == null", keyGenerator = "customerKeyGenerator")
        @RequestMapping(value = "conders", method = RequestMethod.GET)
        public ResponseVO knowledge() {
           return null;
        }

上诉代码的缓存名称叫 conders，unless 是方法执行后调用，不缓存空值，customerKeyGenerator 是自定义的 key 生成器。

public class myRedisConfiguration extends CachingConfigurerSupport {
    
    
        @Bean(name = "cacheManagerString")
        @Primary
        public RedisCacheManager cacheManagerString(StringRedisTemplate stringRedisTemplate) {
            RedisCacheManager redisCacheManager = new RedisCacheManager(stringRedisTemplate);
            redisCacheManager.setUsePrefix(true);
            setCacheExpires(redisCacheManager);
            List<String> cacheNames = cacheProperties.getCacheNames();
            if (cacheNames.isEmpty()) {
                redisCacheManager.setCacheNames(cacheNames);
            }
            return redisCacheManager;
        }
        
        /**
         * 设置过期时间
        **/
        private void setCacheExpires(RedisCacheManager redisCacheManager) {
            Map<String, Long> expries = Maps.newHashMap();
            // 针对 conders 缓存设置过期时间
            expries.put("conders", 3600L);
            redisCacheManager.setExpires(expries);
            redisCacheManager.setDefaultExpiration(600);
        }
        
        /**
         * key 生成器
        **/ 
        @Bean
        public KeyGenerator ownKeyGenerator() {
            return (o, method, objects) -> {
                StringBuilder sb = new StringBuilder("key:");
                sb.append(o.getClass().getName());
                sb.append("_" + method.getName());
                for (Object obj : objects) {
                    sb.append(obj.toString());
                }
    
                return sb.toString();
            };
        }
    }

上述代码是我的一个 redis 配置类，key看出有过期时间的设定，有 缓存的key 生成器，注意==该类继承了 Spring 的 CachingConfigurerSupport==

@CacheEvict(value = "coders", allEntries = true)
        @RequestMapping(value = "coders/del", method = RequestMethod.GET)
        public void delCoders() {
    
        }

上述代码则是删除相关的 key。

最后我们总结下 ：

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Cacheable</td> 
   <td>存放缓存，相当于 add</td> 
  </tr> 
  <tr> 
   <td>@CachePut</td> 
   <td>更新缓存，相当于 update</td> 
  </tr> 
  <tr> 
   <td>@CacheEvic</td> 
   <td>删除缓存，相当于 delete</td> 
  </tr> 
 </tbody> 
</table>

转载于:https://www.cnblogs.com/haoming1100/articles/10473192.html