spring boot上支持@cacheable的缓存,其中的“key” 和“cacheNames”支持spel表达式,效果如下
spel表达式的提示
关于spel表达式是什么,大家可以自助查询,这个是相关文档地址:Spel
spel表达式不仅支持调用方法,还支持调用对象里面的参数,这个正是我的需求,平时传给annotation的参数都是固定的,但是通过Spel表达式我们可以传一个变量值,甚至是执行一个方法。
下面我尝试在aop里面注入Spel表达式的实现:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test{
public String id() default"";
public String text() default"";
}
使用方法:
@Test(id="#id",text="#userService.test()")
public void test(UserBase userBase, int id){
}
通过这样的注解我是可以正常调用到userService的test方法的,这里有个值得注意的地方,test方法一定要是public的,可是#id,却一直报着null的错误,或者是类似于这样的错误
EL1008E:(pos 0): Property or field 'id' cannot be found on object of type 'java.lang.Integer' - maybe not public?
我一度怀疑是context没有把这个id这个常量给注进去,又或者我的contex获取有误
带着这样的疑惑,一开始我找到了一个@ConditionalOnExpression的注解,它允许在Spring的EL表达式中写一个调节,在IDEA里同样是有代码提示的
@ConditionalOnExpression注解
但是很可惜,继续源着@ConditionalOnExpression这个注解查下去并没有太多的发现
这个时候,我只好查@Cacheable的实现,看一下它的key值是如何拿出来的
因为通过调试没办法看出@Cacheable的是如何实现的,我只好把@Cacheable下面的所有相关代码大概过了一下
@Cacheable的相关代码
结果在CacheAspectSupport的里发现了这个
privateObjectexecute(finalCacheOperationInvoker invoker,Method method,CacheOperationContexts contexts) {
// Special handling of synchronized invocation
if(contexts.isSynchronized()) {
CacheOperationContext context = contexts.get(CacheableOperation.class).iterator().next();
if(isConditionPassing(context,CacheOperationExpressionEvaluator.NO_RESULT)) {
Object key = generateKey(context,CacheOperationExpressionEvaluator.NO_RESULT);
Cache cache = context.getCaches().iterator().next();
try{
returncache.get(key, newCallable() {
@Override
publicObjectcall()throwsException {
returninvokeOperation(invoker);
}
如上述代码里有一个Object key = generateKey(context,CacheOperationExpressionEvaluator.NO_RESULT);
然后发现了这个
protectedObjectgenerateKey(Object result) {
if(StringUtils.hasText(this.metadata.operation.getKey())) {
EvaluationContext evaluationContext = createEvaluationContext(result);
return evaluator.key(this.metadata.operation.getKey(), this.methodCacheKey,evaluationContext);
}
其中evaluationContext是用来构造context的,而evaluator.key(this.metadata.operation.getKey(), this.methodCacheKey,evaluationContext);方法是正常的从context中获取spel表达式里的值,那么我的重点就在他的context是如何获取到的,是不是和我们写的context有什么不一样的地方
后来,我在MethodBasedEvaluationContext的代码里发现这样一段
key的最终实现
目瞪口呆
。。。。。。。。。。。。。。。。。。。。。。。。。。。。。
好吧,我之前真的以为一定是Spel提供了什么神奇的方法,然后我们调用的就可以了,万万没想到居然是自己挨个遍历方法的参数把数据set进context的。。。。。。
如果我一开始就发现StandardEvaluationContext有个private final Map variables=new HashMap();我觉得我没必要走那么多弯路,粗心了。。。
好了,真相大白了,提供一下具体的代码吧
aop的实现
@Around("execution(@com.didi.km.commons.annotation.SendEvent * *(..)) && @annotation(test)")
public voidaround(ProceedingJoinPoint joinPoint,Test test)throwsThrowable {
StandardEvaluationContext standardEvaluationContext =new StandardEvaluationContext(joinPoint.getArgs());
standardEvaluationContext = setContextVariables(standardEvaluationContext,joinPoint);
String key = ExplUtils.generateKey(test.id(),standardEvaluationContext);
.........................
}
把方法的参数set到context中去
privateStandardEvaluationContextsetContextVariables(StandardEvaluationContext standardEvaluationContext,ProceedingJoinPoint joinPoint) {
Object[] args = joinPoint.getArgs();
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
Method targetMethod = methodSignature.getMethod();
String[] parametersName =parameterNameDiscoverer.getParameterNames(targetMethod);
if(args ==null|| args.length<=0) {
return standardEvaluationContext;
}
for(int i =0;i < args.length;i++) {
standardEvaluationContext.setVariable(parametersName[i],args[i]);
}
return standardEvaluationContext;
}
最后收尾工作
public class ExplUtils {
public staticStringgenerateKey(String key,StandardEvaluationContext context) {
BeanFactory beanFactory = SpringBeanUtils.getBeanFactory();
context.setBeanResolver(newBeanFactoryResolver(beanFactory));
ExpressionParser parser =newSpelExpressionParser();
Expression exp = parser.parseExpression(key);
String value = exp.getValue(context,String.class);
returnvalue;
}
}
这样就可以实现和@Cacheable一样支持Spel表达式的效果了
最后想吐槽一下,这个代码输入感觉有点难用,有些格式给我去掉了,还是我哪里姿势不对???