spring提供的缓存注解

springboot提供了几个重要的缓存注解，@EnableCaching、@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig。下面做一一介绍并结合自己的代码记录。

背景

自Spring3.1开始，Spring就自带了对缓存的支持。我们可以直接使用Spring缓存技术将某些数据放入本机的缓存中；Spring缓存技术也可以搭配其他缓存中间件(如Redis等)进行使用，将某些数据写入到缓存中间件(缓存中间件可能在其他机器上)中。

所以需要确认Spring版本不低于3.1。

我使用的springboot版本为2.4.0，对应spring版本为5.3.2。

@EnableCaching注解

开关性注解，在项目启动类或某个配置类上使用此注解后，则表示允许使用注解的方式进行缓存操作。

@Cacheable注解

可用于类或方法上，在目标方法执行前，会根据key先去缓存中查询看是否有数据，有就直接返回缓存中的key对应的value值。不再执行目标方法；无则执行目标方法，并将方法的返回值作为value，并以键值对的形式存入缓存，几个重要属性（condition、unless等）可以查看上一篇笔记。
【springboot2.4.0缓存的工作原理与@Cacheable运行流程-笔记】

/** * 将方法的运行结果进行缓存，以后再要相同的数据，直接从缓存中获取，不用调用方法。 * * CacheManager管理多个Cache组件的，对缓存的真正CRUD操作在缓存组件中，每一个缓存组件有自己唯一一个名字 * @Cacheable 几个属性 * cacheNames/value : 指定缓存组件的名字，将方法的返回结果放在哪个缓存中，是数组的方式，可以指定多个缓存。 * key : 缓存数据使用的key，可以用它来指定，默认是使用方法参数的值 1 : 方法的返回值 * 编写SpEl， #id参数id的值 #a0 #p0 #root.args[0] * 如果想指定成字符串 --> getEmp[2] * keyGenerrator : key的生成器，也可以自己指定key的生成器的组件id * key / keyGenerrator 二选一使用 * cacheManager : 指定缓存管理器， 或者cacheResolver : 指定缓存解析器 二选一使用 * condition : 指定符合条件的情况下才缓存 * condition = "#id > 0" 如果传入参数 > 0 ，则缓存 * unless : 否定缓存，当unless指定的条件为true，方法的返回值就不会被缓存；可以获取到结果进行判断 * unless = "#result == null" 如果查询结果为空，则不缓存 * sync : 是否使用异步模式 * * 原理 : * 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.SimpleCacheConfiguration * org.springframework.boot.autoconfigure.cache.NoOpCacheConfiguration * 3.哪个配置类默认生效 SimpleCacheConfiguration * 4.给容器中注册了一个CacheManager : ConcurrentMapCacheManager * 5.getCache 双重判断 可以获取和创建ConcurrentMapCache类型的缓存组件；它的作用是将数据保存在ConcurrentMap中。 * * 运行流程 : * @Cacheable * 1.方法运行之前，先去查询Cache(缓存组件)，按照cacheNames指定的名字获取。 --> 先来到getCache获取缓存 传入参数 name = "emp" * (CacheManager先获取相应的缓存) * 第一次拿到的缓存为Cache : null name : emp * 没有的话会自动调用createConcurrentMapCache创建一个缓存。 * * 2.去Cache中查找缓存的内容，使用一个key，默认就是方法的参数 * key是按照某种策略生成的 默认是调用context.generateKey 中的ConcurrentMap的实现SimpleKeyGenerator生成key * SimpleKeyGenerator生成key的默认策略 * 如果没有参数，key = new SimpleKey()； * 如果有一个参数，key = 参数的值 * 如果有多个参数，key = new SimpleKey(params); * * 3.没有查到缓存就调用目标方法 * * 4.将目标方法返回的结果，放进缓存中 * ConcurrentMapCache中的put方法 通过store(ConcurrentMap).put(key,value) * * @Cacheable 标注的方法执行之前先来检查缓存中有没有这个数据，默认按照参数的值作为key去查询缓存， * 如果没有就运行方法，并将结果存入缓存，以后再来调用就可以直接使用缓存中的数据。 * * 核心 : * 1.使用CacheManager【ConcurrentMapCacheManager】按照名字得到Cache【ConcurrentMapCache】组件 * 2.key是使用KeyGenerator生成的，默认是SimpleKeyGenerator * * * @param id * @return */
    @Cacheable(cacheNames = "emp")
    @Override
    public Employee getEmp(Integer id) {
   
        System.out.println("查询" + id + "号员工");
        Employee emp = employeeMapper.getEmpById(id);
        return emp;
    }

