深入理解Spring注解机制：合并注解的合成

Posted 2023-03-18

参考技术A 众所周知， spring 从 2.5 版本以后开始支持使用注解代替繁琐的 xml 配置，到了 springboot 更是全面拥抱了注解式配置。平时在使用的时候，点开一些常见的等注解，会发现往往在一个注解上总会出现一些其他的注解，比如 @Service ：

大部分情况下，我们可以将 @Service 注解等同于 @Component 注解使用，则是因为 spring 基于其 JDK 对 元注解的机制 进行了扩展。

在 java 中，元注解是指可以注解在其他注解上的注解，spring 中通过对这个机制进行了扩展，实现了一些原生 JDK 不支持的功能，比如允许在注解中让两个属性互为别名，或者将一个带有元注解的子注解直接作为元注解看待，或者在这个基础上，通过 @AliasFor 或者同名策略让子注解的值覆盖元注解的值。

本文将基于 spring 源码 5.2.x 分支，解析 spring 如何实现这套功能的。

这是系列的第三篇文章，将详细介绍 Spring 是如何在经过搜索与属性映射后，将处理后的注解合成为合并注解的。

相关文章：

我们在前文了解用于搜索注解的合并注解聚合 MergedAnnotations 与用于完成注解属性映射的 AnnotationTypeMappings 和 AnnotationTypeMapping ，现在我们需要知道在 MergedAnnotations 这个容器中， AnnotationTypeMappings 和 AnnotationTypeMapping 是如何转为一个我们所需要的合并注解 MergedAnnotation 的。

与前文一样，我们以 AnnotatedElementUtils.findMergedAnnotations 方法作为入口：

我们在上文顺着 MergedAnnotations.get 一路找到 TypeMappedAnnotations.MergedAnnotationFinder 的 process 方法，在这里我们目睹了一个普通的注解的元注解被解析为 AnnotationTypeMappings 与 AnnotationTypeMapping 的过程：

该方法是 AnnotationTypeMapping 转为 MergedAnnotation 的关键。

TypeMappedAnnotation 是 MergedAnnotation 一个通用实现，在大部分情况下，我们所说的合并注解其实指的就是这个类。

通过它的构造方法我们得以了解其创建过程：

可以看得出， TypeMappedAnnotation 基本可以认为是 AnnotationTypeMapping 的包装类，它以一个 AnnotationTypeMapping 实例作为数据源，从而提供一些关于映射后的属性的相关功能。

回到 AnnotatedElementUtils.findMergedAnnotations ，我们可以看到，在通过 MergedAnnotations 获得了一个 MergedAnnotation 对象——实际上是 TypeMappedAnnotation 对象——之后，又调用了 MergedAnnotation.synthesize 方法，将 MergedAnnotation 转成了一个调用方指定类型的注解对象。

该方法先调用了 AbstractMergedAnnotation 的 synthesize 方法：

随后再调用了实现类 TypeMappedAnnotation 的 synthesize 方法：

继续点开 createSynthesized ：

而 SynthesizedMergedAnnotationInvocationHandler 是一个用于 JDK 动态代理的 InvocationHandler ，我们不需要完全站看，仅需看看它的构造函数与 InvocationHandler.invoke 就能明白它的运作机制了：

至此，合并注解的合成机制已经很明确了：

承接上文，当我们使用 MergedAnnotation.synthesize 方法时，我们可能会得到两种对象：

而通过注解代理对象取值时，这些方法会被代理到 SynthesizedMergedAnnotationInvocationHandler 中存放的 MergedAnnotation 对象上，从而让这个代理对象通过原始注解的属性，获得与原始注解不一样的属性值。

当我们调用代理对象的属性值时，它会在 SynthesizedMergedAnnotationInvocationHandler 中，通过 invoke 代理到对应的方法上：

这里我们代理对象是如何获取注解属性值的：

