天天看點

非常小的一個東西,Spring依賴注入Bean類型的8種情況

作者:Java架構學習指南

今天來講一個可能看似沒有用但是實際又有點用的一個小東西,那就是@Autowired支援注入哪些Bean的類型。

為啥要講這個呢?

故事說起來可能就比較長了。

不過長話可以短說,僅僅就是突然想起來之前有一個妹子問過我這個問題!

非常小的一個東西,Spring依賴注入Bean類型的8種情況

1、普通對象

這沒什麼好說的,大家都這麼用的,比如需要用到UserService,直接@Autowired就可以了。

@Autowired
private UserService userService;           

2、Collection及其子接口

除了支援注入一個單一的對象之外,@Autowired還支援注入一個Collection對象。

比如說,現在有個消息通知的接口MessageNotifier。

這種接口一般都會有不同的實作,比如說通過郵件通知,或者app,短信等等,是以就有多種實作,此時如果需要注入MessageNotifier,就可以使用注入Collection的方式,比如

@Autowired
private List<MessageNotifier> messageNotifiers;           

不過這種方式有個規定,那就是注入的類型必須是Collection及其子接口,如果你直接注入一個ArrayList,那麼此時是不支援的。

非常小的一個東西,Spring依賴注入Bean類型的8種情況

3、數組

同理,@Autowired也實作了注入一個數組的功能。

@Autowired
private MessageNotifier[] messageNotifiers;           

代碼如下:

非常小的一個東西,Spring依賴注入Bean類型的8種情況

4、Map

同樣的,@Autowired還可以注入一個Map。

@Autowired
private Map<String, MessageNotifier> messageNotifierMap;           

此時注入的map,key的類型就是bean的名稱,這種方式可以配合政策模式使用。

不過,這種方式隻支援注入的是Map接口,不支援子類型接口,代碼如下。

非常小的一個東西,Spring依賴注入Bean類型的8種情況

5、@Lazy

當一個注入的字段加了@Lazy注解之後,那麼此時就代表這個字段是延遲注入。

@Autowired
@Lazy
private MessageNotifier messageNotifier;           

延遲注入并不是不注入,而是注入目标對象類型的代理對象,真正的目标是當需要用到的時候在建立。

非常小的一個東西,Spring依賴注入Bean類型的8種情況

如圖所示,當注入的MessageNotifier時加了@Lazy注解,那麼此時注入的其實是MessageNotifier的代理對象,而真正的MessageNotifier對象并沒有建立,圖中代理對象我稱為MessageNotifierProxy。

由于注入的是對象是代理對象MessageNotifierProxy,那麼真正被使用的就是MessageNotifierProxy,一旦調用了MessageNotifierProxy的方法,此時MessageNotifierProxy會去Spring容器中查找真正的MessageNotifier對象,然後再調用MessageNotifier對象的方法。

代碼如下:

非常小的一個東西,Spring依賴注入Bean類型的8種情況

這就是@Lazy延遲注入的原理。并不是不注入,而是注入一個代理對象,可以了解為一個占位符,一個空殼子,先占着位置,等用到這個殼子的時候,這個殼子會去查找到真正的對象,調用真正對象的方法。

@Lazy的一個使用場景就是用來解決Spring無法處理的循環依賴場景,比如使用了@Async注解的循環依賴的場景,不了解的小夥伴可以看一下 @Async注解的坑,小心 這篇文章

6、Optional

Optional是JDK1.8提供的一個api,可以優雅的解決判空的問題。

@Autowired也支援了注入Optional類型。

@Autowired
private Optional<MessageNotifier> messageNotifier;           

代碼如下:

非常小的一個東西,Spring依賴注入Bean類型的8種情況

注入Optional這種方式可以解決注入的對象不存在的導緻異常問題,也就是安全注入。

比如說,MessageNotifier這個對象Spring容器中并沒有,如果直接注入,此時會抛NoSuchBeanDefinitionException異常

非常小的一個東西,Spring依賴注入Bean類型的8種情況

而直接通過注入Optional的方式就可以解決這個問題。

除了通過Optional的方式之外,也可以直接把@Autowired的required的屬性設定為false來解決注入對象不存在的問題。

那Optional存在的作用是啥?

其實Optional的作用僅僅是不用寫為空的判斷,這也是Optional這個類的作用作用,除了這個,跟直接@Autowired對象并沒有其它差別。

注入Optional這種方式其實用的不多,在我的映像中,我在源碼中幾乎沒有看見這種注入方式。

