4.0 Spring依赖注入
1、依赖注入方式
- 手动注入
- 自动注入
1.1 手动注入
在XML中定义Bean时,就是手动注入,因为是程序员手动给某个属性指定了值。
// 底层是通过Set方法注入
<bean name="userService" class="com.luban.service.UserService">
<property name="orderService" ref="orderService"/>
</bean>
// 底层是通过构造方法注入
<bean name="userService" class="com.luban.service.UserService">
<constructor‐arg index="0" ref="orderService"/>
</bean>
1.2 自动注入
1.2.1 XML的autowire自动注入
- byType
- byName
- constructor
- default (表示默认值)
- no (表示关闭Autowired)
// XML的autowire自动注入
// Spring会自动的给userService中所有的属性自动赋值,需要这个属性有对应的set方法
<bean id="userService" class="com.luban.service.UserService" autowire="byType"/>
在创建Bean的过程中,在填充属性时,Spring会去解析当前类,把当前类的所有方法都解析出来, Spring会去解析每个方法得到对应的PropertyDescriptor
对象,其中有几个属性:
- name:这个name并不是方法的名字,而是拿方法名字经过处理后的名字
- 如果方法名字以“get”开头,比如“getXXX”,那么name=XXX
- 如果方法名字以“is”开头,比如“isXXX”,那么name=XXX
- 如果方法名字以“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
- 如果找到多个,会报错。
而constructor 通过构造方法注入相对简单,方法中可以不写set方法了。spring由容器找到对应的Bean作为参数,通过实例化得到Bean并完成属性赋值(属性赋值得由程序员写)
构造方法注入相当于byType+byName。普通的set方法会根据Type找bean,找到多个会报错,constructor找到多个会根据参数名确定
@Autowired
注解相当于XML中的autowire属性的注解方式的替代,还具有更细粒度的控制
XML中的autowire控制的是整个bean的所有属性,
@Autowired
注解是直接写在某个属性、某个 set方法、某个构造方法上的。对应的可以控制那些属性想被自动注入,想用哪个构造方法。
总结:Xml的底层也就是Set方法注入,构造方法注入
1.2.2 @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对应的注入点集合 对象,并缓存
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");
}
}
// 假设Spring支持static字段进行自动注 入,那么现在调用两次
1. UserService userService1 = context.getBean("userService")
2. 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");
}
}
上述代码在字节码中存在两个setOrderService
方法,并且都是存在@Autowired注解的。
所以在Spring中需要处理这种情况,当遍历到桥接方法时,得找到原方法。
public setOrderService(Lcom/zhouyu/service/OrderService;)V
public synthetic bridge setOrderService(Ljava/lang/Object;)V
3、 注入点进行注入
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对象 了,不用再次进行查找了 - 利用反射将找到的所有结果对象传给当前方法,并执行
4、 核心实现
4.1 resolveDependency()
DefaultListableBeanFactory#resolveDependency()
传入一个依赖描述(DependencyDescriptor
),该方法会根据该依赖描述从 BeanFactory
中找出对应的唯一的一个Bean对象。
@Nullable
Object resolveDependency(DependencyDescriptor descriptor, @Nullable String requestingBeanName,
@Nullable Set<String> autowiredBeanNames, @Nullable TypeConverter typeConverter)
throws BeansException;
4.2 findAutowireCandidates()
根据类型找beanName的底层流程
对应执行流程图
根据类型找beanName
的底层流程
- 找出
BeanFactory
中类型为type的所有的Bean的名字,注意是名字,而不是Bean对象,因为我们可以根据BeanDefinition
就能判断和当前type是不是匹配,不用生成Bean对象 - 把
resolvableDependencies
中key为type的对象找出来并添加到result中 - 遍历根据type找出的
beanName
,判断当前beanName
对应的Bean是不是能够被自动注入 - 先判断
beanName
对应的BeanDefinition
中的autowireCandidate
属性,如果为false,表示不能用来进行自动注入,如果为true则继续进行判断 - 判断当前type是不是泛型,如果是泛型是会把容器中所有的
beanName
找出来的,如果是这种情 况,那么在这一步中就要获取到泛型的真正类型,然后进行匹配,如果当前beanName
和当前泛 型对应的真实类型匹配,那么则继续判断 - 如果当前
DependencyDescriptor
上存在@Qualifier注解,那么则要判断当前beanName
上是否定义了Qualifier,并且是否和当前DependencyDescriptor
上的Qualifier相等,相等则匹配 - 经过上述验证之后,当前
beanName
才能成为一个可注入的,添加到result中]
4.3 依赖注入之泛型注入的实现
首先在Java反射中,有一个Type接口,表示类型,具体分类为:
- raw types:也就是普通Class
- parameterized types:对应
ParameterizedType
接口,泛型类型 - array types:对应
GenericArrayType
,泛型数组 - type variables:对应
TypeVariable
接口,表示类型变量,也就是所定义的泛型,比如T、K - primitive types:基本类型,int、boolean
测试代码:
public class TypeTest<T> {
private int i;
private Integer it;
private int[] iarray;
private List list;
private List<String> slist;
private List<T> tlist;
private T t;
private T[] tarray;
public static void main(String[] args) throws NoSuchFieldException {
test(TypeTest.class.getDeclaredField("i"));
System.out.println("=======");
test(TypeTest.class.getDeclaredField("it"));
System.out.println("=======");
test(TypeTest.class.getDeclaredField("iarray"));
System.out.println("=======");
test(TypeTest.class.getDeclaredField("list"));
System.out.println("=======");
test(TypeTest.class.getDeclaredField("slist"));
System.out.println("=======");
test(TypeTest.class.getDeclaredField("tlist"));
System.out.println("=======");
test(TypeTest.class.getDeclaredField("t"));
System.out.println("=======");
test(TypeTest.class.getDeclaredField("tarray"));
}
public static void test(Field field) {
if (field.getType().isPrimitive()) {
System.out.println(field.getName() + "是基本数据类型");
} else {
System.out.println(field.getName() + "不是基本数据类型");
}
if (field.getGenericType() instanceof ParameterizedType) {
System.out.println(field.getName() + "是泛型类型");
} else {
System.out.println(field.getName() + "不是泛型类型");
}
if (field.getType().isArray()) {
System.out.println(field.getName() + "是普通数组");
} else {
System.out.println(field.getName() + "不是普通数组");
}
if (field.getGenericType() instanceof GenericArrayType) {
System.out.println(field.getName() + "是泛型数组");
} else {
System.out.println(field.getName() + "不是泛型数组");
}
if (field.getGenericType() instanceof TypeVariable) {
System.out.println(field.getName() + "是泛型变量");
} else {
System.out.println(field.getName() + "不是泛型变量");
}
}
}
Spring中,但注入点是一个泛型时,也是会进行处理的,比如:
@Component
public class UserService extends BaseService<OrderService, StockService> {
public void test() {
System.out.println(o);
}
}
public class BaseService<O, S> {
@Autowired
protected O o;
@Autowired
protected S s;
}
-
Spring扫描时发现
UserService
是一个Bean -
那就取出注入点,也就是
BaseService
中的两个属性o、s -
接下来需要按注入点类型进行注入,但是o和s都是泛型,所以Spring需要确定o和s的具体类型
-
因为当前正在创建的是
UserService
的Bean,所以可以通过userService.getClass().getGenericSuperclass().getTypeName()
获取到具体的泛型信息,比如com.zhouyu.service.BaseService
-
然后再拿到
UserService
的父类BaseService
的泛型变量:for (TypeVariable> typeParameter : userService.getClass().getSuperclass().getTypeParameters()){System._out_.println(typeParameter.getName());}
-
通过上面两段代码,就能知道,o对应的具体就是
OrderService
,s对应的具体类型就是StockService
-
然后再调用
oField.getGenericType()
就知道当前field使用的是哪个泛型,就能知道具体类型了
4.4 @Qualifier的使用
使用 @Autowired 注释进行自动注入时,Spring 容器中匹配的候选 Bean 数目必须有且仅有一个。当找不到一个匹配的 Bean 时,Spring 容器将抛BeanCreationException
异常,并指出必须至少拥有一个匹配的 Bean。
Spring 允许我们通过 @Qualifier 注释指定注入 Bean 的名称,这样歧义就消除了。
// 定义两个注解:
@Target({ElementType.TYPE, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier("random")
public @interface Random {}
@Target({ElementType.TYPE, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier("roundRobin")
public @interface RoundRobin {}
// 定义一个接口和两个实现类,表示负载均衡:
public interface LoadBalance {
String select();
}
@Component
@Random
public class RandomStrategy implements LoadBalance {
@Override
public String select() {
return null;
}
}
@Component
@RoundRobin
public class RoundRobinStrategy implements LoadBalance {
@Override
public String select() {
return null;
}
}
// 使用
@Component
public class UserService {
@Autowired
@RoundRobin
private LoadBalance loadBalance;
public void test() {
System.out.println(loadBalance);
}
}
4.5 @Resource
@Resource注解底层工作流程图
- 寻找@resource注入点
- 根据方法或者属性进行注入
- 判断BeanFacyory中是否存在注入点名字对应的Bean
- 不存在则拿取@Resource的name属性,还没有则先byType再byName查找
- 根据name或注入点名字(属性名字或方法参数名字)找Bean,找不到则报错