Spring MVC 解读——@Autowired（转）

转自：http://my.oschina.net/HeliosFly/blog/203902

Spring MVC 解读——@Autowired

一、@Autowired

作为一个Spring开发者对@Autowired注解必定是非常了解了, 顾名思义自动装配，应该是Spring会自动将我们标记为@Autowired的元素装配好，与其猜测不如看看它的定义：

?
很明显这个注解可以用到构造器，变量域，方法，注解类型上。文档上这样描述：将一个构造器，变量域，setter方法，config方法标记为被Spring DI 工具自动装配。换句话说，我们视图从bean 工厂中获取一个bean时，Spring会自动为我们装配该bean中标记为@Autowired的元素，而无需我们手动完成。这些相信大家都明白，但问题是，Spring是怎样做到的？在Spring MVC中怎样做到的？什么时候进行的自动装配？下面我们就来探究下这些问题。

二、BeanPostProcessor

在@Autowired的定义中有下面一段话：

?
意思是：实际的注入装配动作是由BeanPostProcessor执行的，翻过来说你不能将@Autowired注解用于BeanPostProcessor或BeanFactoryPostProcessor类型上。请查看AutowiredAnnotationBeanPostProcessor文档（默认情况下，被用来检查@Autowired注解）。

文档说的很清楚了，BeanPostProcessor来执行自动装配，并且默认情况下使用AutowiredAnnotationBeanPostProcessor实现类完成。那我们不妨看一下他们的定义：

?
BeanPostProcessor就一个回调接口，定义了两个方法声明，一个是实例化前被调用，一个是实例化后被调用，没啥好看的，我们直接看看它的实现类AutowiredAnnotationBeanPostProcessor：

?
上面是AutowiredAnnotationBeanPostProcessor类的描述文档摘要，大致意思是：这是BeanPostProcessor接口的一个实现，用来自动装配注解的变量域，setter方法和任意的config方法。这些被注入的元素是通过检测Java 5的注解完成的：默认情况下是@Autowired和@Value注解。同样也支持JSR-330的@Inject注解。并且，<context:annotation-config/>和<context:component-scan/>XML标签可以默认注册AutowiredAnnotationBeanPostProcessor到bean工厂中。最后，注解注入会在XML注入之前执行；因此后面的配置会覆盖前面已经装配好的元素。

是不是很清楚了？Spring的文档总是这么详细，要么说是教科书呢，废话不多说，我们才刚进正题呢，既然我们清楚了是AutowiredAnnotationBeanPostProcessor实例执行了自动装配，那么它做了什么呢？

三、磨刀砍柴

在正式查看源码前，我先大致的讲一下整个装配的过程，以便后面理解起来轻松些。其实整体思路还是很简单的，我们举个简单的例子：

?
1）在某一时刻Spring调用了 Bean工厂 的 getBean(beanName) 方法。beanName可能是simpleController，或者simpleService，simpleDao，顺序没关系（因为后面会有依赖关系的处理）。我们假设simpleController吧。

2）getBean方法首先会调用Bean工厂中定义的getSingleton(beanName)方法，来判断是否存在该名字的bean单例，若果存在则返回，方法调用结束。

3）否则，Spring会检查是否存在父工厂，如果有则返回，方法调用结束。

4）否则，Spring 会检查该bean 定义（BeanDefinition实例，用来描述Bean结构，上篇文章讲到过，component-scan 扫描后，就是将beanDefinition实例放入Bean工厂，此时Bean还没有被实例化。）是否有依赖关系，如果有，执行1）步，获取依赖的bean实例。

5）否则，Spring会尝试创建这个bean实例，创建实例前，Spring会检查确定调用的构造器，并实例化该Bean。

6）实例化完成后，Spring会调用Bean工厂的populateBean方法来填充bean实例的属性，也就是我们前面提到的自动转配了。populateBean方法便是调用了BeanPostProcessor实例来完成属性元素的自动装配工作。

7）在元素装配过程中，Spring会检查被装配的属性是否存在自动装配的其他属性，然后递归调用getBean方法，直到所有@Autowired的元素都被装配完成。如在装配simpleController中的simpleService属性时，发现SimpleServiceImpl实例中存在@Autowired属性simpleDao，然后调用getBean（simpleDao）方法，同样会执行1）-7）整个过程。所以可以看成一个递归过程。

8）装配完成后，Bean工厂会将所有的bean实例都添加到工厂中来。