这里的 MergedAnnotation.getValue 最终在经过多次跳转后，调到 TypeMappedAnnotation.getAttributeValue 上：

而这边的 getValue 方法就是真正要获取属性值的地方。

这一步有点复杂，主要是根据不同的情况，通过 AnnotationTypeMapping 中的几个属性映射数组，包括 aliasMappings 、 conventionMappings ， annotationValueMappings 与 annotationValueSource 来确定最终用于取值的 AnnotationTypeMapping 对象与调用的方法在 AttributeMethods 中的下标：

至此，获取属性值的方法流程也走完了。

在这一章，我们了解了当通过 MergedAnnotations 获得注解并解析得到 AnnotationTypeMapping 后， AnnotationTypeMapping 是如何再转为我们所需的 MergedAnnotation ，以及在此之后， MergedAnnotation 又是如何生成我们最终所需要的代理注解的。

简而言之，当解析注解的元注解获得所需的 AnnotationTypeMapping 后， MergedAnnotation 会判断 AnnotationTypeMapping 是否发生过属性映射，如果没有则返回该映射对象对应的原始注解，否则就通过 SynthesizedMergedAnnotationInvocationHandler 生成一个对应类型的 JDK 动态代理对象。

当我们通过代理对象去调用注解的方法，获取注解的属性的时候， SynthesizedMergedAnnotationInvocationHandler 会把方法代理到对应的内部方法中，而获取属性时，还会通过 MergedAnnotation.getValue ，最终绕到 AnnotationTypeMapping 中获取被映射后的属性值。

深入理解Spring中的各种注解

转自这里：走，去看看原文

 

一、Spring中的注解大概可以分为两大类：

　　spring的bean容器相关的注解，或者说bean工厂相关的注解

　　　　spring的bean容器相关的注解有：@Required， @Autowired, @PostConstruct, @PreDestory。还有Spring3.0开始支持的JSR-330标准javax.inject.*中的注解(@Inject, @Named, @Qualifier, @Provider, @Scope, @Singleton).

　　springmvc相关的注解

　　　　springmvc相关的注解有：@Controller，@RequestMapping，@RequestParam， @ResponseBody等等。

 

 

二、要理解Spring中的注解，先要理解Java中的注解。

　1、Java中1.5中开始引入注解，我们最熟悉的应该是：@Override, 这里以此举例，它的定义如下：

　　 

　　从注释，我们可以看出，@Override的作用是，提示编译器，使用了@Override注解的方法必须override父类或者java.lang.Object中的一个同名方法。我们看到@Override的定义中使用到了 @Target, @Retention，它们就是所谓的“元注解”——就是定义注解的注解，或者说注解注解的注解(晕了…)。

　　我们看下@Retention

　　

 　　@Retention用于提示注解被保留多长时间，有三种取值：

　　

　　RetentionPolicy.SOURCE 保留在源码级别，被编译器抛弃(@Override就是此类)；

　　RetentionPolicy.CLASS被编译器保留在编译后的类文件级别，但是被虚拟机丢弃；

　　RetentionPolicy.RUNTIME保留至运行时，可以被反射读取。

 

　　再看 @Target:

　　

　　@Target用于提示该注解使用的地方，取值有：

　　

　　分别表示该注解可以被使用的地方：1)类,接口，注解，enum; 2)属性域；3）方法；4）参数；5）构造函数；6）局部变量；7）注解类型；8）包

　　所以：

　　

     表示 @Override 只能使用在方法上，保留在源码级别，被编译器处理，然后抛弃掉。

 

     还有一个经常使用的元注解 @Documented ：表示注解是否能被 javadoc 处理并保留在文档中。

　　

 

　2、使用 元注解 来自定义注解 和 处理自定义注解

　　有了元注解，那么我就可以使用它来自定义我们需要的注解。结合自定义注解和AOP或者过滤器，是一种十分强大的武器。比如可以使用注解来实现权限的细粒度的控制——在类或者方法上使用权限注解，然后在AOP或者过滤器中进行拦截处理。下面是一个关于登录的权限的注解的实现：

　　 

