将⽅法参数值动态绑定到注解属性上
背景
相关接⼝调⽤时需要记录⽇志,并且要保存到操作记录表,如果写在业务代码⾥⾯难免出现臃肿,⽽且侵⼊性较强,所以想到注解的⽅式,通过注解可以很清晰地记录⽇志,⽽且和真正的业务实现解耦。
问题
cacheable⽅法参数是动态的,⽐如操作⼈、操作原因等,如果直接从参数中获取,⽆法区分出参数的对应,此时需要将⽅法参数值绑定到注解属性上,可是如何绑定上去呢?
实现
我们知道在Controller层,通过@PathVariable注解可以将URI中的路径参数绑定到⽅法参数上,底层是怎么解析的,读者⾃⾏探索Spring,⽐如,常⽤的@Cacheable中的key属性,可以通过#和参数名称和具体参数进⾏绑定。如果要将⽅法参数动态绑定到注解上,那么肯定是通过切⾯的⽅式来实现,下⾯给出⽰例代码。
注解定义
@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface LogRecord {
LogTypeEnum logType();
String adminId() default "";
}
使⽤⽰例
@LogRecord(logType = LogTypeEnum.DELETE, adminId = "adminId")
@Override
public int doSomething(Long adminId) {
/
/ do something
}
参数解析器
⾃定义⼀个注解参数解析器
public class AnnotationResolver {
private static AnnotationResolver resolver;
public static AnnotationResolver newInstance() {
if (resolver == null) {
return resolver = new AnnotationResolver();
} else {
return resolver;
}
}
/**
* 解析注解上的值
*
* @param joinPoint
* @param str      需要解析的字符串
* @return
*/
public Object resolver(JoinPoint joinPoint, String str) {
if (str == null) {
return null;
}
Object value = null;
// 如果name匹配上了#,则把内容当作变量
if (str.matches("#\\D*")) {
String newStr = placeAll("#", "").replaceAll("", "");
// 复杂类型
if (ains(".")) {
try {
value = complexResolver(joinPoint, newStr);
} catch (Exception e) {
e.printStackTrace();
}
} else {
value = simpleResolver(joinPoint, newStr);
}
} else { //⾮变量
value = str;
}
return value;
}
private Object complexResolver(JoinPoint joinPoint, String str) throws Exception {
MethodSignature methodSignature = (MethodSignature) Signature();
String[] names = ParameterNames();
Object[] args = Args();
String[] strs = str.split("\\.");
for (int i = 0; i < names.length; i++) {
if (strs[0].equals(names[i])) {
Object obj = args[i];
Method dmethod = Class().getDeclaredMethod(getMethodName(strs[1]), null);
Object value = dmethod.invoke(args[i]);
return getValue(value, 1, strs);
}
}
return null;
}
private Object getValue(Object obj, int index, String[] strs) {
try {
if (obj != null && index < strs.length - 1) {
Method method = Class().getDeclaredMethod(getMethodName(strs[index + 1]), null);                obj = method.invoke(obj);
getValue(obj, index + 1, strs);
}
return obj;
} catch (Exception e) {
e.printStackTrace();
return null;
}
}
private String getMethodName(String name) {
return "get" + placeFirst(name.substring(0, 1), name.substring(0, 1).toUpperCase());
}
private Object simpleResolver(JoinPoint joinPoint, String str) {
MethodSignature methodSignature = (MethodSignature) Signature();
String[] names = ParameterNames();
Object[] args = Args();
for (int i = 0; i < names.length; i++) {
if (str.equals(names[i])) {
return args[i];
}
}
return null;
}
}
AOP中的使⽤
@AfterReturning(returning = "obj", pointcut = "xxx")
public void after(JoinPoint joinPoint, Object obj){
MethodSignature signature = (MethodSignature) Signature();
LogRecord annotation = Method().getAnnotation(LogRecord.class);
// 通过AnnotationResolve解析注解属性参数
AnnotationResolver annotationResolver = wInstance();
Object paramObj = solver(joinPoint, annotation.adminId());
...
}
从上⾯的⽰例中也可以看到,核⼼就是AnnotationResolver注解解析器,注解属性值通过#和参数形参名的⽅式 "#adminId"和参数值进⾏映射,从⽽解析出相应的值。除了上述的简单使⽤⽰例外,还⽀持复杂的参数的解析,⽐如参数是user对象是,属性值只需要userName,那么相关注解属性的值可配置为"#user.userName"。
遗留问题
上述⽅案解决了⾃定义注解将⽅法参数值动态绑定到注解属性上的实现,但略有遗憾的是并未实现和@Cacheable配置key时,输⼊#后,IDEA可以直接提⽰相关参数名,输⼊完成后还可以通过CTRL + ⿏标左键的链接效果,有此技巧者看到后,还望不吝赐教!