注：我们知道Spring MVC是多线程单实例的MVC框架，就是说，对于同一个Controller，只会生成一个实例来处理所有的请求，因此bean实例只会实例化一次，并被存放在工厂中，以供其他请求使用。

好了，大致了解整个流程后我们看一下Spring的具体行为吧。

四、Bean 工厂

前面多次提到了Bean工厂，但一直没有说它到底是个什么，这里我们就彻底弄清楚吧，省的云里雾里，这样我们后面讲到Bean工厂就不会晕了。看过上一篇博客（<context:component-scan/>）的朋友可能记得DefaultListableBeanFactory这个类，当时是它保存了扫描到的组件--Bean Definition实例。那他是否是我们所说的Bean工厂呢？是否保存了Bean实例呢？答案是：对。





我们可以看到DefaultLiableBeanFactory继承自DefaultSingletonBeanRegistry，AbstractBeanFactory，AbstractAutowireCapableBeanFactory。下面就列出了一下相关的Bean工厂中的属性和方法：

?
可以看到Bean工厂中即存有bean definition的映射表，也存有bean name的别表，以及bean实例的映射表，还有依赖关系图。理解了这个对下面的实例化以及装配过程会有很大帮助。

五，实例化与装配

下面我们就从头到尾看一下整个的实例化和装配过程：

?
这个方法好长，真的好长，我还删除了一些与当前主体无关的代码呢，好吧，不要被吓住，如果是自己写的代码，再长都很容易弄懂，类的继承关系再复杂都能轻车熟路，那是因为我们都清楚的知道每一行的用意，看别人的代码一样，多看几遍就明白了，再复杂都一样。

首先Spring会检查beanName，获取规范的beanName，然后它会检查是否存在已经注册的单例（查询上面提到的singletonObjects映射表），如果有的话就直接返回了，一切就结束了，否则的话，会查看是否存在父工厂，如果有调用父工厂的getBean方法，如果没有呢？

好吧那就要着手创建实例了，首先查看beanDefinitionMap查找该beanName对应的beanDefinition实例，然后根据该实例判断是否存在依赖关系，如果存在在递归的调用getBean方法，直到所有的依赖关系都正确的实例化和装配完成，并且将这些依赖关系保存到上面提到的dependencyForBeanMap 和dependentBeanMap中。

接下来，Spring查看BeanDefinition来确定该Bean应该是单例方式创建还是原型方式创建？如果是单例的话，Spring会调用getSingleton方法查找或创建一个单例（下面会详聊），如果是原型的话，每次调用getBean方法都会创建一个新的实例，看上面代码便会一清二楚了。

那下面我们就看看这个getSingleton方法做了什么？

?
这里稍微清晰了，查看singletonObjects映射表，看是否存在已经注册的单例，如果没有调用createBean方法创建一个，并且注册到singletonObjects映射表中，否则直接返回就Ok了。

下面就是createBean了， we are close。

?
比较清晰（同样去除了一些我们不关心的代码），上面的方法分了我们期望的两部执行，第一实例化Bean，第二装配Bean。

第一步实例化主要是通过确定调用的构造器来最终调用Class.newInstance(args)方法来实例化Bean。不做细究，有兴趣可以自己看看，比较简单，主要是第二部装配，也就是处理我们的@Autowired注解（终于找到正题了）。

六、执行装配

方法populateBean执行了最终的Autowired动作，我们看一下它做了什么？话说这块有点麻烦了，开始之前想讲几个比较重要的类和接口吧：

A) PropertyValue：这是一个用来表示Bean属性的对象，其中定义了属性的名字和值等信息，如simpleService，和simpleDao属性。

B) PropertyDescriptor：这个事Bean属性的描述符，其中定义了该属性可能存在的setter和getter方法，以及所有Bean的Class对象。

C) InjectionMetadata：这个是注入元数据，包含了目标Bean的Class对象，和注入元素（InjectionElement）集合.

D) InjectionElement：这个是注入元素，包含了注入元素的java.lang.reflect.Member 的对象，以及一个PropertyDescriptor对象。就是对java.lang.reflect.Member的一个封装，用来执行最终的注入动作，它有两个子类，分别是：AutowiredFieldElement表示字段属性，AutowiredMethodElement表示方法。

其实最终的目标就是将PropertyValue中的value值赋给InjectionElement中的Member对象。那它是怎么做的呢？