　　我们自定义了一个注解 @NoLogin, 可以被用于 方法 和 类 上，注解一直保留到运行期，可以被反射读取到。该注解的含义是：被 @NoLogin 注解的类或者方法，即使用户没有登录，也是可以访问的。下面就是对注解进行处理了：

　　

　　上面我们定义了一个登录拦截器，首先使用反射来判断方法上是否被 @NoLogin 注解：

 NoLogin noLogin = handlerMethod.getMethod().getAnnotation(NoLogin.class);

 

　　然后判断类是否被 @NoLogin 注解：

noLogin = handlerMethod.getMethod().getDeclaringClass().getAnnotation(NoLogin.class); 

　　如果被注解了，就返回 true，如果没有被注解，就判断是否已经登录，没有登录则返回错误信息给前台和false. 这是一个简单的使用 注解 和 过滤器 来进行权限处理的例子。

　　扩展开来，那么我们就可以使用注解，来表示某方法或者类，只能被具有某种角色，或者具有某种权限的用户所访问，然后在过滤器中进行判断处理。

　3. spring的bean容器相关的注解

　　  @Autowired 是我们使用得最多的注解，其实就是 autowire=byType 就是根据类型的自动注入依赖（基于注解的依赖注入），可以被使用再属性域，方法，构造函数上。

        @Qualifier 就是 autowire=byName, @Autowired注解判断多个bean类型相同时，就需要使用 @Qualifier("xxBean") 来指定依赖的bean的id：　　　　

@Controller
@RequestMapping("/user")
public class HelloController 
    @Autowired
    @Qualifier("userService")
    private UserService userService;

 

        @Resource 属于JSR250标准，用于属性域和方法上。是 byName 类型的依赖注入。使用方式：@Resource(name="xxBean"). 不带参数的 @Resource 默认值类名首字母小写。

　　 JSR-330标准javax.inject.*中的注解(@Inject, @Named, @Qualifier, @Provider, @Scope, @Singleton)。@Inject就相当于@Autowired, @Named 就相当于 @Qualifier, 另外 @Named 用在类上还有 @Component的功能。

　　 @Component， @Controller, @Service, @Repository, 这几个注解不同于上面的注解，上面的注解都是将被依赖的bean注入进入，而这几个注解的作用都是生产bean, 这些注解都是注解在类上，将类注解成spring的bean工厂中一个一个的bean。@Controller, @Service, @Repository基本就是语义更加细化的@Component。

 

　4. spring中注解的处理

　　　　spring中注解的处理基本都是通过实现接口 BeanPostProcessor 来进行的：

public interface BeanPostProcessor 
    Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException;
    Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException;

　　　　相关的处理类有：

AutowiredAnnotationBeanPostProcessor，
CommonAnnotationBeanPostProcessor，
PersistenceAnnotationBeanPostProcessor， 
RequiredAnnotationBeanPostProcessor

 

　　 　 这些处理类，可以通过 <context:annotation-config/> 配置隐式的配置进spring容器。这些都是依赖注入的处理，还有生产bean的注解(@Component， @Controller, @Service, @Repository)的处理：

<context:component-scan base-package="net.aazj.service,net.aazj.aop" />

 

　　  　这些都是通过指定扫描的基包路径来进行的，将他们扫描进spring的bean容器。注意 context:component-scan 也会默认将 AutowiredAnnotationBeanPostProcessor，CommonAnnotationBeanPostProcessor 配置进来。所以<context:annotation-config/>是可以省略的。另外context:component-scan也可以扫描@Aspect风格的AOP注解，但是需要在配置文件中加入 <aop:aspectj-autoproxy/> 进行配合。 　　

　　5. Spring注解和JSR-330标准注解的区别：