@CachePut注解

可用于类或方法上，在执行完目标方法后，并将方法的返回值作为value，并以键值对的形式存入缓存中。
简单来说，就是
说法① 既调用方法，又更新缓存数据。
说法② 修改了数据库某个数据，同时更新缓存。

对比 @Cacheable 和 @CachePut 的运行时机 :
@Cacheable 是在调用方法之前，查询缓存，如果有则直接返回缓存的数据，如果没有则运行方法之后，将返回结果缓存。
而 @CachePut 是直接先调用方法，调用完方法再把方法的结果放入缓存中。

几个注意点:

@Cacheable 的key是不能用 #result 因为它在查询缓存之后。
保存的时候要注意指定一下key，在@Cacheable如果默认使用传参id作为key，那么在@CacheOut中可以通过 #result.id 来设置key。

	/** * 测试步骤: * 1.查询1号员工，查到的结果会放在缓存中。 * key = 1，value = 之前的数据 * 2.以后查询还是之前的结果 * 3.更新1号员工【id=1, lastName=xiaopangzi, email=null, gender=1, dId=1】 * 将方法的返回值也放进缓存了 * key = 传入的Employee对象 value = 返回的Employee对象 * 4.查询1号员工 * 应该是更新后的员工 * key = "#employee.id" --> 使用传入的参数的员工id * key = "#result.id" --> 使用返回值的id * @Cacheable 的key是不能用#result 因为它在查询缓存之后 * 为什么是没更新前的? 【1号员工没有在缓存中更新，key不一样】 */
	@CachePut(value = "emp", key = "#result.id")
    public Employee updateEmp(Employee employee) {
   
        System.out.println("updateEmp:" + employee);
        employeeMapper.updateEmp(employee);
        return employee;
    }

@CacheEvict注解

可用于类或方法上；在执行完目标方法后，清除缓存中对应key的数据(如果缓存中有对应key的数据缓存的话)。

几个属性设置 :

用 key 来指定要清除的数据。
allEntries = true 将缓存的所有数据都删除。
beforeInvocation = false 默认为false 是否在方法之前执行默认是在方法执行之后执行的，如果方法在执行时出现异常，缓存就不会被清除。beforeInvocation = true时，代表不管方法执行成功或失败，都会清除缓存。

	/** * @CacheEvict : 缓存清除 * key 指定要清除的数据 * allEntries = true 将缓存的所有数据都删除 * beforeInvocation = false 默认为false 是否在方法之前执行 默认是在方法执行之后执行的 * 如果方法在执行时出现异常，缓存就不会被清除 * * beforeInvocation = true时，代表不管方法执行成功或失败，都会清除缓存 */
	@CacheEvict(value = "emp", key = "#id")
    public void deleteEmp(Integer id) {
   
        System.out.println("删除" + id + "号员工");
        employeeMapper.deleteEmp(id);
    }

@Caching注解

此注解即可作为@Cacheable、@CacheEvict、@CachePut三种注解中的的任何一种或几种来使用。一般用于定义复杂的缓存规则。

	@Caching(
            cacheable = {
   
                    @Cacheable(value = "emp", key = "#lastName")
            },
            put = {
   
                    @CachePut(value = "emp", key = "#result.id"),
                    @CachePut(value = "emp", key = "#result.email")
            }
    )
    public Employee getEmpByLastName(String lastName) {
   
        Employee employee = employeeMapper.getEmpByLastName(lastName);
        return employee;
    }

@CacheConfig注解

@Cacheable、@CacheEvict、@CachePut这三个注解的cacheNames属性是必填项(或value属性是必填项,因为value属性是cacheNames的别名属性)；如果上述三种注解都用的是同一个cacheNames的话，那么在每此都写cacheNames的话，就会显得麻烦。如将@CacheConfig注解就是来配置一些公共属性(如：cacheNames、keyGenerator等)的值的。

简单来说，就是抽取缓存的公共配置。

加在类头。

	@CacheConfig(cacheNames = "emp")
	@Service
	@Transactional
	public class EmployeeServiceImpl implements EmployeeService {
   
		...
	}

结语

如有不正之处，欢迎指正，互相学习，多加借鉴。

٩꒰▽ ꒱۶⁼³₌₃ 学习去咯
…φ(๑˃∀˂๑)♪ 学习是我的全部
(っ•̀ω•́)っ✎⁾⁾ 我爱学习
:ஐ٩(๑´ᵕ`)۶ஐ: 学习使我进步
*✧⁺˚⁺ପ(๑･ω･)੭ु⁾⁾ 好好学习天天向上

springboot 2.4.0中的缓存注解

文章目录