?
Spring 尝试获取bean definition的PropertyValue集合，开始当然是空的，然后下面便是进行根据名字或者类型为我们的PropertyValue集合进行赋值了， 在不设置<beans default-autowire="byName/byType"/>的情况下是不会调用这个方法的，如果设置了byName，我们来看看做了什么？

?
上面两段代码的意思是，查看当前bean的所有属性（描述符），然后依次判断查找符合条件的属性，并添加到属性名称数组中，然后遍历这个数组，对其中的属性名依次调用getBean(propertyName)方法来获取或创建该名称的bean实例，并将该bean实例设为PropertyValue的value值，最后添加到依赖关系映射表中（dependencyForBeanMap和dependentBeanMap）。好了此时PropertyValues有值了，后面就可以用它来注入到bean的属性中了。我们接着看上面populateBean方法。

PropertyValue值设置后，Spring会调用getBeanPostProcessor方法遍历Bean工厂中注册的所有BeanPostProcessor，其中就包括AutowiredAnnotationBeanPostProcessor（这些BeanPostProcessor都是系统默认硬编码注册到bean工厂中的）。接着就会调用AutowiredAnnotationBeanPostProcessor的postProcessPropertyValues方法，并将之前的PropertyValues和bean实例传递进去。

?
上面三个方法看似复杂其实很简单，首先Spring尝试调用findAutowiringMetadata方法获取该bean的InjectionMetadata实例（也就是有哪些属性需要被自动装配，也就是查找被@Autowired注解标记的元素）。怎么获取呢？首先去缓存里面找，找不到就遍历bean的和父类的字段域和方法，如果别标记为@Autowired并且不是静态的就添加到InjectionMetadata中，并添加到缓存中(各种缓存啊)。获得InjectionMetadata对象后便遍历其中的所有InjectionElement对象，调用其中的inject方法。前面说了InjectionElement有两个实现类，我们只看一个就可以，因为基本相同：

?
可以看到，虽然PropertyValues属性传递过去了，但是并没有使用它直接赋值给属性变量（还不清楚为什么会传递它，其实没用到），而是通过调用bean工厂的resolveDependency方法来获取属性值得。那我们看一下resolveDependency做了什么？

?
这个方法其实就是根据类型到bean工厂中查找类型匹配的bean实例，然后就看到了这几个条件分支语句，如果是数组，集合，映射表，自定义类型都执行了差不多的操作，findAutowireCandidate方法。这个方法会去工厂中执行类型匹配的查找，将匹配的结果集返回，不同的是，集合数组类型会通过TypeConverter进行结果的转换。

到此为止，找到了属性的匹配值，然后反射赋值就完成了整个的自动装配过程。可以看出，@Autowired是通过类型来进行自动装配的。

上面是属性的赋值过程也就是InjectionFieldElement的inject方法，InjectionMethodElement的inject方法大致相同只是对每一个方法参数执行一次resolveDependency方法来获取参数值，然后反射执行方法。

到此为止，整个实例化和装配过程也就讲完了，我们总结一下：

1）一切都是从bean工厂的getBean方法开始的，一旦该方法调用总会返回一个bean实例，无论当前是否存在，不存在就实例化一个并装配，否则直接返回。

2）实例化和装配过程中会多次递归调用getBean方法来解决类之间的依赖。

3）Spring几乎考虑了所有可能性，所以方法特别复杂但完整有条理。

4）@Autowired最终是根据类型来查找和装配元素的，但是我们设置了<beans default-autowire="byName"/>后会影响最终的类型匹配查找。因为在前面有根据BeanDefinition的autowire类型设置PropertyValue值得一步，其中会有新实例的创建和注册。就是那个autowireByName方法。

七、一切的开始

我们上面讲完了整个Autowire过程了。那么，还有一个问题，上一篇我们知道了什么时候执行的配置文件读取和组件扫描，但Spring MVC是在什么时候开始执行真个实例化过程的呢？很简单就在组件扫描完成之后，bean工厂的refresh方法中（还记得吗？）

?
就是上面的finishBeanFactoryInitialization方法执行了装配工作，该方法会调用bean工厂的preInstantiateSingletons方法，这个方法会遍历所有注册的bean definition实例，如果是单例并且是非延迟加载的就调用getBean方法。

好了，到此为止我们就清晰的了解了，Spring ＭＶＣ的实例化和自动装配工作了，如有问题欢迎评论中提出，我们一起讨论。