Spring Cache 注解详解

Myth丶恋晨 2022-02-18 12:29 295阅读 0赞

**@CacheConfig**：在类上面统一定义缓存的名字，方法上面就不用标注了*，*表示该类所有的方法都是支持缓存的，我们一般不使用该注解，直接通过@Cacheable自己配置缓存集的名字来定义。

**@Cacheable**：配置了getOne函数的返回值将被加入缓存。同时在查询时，会先从缓存中获取，若不存在才再发起对数据库的访问。该注解主要有下面几个参数：

@Cacheable(value = "user", key = "#id", unless = "#result == null")
    public UserEntity getOne(Integer id) {
        return userMapper.getOne(id);
    }

**缓存的同步 sync：** 在多线程环境下，某些操作可能使用相同参数同步调用。默认情况下，缓存不锁定任何资源，可能导致多次计算，而违反了缓存的目的。对于这些特定的情况，属性 sync 可以指示底层将缓存锁住，使只有一个线程可以进入计算，而其他线程堵塞，直到返回结果更新到缓存中。

**value、cacheNames：**两个等同的参数（cacheNames为Spring 4新增，作为value的别名），用于指定缓存存储的集合名。由于Spring 4中新增了@CacheConfig，因此在Spring 3中原本必须有的value属性，也成为非必需项了

**key：**缓存对象存储在Map集合中的key值，非必需，缺省按照函数的所有参数组合作为key值，若自己配置需使用SpEL表达式，比如：@Cacheable(key = "\#id")：使用id作为缓存的key值，更多关于SpEL表达式的详细内容可参考官方文档

**condition：**缓存对象的条件，非必需，也需使用SpEL表达式，只有满足表达式条件的内容才会被缓存，比如：@Cacheable(key = "\#id", condition = "\#id > 10")，表示只有当id大于10的时候才会被缓存。

**unless：**另外一个缓存条件参数，非必需，需使用SpEL表达式。它不同于condition参数的地方在于它的判断时机，该条件是在函数被调用之后才做判断的，所以它可以通过对result进行判断。

**keyGenerator：**用于指定key生成器，非必需。若需要指定一个自定义的key生成器，我们需要去实现org.springframework.cache.interceptor.KeyGenerator接口，并使用该参数来指定。需要注意的是：该参数与key是互斥的

**cacheManager：**用于指定使用哪个缓存管理器，非必需。只有当有多个时才需要使用

**cacheResolver：**用于指定使用那个缓存解析器，非必需。需通过org.springframework.cache.interceptor.CacheResolver接口来实现自己的缓存解析器，并用该参数指定。

**除了这里用到的两个注解之外，还有下面几个核心注解：**

**@CachePut：**配置于函数上，能够根据参数定义条件来进行缓存，它与@Cacheable不同的是，它每次都会真是调用函数，所以主要用于数据新增和修改操作上。它的参数与@Cacheable类似，具体功能可参考上面对@Cacheable参数的解析

@CachePut(value = "user", key = "#entity.id")
    public UserEntity insert(UserEntity entity) {
        userMapper.insert(entity);
        return entity;
    }
    
    @CachePut(value = "user", key = "#entity.id") 
    public UserEntity update(UserEntity entity) {
        userMapper.update(entity);
        return entity;
    }

**@CacheEvict：**配置于函数上，通常用在删除方法上，用来从缓存中移除相应数据。除了同@Cacheable一样的参数之外，它还有下面两个参数：

**allEntries：**非必需，默认为false。当为true时，会移除所有数据

@CacheEvict(value = "user", key = "#id")//清除指定id的缓存
    // @CacheEvict(value="user", allEntries=true)//allEntries为true时，将忽略指定的key，清除全部user缓存
    public void delete(Integer id) {
        userMapper.delete(id);
    }

**beforeInvocation：**非必需，默认为false，会在调用方法之后移除数据。当为true时，会在调用方法之前移除数据。