Spring中到底有幾種依賴注入的方式?
首先分兩種:
- 手動注入
- 自動注入
手動注入
在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方法注入
- 構造方法注入
自動注入
自動注入又分爲兩種:
- XML的autowire自動注入
- @Autowired註解的自動注入
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並不是方法的名字,而是拿方法名字進過處理後的名字
- 如果方法名字以“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方法的定義是:
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,而也可以直接在<beans>標籤中設置autowire,如果設置了,那麼<bean>標籤中設置的autowire如果爲default,那麼則會用<beans>標籤中設置的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方法注入
- 構造方法注入
@Autowired註解的自動注入
上文說了@Autowired註解,是byType和byName的結合。
@Autowired註解可以寫在:
- 屬性上:先根據屬性類型去找Bean,如果找到多個再根據屬性名確定一個
- 構造方法上:先根據方法參數類型去找Bean,如果找到多個再根據參數名確定一個
- set方法上:先根據方法參數類型去找Bean,如果找到多個再根據參數名確定一個
而這種底層到了:
- 屬性注入
- set方法注入
- 構造方法注入
尋找注入點
在創建一個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對於的注入點集合對象,並緩存。
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。
橋接方法
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中需要處理這種情況,當遍歷到橋接方法時,得找到原方法。
注入點進行注入
Spring在AutowiredAnnotationBeanPostProcessor的postProcessProperties()方法中,會遍歷所找到的注入點依次進行注入。
字段注入
- 遍歷所有的AutowiredFieldElement對象。
- 將對應的字段封裝爲DependencyDescriptor對象。
- 調用BeanFactory的resolveDependency()方法,傳入DependencyDescriptor對象,進行依賴查找,找到當前字段所匹配的Bean對象。
- 將DependencyDescriptor對象和所找到的結果對象beanName封裝成一個ShortcutDependencyDescriptor對象作爲緩存,比如如果當前Bean是原型Bean,那麼下次再來創建該Bean時,就可以直接拿緩存的結果對象beanName去BeanFactory中去那bean對象了,不用再次進行查找了
- 利用反射將結果對象賦值給字段。
Set方法注入
- 遍歷所有的AutowiredMethodElement對象
- 遍歷將對應的方法的參數,將每個參數封裝成MethodParameter對象
- 將MethodParameter對象封裝爲DependencyDescriptor對象
- 調用BeanFactory的resolveDependency()方法,傳入DependencyDescriptor對象,進行依賴查找,找到當前方法參數所匹配的Bean對象。
- 將DependencyDescriptor對象和所找到的結果對象beanName封裝成一個ShortcutDependencyDescriptor對象作爲緩存,比如如果當前Bean是原型Bean,那麼下次再來創建該Bean時,就可以直接拿緩存的結果對象beanName去BeanFactory中去那bean對象了,不用再次進行查找了
- 利用反射將找到的所有結果對象傳給當前方法,並執行。
上面的內容我們講了Spring中的自動注入(byName,byType)和@Autowired註解的工作原理以及源碼分析,下面我們繼續看剩下的核心的方法:
@Nullable Object resolveDependency(DependencyDescriptor descriptor, @Nullable String requestingBeanName, @Nullable Set<String> autowiredBeanNames, @Nullable TypeConverter typeConverter) throws BeansException;
該方法表示,傳入一個依賴描述(DependencyDescriptor),該方法會根據該依賴描述從BeanFactory中找出對應的唯一的一個Bean對象。
下面來分析一下DefaultListableBeanFactory中resolveDependency()方法的具體實現,具體流程圖:
https://www.processon.com/view/link/5f8d3c895653bb06ef076688
findAutowireCandidates()實現
根據類型找beanName的底層流程:https://www.processon.com/view/link/6135bb430e3e7412ecd5d1f2
對應執行流程圖爲:https://www.processon.com/view/link/5f8fdfa8e401fd06fd984f20
- 找出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中
關於依賴注入中泛型注入的實現
首先在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<com.zhouyu.service.OrderService, com.zhouyu.service.StockService>
- 然後再拿到UserService的父類BaseService的泛型變量:
for (TypeVariable<? extends Class<?>> typeParameter : userService.getClass().getSuperclass().getTypeParameters()) {
System.out.println(typeParameter.getName());
} - 通過上面兩段代碼,就能知道,o對應的具體就是OrderService,s對應的具體類型就是StockService
- 然後再調用
oField.getGenericType()
就知道當前field使用的是哪個泛型,就能知道具體類型了
@Qualifier的使用
定義兩個註解:
@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); } }
@Resource
@Resource註解底層工作流程圖:
https://www.processon.com/view/link/5f91275f07912906db381f6e
本系列文章來自圖靈學院周瑜老師分享,本博客整理並搬運