JDK动态代理后,如何获取类或方法上的注解信息

Spring项目中,使用JDK动态代理为注解生成Aop切面,而注解解析器却无法获取注解信息。

问题复现

说明:假设需要通过注解实现权限控制。下面代码只为描述问题,省却实现逻辑。

权限注解
/**
 * 权限控制注解
 *
 * @author jiangwang
 * @date 2018/7/30.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface Authority {
    String role() default "";
}
权限注解解析器
@Aspect
@Component
public class AuthorityProcessor implements Ordered{
    private int order = LOWEST_PRECEDENCE - 1000; // 指定执行顺序
    @Pointcut("@annotation(com.foo.service.annotation.Authority)")
    public void authorityPoint() {
    }
    @Around("authorityPoint()")
    public Object process(ProceedingJoinPoint jp) throws Throwable{
        Method method = getMethod(jp);
        Authority authority = AnnotationUtils.findAnnotation(method, Authority.class);
        if (authority.role().equals("foo")){
            return jp.proceed();
        }
        return null;
    }
    private Method getMethod(ProceedingJoinPoint jp) {
        MethodSignature methodSignature = (MethodSignature) jp.getSignature();
        return methodSignature.getMethod();
    }
    @Override
    public int getOrder() {
        return order;
    }
}
订单接口
/**
 * @author jiangwang
 * @date 2018/7/30.
 */
public interface OrderService {
    String getOrder();
}
订单接口实现
/**
 * @author jiangwang3
 * @date 2018/7/30.
 */
@Service
public class OrderServiceImpl implements OrderService{
    @Override
    @Authority(role = "foo")
    public String getOrder() {
        return null;
    }
}

以上为主要代码,项目正常运行,访问带有权限注解的接口,出现NullPointerException

Authority authority = AnnotationUtils.findAnnotation(method, Authority.class);

debug发现上面这行代码结果为空,即authority为空。有点想不通,既然已经通过注解为该类生成了代理,说明方法getOrder()的签名中是存在注解@Authority的,并且已经生效,可为何method中没有注解信息呢?WHY???


问题探究

从代码运行结果可以断定,已经为OrderServiceImpl类生成了代理类,然后从代理类中的getOrder()方法上获取注解信息失败。查看项目与代理相关的配置文件,有这么一句话:

<aop:aspectj-autoproxy/>

说明使用了JDK动态代理为OrderServiceImpl类生成了代理(因为OrderServiceImpl实现了OrderService接口)。尝试性地改动配置,

<aop:aspectj-autoproxy proxy-target-class="true"/>

作出如上改动后,则变成强制使用CGLIB方式生成代理类。也正是这一句话的改动,项目正常运行了,也获取到了方法上@authority的值(-_-)。从而,咱们的问题变成,JDK动态代理后,如何获取类或方法上的注解信息?


获取JDK动态代理后的注解信息

JDKProxy代理是基于接口的,所以这里的getMethod()获取到的实际上是接口的方法签名,如果注解不在接口上,是找不到注解的。所以这里需要我们去真正地拿到实现类(OrderServiceImpl)中的方法签名。
想到Spring中有一个注解@Transactional,它肯定不管是哪种代理方式,都能实现其功能,遂向其学习。阅读关于@Transactional的注解解析器的源码(这里我们就不看了,以后会有专门的文章讲),贴出我从它的源码中发现的一句与咱们主题密切相关的一行代码,位于org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource#computeTransactionAttribute中:

// The method may be on an interface, but we need attributes from the target class.
// If the target class is null, the method will be unchanged.
Method specificMethod = ClassUtils.getMostSpecificMethod(method, userClass);

注释第一行可以译成:method可能是接口中的,但是我们需要从目标类中获取属性。所以这句话就可以解决,“JDK动态代理后,如何获取类或方法上的注解信息?”这个问题,修改文章开头getMethod()方法:

private Method getMethod(ProceedingJoinPoint jp) {
        MethodSignature methodSignature = (MethodSignature) jp.getSignature();
        Method method = methodSignature.getMethod();
        //如果是jdk proxy,上面的method是接口中的方法签名。需要下面这句话,获取实现类中的的方法签名
        return ClassUtils.getMostSpecificMethod(method, jp.getTarget().getClass());
    }

jp.getTarget().getClass()获取到了真正的实现类,然后从实现类中获取方法签名。


解决方案

总体来说,解决方案有两个:
1.项目中使用CGLIB动态代理,这样既避免了从JDK动态代理类中获取注解信息,即配置成:

<aop:aspectj-autoproxy proxy-target-class="true"/>

2.如果比较执着,“我就用JDK动态代理”,那么在上一部分已经给出了答案。

推荐阅读更多精彩内容