Sprig源码学习
本文是按照自己的理解进行笔记总结,如有不正确的地方,还望大佬多多指点纠正,勿喷。
1. Spring中到底有几种依赖注入的方式?
现在相当于两种方式赋值,第一种就是注解@Autowired
第二种就是程序员手动赋值,利用beanDefinition。
那这两种情况下,你觉得spring会用哪一个?当然是第二种了。
我们下面再来分析下面得依赖注入是怎么注入的,@Bean
@Bean就是通过autowire = Autowire.BY_NAME,autowire = Autowire.BY_TYPE。
看一看像这种模式是怎么依赖注入的,主要是判断定义的这个userService得bean得set方法。就是不用autowired得注解也能完成依赖注入。
我们分析这个,先打个断点
运行进入方法,然后回进入autowireByName(beanName, mbd, bw, newPvs);这个方法。
进去下面这个方法就会做一件事情,就是拿到属性的名字,里面有一个概念,属性描述器,这个东西并不是spring提供的。是javabeans里面的。
什么是属性描述器呢?相当于是和规范有关系的,你一个javabean一个属性,你的属性要相对应的有get、set方法的,而这个属性描述器描述的是一个属性,他首先会看你这个属性的名字是什么,以及你这个属性所对应的set方法名字是什么,以及你这个属性所对应的get方法的名字是什么。
回到我们刚才看到的属性描述器,这个方法里面有一个BeanWrapper,我们现在看的属性填充,相当于前面都已经实例化好了,而实例化好的话他就会把他包围起来,这个BeanWrapper里面有你生成好的实例对象,还可以获取到很多其他的信息。这个时候所拿到的
pds
虽然我们通过上面的方法我们可以获取一些东西, 其实下面是有判断的进行过滤。比如你至少有一个set方法我才会去返回,虽然pds里面的0里面有get方法,但是没有set方法,最后我也不会把你返回的。因此最终返回的只有一个结果。
虽然看起来我们拿的是属性的名字,你不是要依赖注入吗,我们要给哪些属性进行依赖注入呢,就把属性的名字拿过来了(就是setXXXX后面的XXXX),拿到名字之后把你所有的set方法拿过来,根据你这个后面的名字XXXX去找bean对象,根据反射传到这个set方法来执行,这个时候就完成了依赖注入。
如果我们设置OrderService的类型是Number类型
再写
这个时候如果使用@Bean(autowire = Autowire.BY_NAME)注解就是返回null,如果是@Autowired就会返回值1。是因为@Bean(autowire = Autowire.BY_NAME)注解有过滤,就会把这种情况给过滤掉。
像简单类型,spring是不会管的,帮你注入,但是@Autowired是支持的。之所以支持是因为没有这个判断,没有过滤掉。
@Autowired是怎么支持的呢?
能找到吗
然后把属性的名字找过来,然后拿bean,然后加到beanDefinition进来。
存值
@Bean(autowire = Autowire.BY_NAME)与@Bean(autowire = Autowire.BY_TYPE)其实并没有给对象真正的赋值,只是把把属性找到的值加到了pvs集合里面。
不管是byType还是byName都是去找UserService的set方法,然后去spring容器里面找对象,然后找到对象之后,只是暂时的把他加到BeanDefinition哪个集合里面而已
加入集合
这一行代码就是去处理我们哪些@Autowired注解,@Value注解,@Resource注解.
但是怎么去处理的呢就是调用后置管理器
我们的@Autowired注解,@Value注解是被AutowiredAnnotationBeanPostProcessor这个后置处理器处理的。
@Resource注解.是被CommonAnnotationBeanPostprocessor这个后置处理器处理的。
我们先看AutowiredAnnotationBeanPostProcessor这个方法。
而这个SmartInstantiationAwareBeanPostProcessor接口的功能更加强大。他除开有那些实例化前、实例化后的功能之外,还增加了一些功能,这写和推断构造方法也有关系、和循环依赖也是有关系的,暂时先把他理解为前面讲的InstantiationAwareBeanPostProcessor,它里面就提供了实例化前、实例化后以及处理属性的方法。
我们再来看一下MergedBeanDefinitionPostProcessor这个接口,这个接口是在实例化后的前面执行的
这里面有一个触及属性的写法。
这个方法是实现了我们刚说的实例化,那个回调的方法
这个postprocessmergedBeanDefinition是哪个接口提供的,是我们看到的那个MergedBeanDefinitionPostProcessor提供的,而我们看到的下面的方法postProcessproperties是InstantiationAwarebeanPostprocessor提供的。那这两个方法到底是谁先执行呢?是这个postprocessmergedBeanDefinition先执行,意思是我现在去创建任何一个bean,我会先执行这个postprocessmergedBeanDefinition方法,然后再来执行postProcessproperties这个方法。
那执行postprocessmergedBeanDefinition这个方法,会把当前正在创建的这个bean,beanDefinition对象、beanType、beanName传进来。
1.1 手动注入
在XML中定义Bean时,就是手动注入,因为是程序员手动给某个属性指定了值。
<bean name="userService" class="com.luban.service.UserService">
<property name="orderService" ref="orderService"/>
</bean>
上面这种底层是通过set方法进行注入。
<bean name="userService" class="com.luban.service.UserService">
<constructor-arg index="0" ref="orderService"/>
</bean>
上面这种底层是通过构造方法进行注入。
所以手动注入的底层也就是分为两种:
- set方法注入
- 构造方法注入
1.2 自动注入
自动注入又分为两种:
- XML的autowire自动注入
- @Autowired注解的自动注入
1.3 XML的autowire自动注入
在XML中,我们可以在定义一个Bean时去指定这个Bean的自动注入模式:
- byType
- byName
- constructor
- default
- no
比如:
<bean id="userService" class="com.luban.service.UserService" autowire="byType"/>
这么写,表示Spring会自动的给userService中所有的属性自动赋值(不需要这个属性上有@Autowired注解,但需要这个属性有对应的set方法)。
在创建Bean的过程中,在填充属性时,Spring会去解析当前类,把当前类的所有方法都解析出来,Spring会去解析每个方法得到对应的PropertyDescriptor对象,PropertyDescriptor中有几个属性:
- name:这个name并不是方法的名字,而是拿方法名字进过处理后的名字
a. 如果方法名字以“get”开头,比如“getXXX”,那么name=XXX
b. 如果方法名字以“is”开头,比如“isXXX”,那么name=XXX
c. 如果方法名字以“set”开头,比如“setXXX”,那么name=XXX - readMethodRef:表示get方法的Method对象的引用
- readMethodName:表示get方法的名字
- writeMethodRef:表示set方法的Method对象的引用
- writeMethodName:表示set方法的名字
- propertyTypeRef:如果有get方法那么对应的就是返回值的类型,如果是set方法那么对应的就是set方法中唯一参数的类型
get方法的定义是: 方法参数个数为0个,并且 (方法名字以"get"开头 或者 方法名字以"is"开头并且方法的返回类型为boolean)
set方法的定义是:方法参数个数为1个,并且 (方法名字以"set"开头并且方法返回类型为void)
所以,Spring在通过byName的自动填充属性时流程是:
- 找到所有set方法所对应的XXX部分的名字
- 根据XXX部分的名字去获取bean
Spring在通过byType的自动填充属性时流程是:
- 获取到set方法中的唯一参数的参数类型,并且根据该类型去容器中获取bean
- 如果找到多个,会报错。
以上,分析了autowire的byType和byName情况,那么接下来分析constructor,constructor表示通过构造方法注入,其实这种情况就比较简单了,没有byType和byName那么复杂。
如果是constructor,那么就可以不写set方法了,当某个bean是通过构造方法来注入时,spring利用构造方法的参数信息从Spring容器中去找bean,找到bean之后作为参数传给构造方法,从而实例化得到一个bean对象,并完成属性赋值(属性赋值的代码得程序员来写)。
我们这里先不考虑一个类有多个构造方法的情况,后面单独讲推断构造方法。我们这里只考虑只有一个有参构造方法。
其实构造方法注入相当于byType+byName,普通的byType是根据set方法中的参数类型去找bean,找到多个会报错,而constructor就是通过构造方法中的参数类型去找bean,如果找到多个会根据参数名确定。
另外两个:
- no,表示关闭autowire
- default,表示默认值,我们一直演示的某个bean的autowire,而也可以直接在标签中设置autowire,如果设置了,那么标签中设置的autowire如果为default,那么则会用标签中设置的autowire。
可以发现XML中的自动注入是挺强大的,那么问题来了,为什么我们平时都是用的@Autowired注解呢?而没有用上文说的这种自动注入方式呢?
@Autowired注解相当于XML中的autowire属性的注解方式的替代。这是在官网上有提到的。
Essentially, the @Autowired annotation provides the same capabilities as described in Autowiring Collaborators but with more fine-grained control and wider applicability
翻译一下:
从本质上讲,@Autowired注解提供了与autowire相同的功能,但是拥有更细粒度的控制和更广泛的适用性。
注意:更细粒度的控制。
XML中的autowire控制的是整个bean的所有属性,而@Autowired注解是直接写在某个属性、某个set方法、某个构造方法上的。
再举个例子,如果一个类有多个构造方法,那么如果用XML的autowire=constructor,你无法控制到底用哪个构造方法,而你可以用@Autowired注解来直接指定你想用哪个构造方法。
同时,用@Autowired注解,还可以控制,哪些属性想被自动注入,哪些属性不想,这也是细粒度的控制。
但是@Autowired无法区分byType和byName,@Autowired是先byType,如果找到多个则byName。
那么XML的自动注入底层其实也就是:
- set方法注入
- 构造方法注入
1.4 @Autowired注解的自动注入
上文说了@Autowired注解,是byType和byName的结合。
@Autowired注解可以写在:
- 属性上:先根据属性类型去找Bean,如果找到多个再根据属性名确定一个
- 构造方法上:先根据方法参数类型去找Bean,如果找到多个再根据参数名确定一个
- set方法上:先根据方法参数类型去找Bean,如果找到多个再根据参数名确定一个
而这种底层到了:
- 属性注入
- set方法注入
- 构造方法注入
2. 寻找注入点
在创建一个Bean的过程中,Spring会利用AutowiredAnnotationBeanPostProcessor的postProcessMergedBeanDefinition()找出注入点并缓存,找注入点的流程为:
- 遍历当前类的所有的属性字段Field
- 查看字段上是否存在@Autowired、@Value、@Inject中的其中任意一个,存在则认为该字段是一个注入点
- 如果字段是static的,则不进行注入
- 获取@Autowired中的required属性的值
- 将字段信息构造成一个AutowiredFieldElement对象,作为一个注入点对象添加到currElements集合中。
- 遍历当前类的所有方法Method
- 判断当前Method是否是桥接方法,如果是找到原方法
- 查看方法上是否存在@Autowired、@Value、@Inject中的其中任意一个,存在则认为该方法是一个注入点
- 如果方法是static的,则不进行注入
- 获取@Autowired中的required属性的值
- 将方法信息构造成一个AutowiredMethodElement对象,作为一个注入点对象添加到currElements集合中。
- 遍历完当前类的字段和方法后,将遍历父类的,直到没有父类。
- 最后将currElements集合封装成一个InjectionMetadata对象,作为当前Bean对于的注入点集合对象,并缓存。
我们当时手写spring的时候,是怎么支持这个@Autowired注解的:获取所有的字段、找我们哪些字段加了Autowired,哪些set方法上面加了Autowired注解。
那既然这个方法先执行,那先执行是干嘛的,就是去找注入点,然后先存着。存到这个cache里面。第一次进来拿的肯定是空。然后根据当前的bean类去找注入点,注入点就是属性或者某个方法上面加了Autowired注解,那那个属性就是注入点。spring要给这个注入点要找值要赋值。
那么我们加入上面这个buildAutowiringMetadata,看看如何根据一个类找注入点的
先看第一点前面就有一个判断如果一个Bean的类型是String…那么根本不需要进行依赖注入。
我们下面先来看主要的流程,分为两步:第一步去遍历当前bean的所有字段,找注解
那怎么找呢?
把当前所有类的注解拿过来,然后看有没有这三个注解的某一个,如果有一个就可以了。
如果一个是static的话就不是注入点。因为只有把一个属性当作注入点了,才会给这个属性赋值。static是不会进行赋值的。为什么是这样呢?因为你这个属性是属于某一个类的,而不是属于具体的bean对象的。
我们再来看专门针对@Autowired注解的,@Autowired注解有一个属性required,默认书true。
因为required是要求一定要给这个属性赋一个值,但是spring想给这个属性赋值,但是找不到这个bean,没办法赋值就报错。如果要是false就没事了,因为这个时候赋值不是必要的。
遍历完字段就要遍历当前这个方法了。一样的思路,就去找当前这个方法有没有@Autowired、@Value、@Inject这些注解。然后如果你加了,就会判断这个方法是不是静态方法。如果参数为0,但是有那三个注解中的一个,spring还是会把他当成注入点的,然后封装为AutowiredMethodElement方法。
上面讲的这些是寻找注入点,其中在这个遍历方法中这个里面有一个桥接方法,
2.1 static的字段或方法为什么不支持
@Component
@Scope("prototype")
public class OrderService {
}
@Component
@Scope("prototype")
public class UserService {
@Autowired
private static OrderService orderService;
public void test() {
System.out.println("test123");
}
}
看上面代码,UserService和OrderService都是原型Bean,假设Spring支持static字段进行自动注入,那么现在调用两次
- UserService userService1 = context.getBean(“userService”)
- UserService userService2 = context.getBean(“userService”)
问此时,userService1的orderService值是什么?还是它自己注入的值吗?
答案是不是,一旦userService2 创建好了之后,static orderService字段的值就发生了修改了,从而出现bug。
2.2 桥接方法
我们随便写一个接口,然后定义一个泛型
public interface UserInterface<T> {
void setOrderService(T t);
}
实现这个接口
@Component
public class UserService implements UserInterface<OrderService> {
private OrderService orderService;
@Override
@Autowired
public void setOrderService(OrderService orderService) {
this.orderService = orderService;
}
public void test() {
System.out.println("test123");
}
}
UserService对应的字节码为:
// class version 52.0 (52)
// access flags 0x21
// signature Ljava/lang/Object;Lcom/zhouyu/service/UserInterface<Lcom/zhouyu/service/OrderService;>;
// declaration: com/zhouyu/service/UserService implements com.zhouyu.service.UserInterface<com.zhouyu.service.OrderService>
public class com/zhouyu/service/UserService implements com/zhouyu/service/UserInterface {
// compiled from: UserService.java
@Lorg/springframework/stereotype/Component;()
// access flags 0x2
private Lcom/zhouyu/service/OrderService; orderService
// access flags 0x1
public <init>()V
L0
LINENUMBER 12 L0
ALOAD 0
INVOKESPECIAL java/lang/Object.<init> ()V
RETURN
L1
LOCALVARIABLE this Lcom/zhouyu/service/UserService; L0 L1 0
MAXSTACK = 1
MAXLOCALS = 1
// access flags 0x1
public setOrderService(Lcom/zhouyu/service/OrderService;)V
@Lorg/springframework/beans/factory/annotation/Autowired;()
L0
LINENUMBER 19 L0
ALOAD 0
ALOAD 1
PUTFIELD com/zhouyu/service/UserService.orderService : Lcom/zhouyu/service/OrderService;
L1
LINENUMBER 20 L1
RETURN
L2
LOCALVARIABLE this Lcom/zhouyu/service/UserService; L0 L2 0
LOCALVARIABLE orderService Lcom/zhouyu/service/OrderService; L0 L2 1
MAXSTACK = 2
MAXLOCALS = 2
// access flags 0x1
public test()V
L0
LINENUMBER 23 L0
GETSTATIC java/lang/System.out : Ljava/io/PrintStream;
LDC "test123"
INVOKEVIRTUAL java/io/PrintStream.println (Ljava/lang/String;)V
L1
LINENUMBER 24 L1
RETURN
L2
LOCALVARIABLE this Lcom/zhouyu/service/UserService; L0 L2 0
MAXSTACK = 2
MAXLOCALS = 1
// access flags 0x1041
public synthetic bridge setOrderService(Ljava/lang/Object;)V
@Lorg/springframework/beans/factory/annotation/Autowired;()
L0
LINENUMBER 11 L0
ALOAD 0
ALOAD 1
CHECKCAST com/zhouyu/service/OrderService
INVOKEVIRTUAL com/zhouyu/service/UserService.setOrderService (Lcom/zhouyu/service/OrderService;)V
RETURN
L1
LOCALVARIABLE this Lcom/zhouyu/service/UserService; L0 L1 0
MAXSTACK = 2
MAXLOCALS = 2
}
可以看到在UserSerivce的字节码中有两个setOrderService方法:
- public setOrderService(Lcom/zhouyu/service/OrderService;)V
- public synthetic bridge setOrderService(Ljava/lang/Object;)V
并且都是存在@Autowired注解的。
所以在Spring中需要处理这种情况,当遍历到桥接方法时,得找到原方法。
什么时候这个类不需要找注入点呢?
如果一个bean的类型是string…那么根本不需要进行依赖注入。
那什么时候一个方法不需要找注入点呢?
如果开头是java.就不需要
3 注入点进行注入
找到注入点之后就会找到这个postProcessProperties这个方法。
之前在找注入点的时候,找到后都存在cache里面了,这个时候就叫而已拿出来了,把注入点拿出来给注入点进行注入。
现在就需要给属性进行赋值了。
把当前注入点所封装的这个字段找出来,找出来这个字段的对象。
下面:
开始会把这个set方法解析为属性描述器,会判断当前这个注入点的名字在不在这个pvs里面,如果在跳过,如果手动给这个orderService赋值,那么这个set方法我会不会执行了。
Spring在AutowiredAnnotationBeanPostProcessor的postProcessProperties()方法中,会遍历所找到的注入点依次进行注入。
3.1 字段注入
- 遍历所有的AutowiredFieldElement对象。
- 将对应的字段封装为DependencyDescriptor对象。
- 调用BeanFactory的resolveDependency()方法,传入DependencyDescriptor对象,进行依赖查找,找到当前字段所匹配的Bean对象。
- 将DependencyDescriptor对象和所找到的结果对象beanName封装成一个ShortcutDependencyDescriptor对象作为缓存,比如如果当前Bean是原型Bean,那么下次再来创建该Bean时,就可以直接拿缓存的结果对象beanName去BeanFactory中去那bean对象了,不用再次进行查找了
- 利用反射将结果对象赋值给字段。
3.2 Set方法注入
- 遍历所有的AutowiredMethodElement对象
- 遍历将对应的方法的参数,将每个参数封装成MethodParameter对象
- 将MethodParameter对象封装为DependencyDescriptor对象
- 调用BeanFactory的resolveDependency()方法,传入DependencyDescriptor对象,进行依赖查找,找到当前方法参数所匹配的Bean对象。
- 将DependencyDescriptor对象和所找到的结果对象beanName封装成一个ShortcutDependencyDescriptor对象作为缓存,比如如果当前Bean是原型Bean,那么下次再来创建该Bean时,就可以直接拿缓存的结果对象beanName去BeanFactory中去那bean对象了,不用再次进行查找了
- 利用反射将找到的所有结果对象传给当前方法,并执行。