7、ObjectFactory和ObjectProvider

ObjectFactory和ObjectProvider是Spring提供的兩接口

非常小的一個東西,Spring依賴注入Bean類型的8種情況

ObjectProvider繼承了ObjectFactory

非常小的一個東西,Spring依賴注入Bean類型的8種情況

@Autowired也可以直接注入這兩個接口。

@Autowired
private ObjectFactory<MessageNotifier> messageNotifierObjectFactory;

@Autowired
private ObjectProvider<MessageNotifier> messageNotifierObjectProvider;           

代碼如下:

非常小的一個東西,Spring依賴注入Bean類型的8種情況

從這段代碼也可以看出,最終注入的其實是DependencyObjectProvider實作。

ObjectFactory也是用來做延遲注入的操作,跟@Lazy作用差不多,但是實作原理不一樣。

用上面的例子來說,注入ObjectFactory的時候并有建立MessageNotifier對象。

當需要使用MessageNotifier的時候需要通過ObjectFactory的getObject方法擷取,此時才會真正建立MessageNotifier對象。

MessageNotifier messageNotifier = messageNotifierObjectFactory.getObject();           

是以@Async注解導緻的循環依賴異常不僅可以通過@Lazy注解解決,也可以通過注入ObjectFactory的方式解決。

同理,ObjectProvider也有延遲加載的功能,但是除了延遲加載之外,ObjectProvider額外提供了跟Optional安全注入的功能,這個功能ObjectFactory是沒有的。

上面的例子中,當使用ObjectFactory的getObject方法時,如果Spring容器中不存在MessageNotifier對象,此時也會抛NoSuchBeanDefinitionException異常。

但是ObjectProvider額外提供的getIfAvailable方法就支援擷取不存在的對象的功能,當通過getIfAvailable擷取的對象不存在時,隻會傳回null,并不會出抛異常。

非常小的一個東西,Spring依賴注入Bean類型的8種情況

ObjectFactory和ObjectProvider在架構内部中使用的還是比較多的。

就比如說,在MybatisPlus自動裝配的時候就大量使用ObjectProvider

非常小的一個東西,Spring依賴注入Bean類型的8種情況

并且泛型類型就是數組或者是集合,跟前面說的都對應上了。

通過這種方式就可以安全的注入,當Spring容器有這些對象的時候MybatisPlus就使用這些,沒有也不會報錯。

8、JSR-330 Provider

首先,來講一下什麼是JSR-330。

JSR是Java Specification Requests的縮寫,是一種Java标準規範。

而330算是一個版本,除了330,聽到的比較多的還有250。

這個規範定義了一些IOC的注解,我們熟知的比如@Resource、@PostConstruct、@PreDestroy注解都是JSR-250中提出的。

一些IOC的架構會基于這個标準來實作這些接口的功能,比如Spring、Dagger2等IOC架構都實作了這些注解的功能。

是以,如果你不使用Spring架構,使用其它的IOC架構,那麼@Resource、@PostConstruct、@PreDestroy注解都是可以生效的。

在JSR-330中,提出了javax.inject.Provider這個接口

非常小的一個東西,Spring依賴注入Bean類型的8種情況

不過,想使用JSR-330這個接口,需要引入依賴

<dependency>
    <groupId>javax.inject</groupId>
    <artifactId>javax.inject</artifactId>
    <version>1</version>
</dependency>           

Spring也支援注入這個類型的接口

非常小的一個東西,Spring依賴注入Bean類型的8種情況

這個接口的功能跟前面提到的ObjectFactory功能是一樣的,也支援延遲注入的功能。

總結

到這Spring能夠注入的Bean的8種類型就講完了,其實這8種類型可以分為以下幾種功能:

  • 單一注入,就是注入一個單一的對象
  • 集合注入,可以注入數組或者集合
  • 延遲注入,比如@Lazy、ObjectFactory、ObjectProvider、JSR-330 Provider
  • 安全注入,不存在不會抛異常,比如Optional、ObjectProvider

這幾種方式并不是互斥的,比如說延遲注入也可以注入的是一個集合,前面舉的MyBaisPlus自動裝配時ObjectProvider的使用就是很好的例子。

同時雖然本文舉例的是@Autowird注解和字段注入的方式,但上面提到的注入的Bean類型跟使用注解和注入方式沒什麼關系,@Resource注解,構造器注入,setter注入都是一樣的。