一次排查@CacheEvict注解失效的经历及解决

第一次排查@CacheEvict注解失效的经历及解决publicObjectinvoke(finalMethodInvocationinvocation)throwsThrowable{

Methodmethod=invocation.getMethod();

CacheOperationInvokeraopAllianceInvoker=()-{

try{

returnceed();

catch(Throwableex){

thrownewCacheOperationInvoker.ThrowableWrapper(ex);

try{

returnexecute(aopAllianceInvoker,invocation.getThis(),method,invocation.getArguments());

catch(CacheOperationInvoker.ThrowableWrapperth){

throwth.getOriginal();

进入execute方法

protectedObjectexecute(CacheOperationInvokerinvoker,Objecttarget,Methodmethod,Object[]args){

//Checkwhetheraspectisenabled(tocopewithcaseswheretheAJispulledinautomatically)

if(this.initialized){

ClasstargetClass=getTargetClass(target);

CacheOperationSourcecacheOperationSource=getCacheOperationSource();

if(cacheOperationSource!=null){

CollectionCacheOperationoperations=cacheOperationSource.getCacheOperations(method,targetClass);

if(!CollectionUtils.isEmpty(operations)){

returnexecute(invoker,method,

newCacheOperationContexts(operations,method,args,target,targetClass));

returninvoker.invoke();

cacheOperationSource记录系统中所有使用了缓存的方法，cacheOperationSource.getCacheOperations(method,targetClass)能获取deleteByTaskId()方法缓存元数据，然后执行execute()方法

@Nullable

privateObjectexecute(finalCacheOperationInvokerinvoker,Methodmethod,CacheOperationContextscontexts){

//Specialhandlingofsynchronizedinvocation

if(contexts.isSynchronized()){

CacheOperationContextcontext=contexts.get(CacheableOperation.class).iterator().next();

if(isConditionPassing(context,CacheOperationExpressionEvaluator.NO_RESULT)){

Objectkey=generateKey(context,CacheOperationExpressionEvaluator.NO_RESULT);

Cachecache=context.getCaches().iterator().next();

try{

returnwrapCacheValue(method,cache.get(key,()-unwrapReturnValue(invokeOperation(invoker))));

catch(Cache.ValueRetrievalExceptionex){

//TheinvokerwrapsanyThrowableinaThrowableWrapperinstancesowe

//canjustmakesurethatonebubblesupthestack.

throw(CacheOperationInvoker.ThrowableWrapper)ex.getCause();

else{

//Nocachingrequired,onlycalltheunderlyingmethod

returninvokeOperation(invoker);

//Processanyearlyevictions

processCacheEvicts(contexts.get(CacheEvictOperation.class),true,

CacheOperationExpressionEvaluator.NO_RESULT);

//Checkifwehaveacacheditemmatchingtheconditions

Cache.ValueWrappercacheHit=findCachedItem(contexts.get(CacheableOperation.class));

//Collectputsfromany@Cacheablemiss,ifnocacheditemisfound

ListCachePutRequestcachePutRequests=newLinkedList();

if(cacheHit==null){

collectPutRequests(contexts.get(CacheableOperation.class),

CacheOperationExpressionEvaluator.NO_RESULT,cachePutRequests);

ObjectcacheValue;

ObjectreturnValue;

if(cacheHit!=nullcachePutRequests.isEmpty()!hasCachePut(contexts)){

//Iftherearenoputrequests,justusethecachehit

cacheValue=cacheHit.get();

returnValue=wrapCacheValue(method,cacheValue);

else{

//Invokethemethodifwedon'thaveacachehit

returnValue=invokeOperation(invoker);

cacheValue=unwrapReturnValue(returnValue);

//Collectanyexplicit@CachePuts

collectPutRequests(contexts.get(CachePutOperation.class),cacheValue,cachePutRequests);

//Processanycollectedputrequests,eitherfrom@CachePutora@Cacheablemiss

for(CachePutRequestcachePutRequest:cachePutRequests){

cachePutRequest.apply(cacheValue);

//Processanylateevictions

processCacheEvicts(contexts.get(CacheEvictOperation.class),false,cacheValue);

returnreturnValue;

这里大致过程是：

先执行beforInvokeEvict----执行数据库delete操作---执行CachePut操作----执行afterInvokeEvict

我们的注解是方法调用后再使缓存失效，直接所以有效的操作应在倒数第2行

privatevoidperformCacheEvict(

CacheOperationContextcontext,CacheEvictOperationoperation,@NullableObjectresult){

Objectkey=null;

for(Cachecache:context.getCaches()){

if(operation.isCacheWide()){

logInvalidating(context,operation,null);

doClear(cache);

else{

if(key==null){

key=generateKey(context,result);

logInvalidating(context,operation,key);

doEvict(cache,key);

这里通过context.getCaches()获取到name为taskParamsCache的缓存

然后generateKey生成key，注意这里，发现生成的key是com.xxx.xxx.atomic.impl.xxxxdeleteByTaskId982，但是缓存中的key却是com.xxx.xxx.atomic.impl.xxxxselectByTaskId982，下面调用的doEvict(cache,key)方法不再跟进了，就是从cache中移除key对应值。明显这里key对应不上的，这也是导致@CacheEvict没有生效的原因。

小结一下

我还是太大意了，当时看了注解@CacheEvict的对key的注释：

大意就是如果没有指定key，那就会使用方法所有参数生成一个key，明显com.xxx.xxx.atomic.impl.xxxxselectByTaskId982是方法名+参数，可是你没说把方法名还加上了啊，说好的只用参数呢，哈哈，这个bug是我使用不当引出的，很多人不会犯这种低级错误。

解决办法就是使用SpEL明确定义key

@Cacheable(value="taskParamsCache",key="#taskId")

ListTaskParamsselectByTaskId(LongtaskId);

//...

//...

@CacheEvict(value="taskParamsCache",key="#taskId")

intdeleteByTaskId(LongtaskId);

说说spring全家桶中@CacheEvict无效情况

@CacheEvict(value=“test”,allEntries=true）

1、使用@CacheEvict注解的方法必须是controller层直接调用，service里间接调用不生效。

2、原因是因为key值跟你查询方法的key值不统一，所以导致缓存并没有清除

3、把@CacheEvict的方法和@Cache的方法放到一个java文件中写，他俩在两个java文件的话，会导致@CacheEvict失效。

4、返回值必须设置为void

@CacheEvictannotation

Itisimportanttonotethatvoidmethodscanbeusedwith@CacheEvict

5、@CacheEvict必须作用在走代理的方法上

在使用Spring@CacheEvict注解的时候，要注意，如