本文主要是日常开发过程当中遇到的一个实际问题,以及问题排查的过程,通过本文你将了解:
-
springcache 注解中 condition 的作用原理
-
condition 以及 unless 条件判断的区别
背景
有一个用户权限查询接口,查询用户在某个应用的权限,关键的两个入参信息为
appCode
(应用编码)account
(用户账号)
其中在代码逻辑里面需要将用户账号 account 转为用户统一身份id 即 uid 进行内部逻辑处理,由于 account 与 uid 得关系在外部系统存储,因此这里需要缓存 account 与 uid 得关系。缓存时长为2天,如下代码所示:
以上的逻辑预期是缓存 account 与 uid 得关系,无论 uid 是否存在, 不存在的话缓存 null 值(可通过 CacheManager 统一配置)。
但是后续有这样的需求,如果 uid 为 null 得时候不缓存,因此按照 springcache 提供的 condition 条件,按条件缓存。
问题现象
预期的是查询外部系统有数据结果才会缓存account 与 uid得关系,uid结果为 null 得时候并不缓存。但是实际情况是uid有没有结果都不会缓存数据,不符合预期。
排查过程
思考点:
- 是不是对 condition 的条件缓存理解得有问题
代码分析
重点关注核心类 CacheInterceptor
拦截器里面对 @Cacheable 注解的解析
CacheInterceptor.invoke() ->CacheAspectSupport.execute() -> private execute()
从上面可知对 @Cacheable 注解的解析在第 2、3 和第 4 步,其中 condition 条件判断再第 2 以及 4 步。
其中第 2 步的findCachedItem
方法中的 conditon 用于判断是否从缓存中查询数据。
第 4 步中的collectPutRequest
方法中的 condition 用于判断是否要写入缓存,具体实现如下:
通过代码 debug ,发现步骤 2 以及步骤 4 中的 isConditionPassing 的返回值都是 false,因此当我们的配置 condition = "#result !==null' 的结果就是所有的数据都实时查询,查询结果也不会保存至缓存。
查阅资料
通过 spring 的docs.spring.io/spring-fram... 关于 springcache 的文档可知,conditon、unless条件是使用 SpEL 表达式实现的。
对于 condition 条件,只对入参进行判断,其中入参能使用的只有 #root 和参数,符合条件的查询入参可以
- 查询走缓存
- 缓存没有命中的时候,将实时查询的结果写入缓存
对于 unless 条件,只对出参进行判断,其中出参可以使用 #result 不符合条件的出参可以
- 缓存没有命中的时候,将实时查询的结果写入缓存
因此,只要将 condition = "#result !==null' 这个条件改为 unless = "#result == null" 就能满足我们的预期:查询走缓存,如果返回结果为 null 则不写入缓存,否则将结果写入缓存。
总结
- 在
@Cacheable
注解中,conditon 只对入参进行判断,符合条件的查询先走缓存,缓存没有命中的时候,将实时查询结果写入缓存,否则查询不走缓存并且结果不写入缓存 - 在
@Cacheable
注解中,unless 只对出参进行判断,符合条件的不缓存,不符合条件的将结果写入缓存。
该问题的发生是因为自己对 spring cache 相关注解的原理没有深入了解,同时网上有一些错误的例子导致的,因此还是要多看看官方文档以及阅读源码。