這幾個關於Spring 依賴注入的問題你清楚嗎？

JAVA一方發表於2020-02-11
Spring依賴注入

前言

本章的內容主要是想探討我們在進行Spring 開發過程當中，關於依賴注入的幾個知識點。感興趣的讀者可以先看下以下問題：

  • @Autowired, @Resource, @Inject 三個註解的區別
  • 當你在使用@Autowired時，是否有出現過Field injection is not recommended的警告？你知道這是為什麼嗎？
  • Spring 依賴注入有哪幾種方式？官方是怎麼建議使用的呢？

如果你對上述問題都瞭解，那我個人覺得你的開發經驗應該是不錯的?。

下面我們就依次對上述問題進行解答，並且總結知識點。

@Autowired, @Resource, @Inject 三個註解的區別

Spring 支援使用@Autowired, @Resource, @Inject 三個註解進行依賴注入。下面來介紹一下這三個註解有什麼區別。

@Autowired

@Autowired為Spring 框架提供的註解，需要匯入包org.springframework.beans.factory.annotation.Autowired。

這裡先給出一個示例程式碼，方便講解說明：

public interface Svc {

    void sayHello();
}

@Service
public class SvcA implements Svc {

    @Override
    public void sayHello() {
        System.out.println("hello, this is service A");
    }

}

@Service
public class SvcB implements Svc {

    @Override
    public void sayHello() {
        System.out.println("hello, this is service B");
    }

}

@Service
public class SvcC implements Svc {

    @Override
    public void sayHello() {
        System.out.println("hello, this is service C");
    }
}複製程式碼

測試類：

@SpringBootTest
public class SimpleTest {

    @Autowired
    // @Qualifier("svcA")
    Svc svc;

    @Test
    void rc() {
        Assertions.assertNotNull(svc);
        svc.sayHello();
    }

}複製程式碼

裝配順序：

  1. 按照type在上下文中查詢匹配的bean

    查詢type為Svc的bean複製程式碼

  2. 如果有多個bean，則按照name進行匹配

    1. 如果有@Qualifier註解，則按照@Qualifier指定的name進行匹配

      查詢name為svcA的bean複製程式碼

    2. 如果沒有，則按照變數名進行匹配

      查詢name為svc的bean複製程式碼
  3. 匹配不到，則報錯。（@Autowired(required=false)，如果設定required為false(預設為true)，則注入失敗時不會丟擲異常）

@Inject

在Spring 的環境下，@Inject 和@Autowired 是相同的，因為它們的依賴注入都是使用AutowiredAnnotationBeanPostProcessor來處理的。

@Inject是 JSR-330 定義的規範，如果使用這種方式，切換到Guice也是可以的。

Guice 是 google 開源的輕量級 DI 框架

如果硬要說兩個的區別，首先@Inject是Java EE包裡的，在SE環境需要單獨引入。另一個區別在於@Autowired可以設定required=false而@Inject並沒有這個屬性。

@Resource

@Resource是JSR-250定義的註解。Spring 在 CommonAnnotationBeanPostProcessor實現了對JSR-250的註解的處理，其中就包括@Resource。

@Resource有兩個重要的屬性：name和type，而Spring 將@Resource註解的name屬性解析為bean的名字，而type屬性則解析為bean的型別。

裝配順序：

  1. 如果同時指定了name和type，則從Spring上下文中找到唯一匹配的bean進行裝配，找不到則丟擲異常。
  2. 如果指定了name，則從上下文中查詢名稱（id）匹配的bean進行裝配，找不到則丟擲異常。
  3. 如果指定了type，則從上下文中找到型別匹配的唯一bean進行裝配，找不到或是找到多個，都會丟擲異常。
  4. 如果既沒有指定name，又沒有指定type，則預設按照byName方式進行裝配；如果沒有匹配，按照byType進行裝配。

如果你也在學習，在入門學習的過程當中有遇見學習，行業方面的問題，或者說缺乏系統的學習路線和系統學習視訊，你可以加入我的 學習交流群：874811168，裡面有我根據今年市場技術棧要求錄製的Java精講視訊教程，群檔案裡面有我這幾年整理的學習手冊，面試題，開發工具，PDF文件書籍，你都可以自行去下載：https://shimo.im/docs/VqQR6tPrpR3C3tjq/ 

IDEA 提示 Field injection is not recommended

在使用IDEA 進行Spring 開發的時候，當你在欄位上面使用@Autowired註解的時候，你會發現IDEA 會有警告提示：

Field injection is not recommended

Inspection info: Spring Team Recommends: "Always use constructor based dependency injection in your beans. Always use assertions for mandatory dependencies".

翻譯過來就是這個意思：

不建議使用基於 field 的注入方式。

Spring 開發團隊建議：在你的Spring Bean 永遠使用基於constructor 的方式進行依賴注入。對於必須的依賴，永遠使用斷言來確認。

比如如下程式碼：

@Service
public class HelpService {
    @Autowired
    @Qualifier("svcB")
    private Svc svc;

    public void sayHello() {
        svc.sayHello();
    }
}

public interface Svc {
    void sayHello();
}

@Service
public class SvcB implements Svc {
    @Override
    public void sayHello() {
        System.out.println("hello, this is service B");
    }
}複製程式碼

將游標放到@Autowired處，使用Alt + Enter 快捷進行修改之後，程式碼就會變成基於Constructor的注入方式，修改之後：

@Service
public class HelpService {
    private final Svc svc;
    
    @Autowired
    public HelpService(@Qualifier("svcB") Svc svc) {
        // Assert.notNull(svc, "svc must not be null");
        this.svc = svc;
    }
    
    public void sayHello() {
        svc.sayHello();
    }
}複製程式碼

如果按照Spring 團隊的建議，如果svc是必須的依賴，應該使用Assert.notNull(svc, "svc must not be null")來確認。

修正這個警告提示固然簡單，但是我覺得更重要是去理解為什麼Spring 團隊會提出這樣的建議？直接使用這種基於 field 的注入方式有什麼問題？

首先我們需要知道，Spring 中有這麼3種依賴注入的方式：

  • 基於 field 注入（屬性注入）
  • 基於 setter 注入
  • 基於 constructor 注入（構造器注入）

1. 基於 field 注入

所謂基於 field 注入，就是在bean的變數上使用註解進行依賴注入。本質上是通過反射的方式直接注入到field。這是我平常開發中看的最多也是最熟悉的一種方式，同時，也正是 Spring 團隊所不推薦的方式。比如：

@Autowired
private Svc svc;複製程式碼

2. 基於 setter 方法注入

通過對應變數的setXXX()方法以及在方法上面使用註解，來完成依賴注入。比如：

private Helper helper;

@Autowired
public void setHelper(Helper helper) {
    this.helper = helper;
}複製程式碼
注：在 Spring 4.3 及以後的版本中，setter 上面的 @Autowired 註解是可以不寫的。

3. 基於 constructor 注入

將各個必需的依賴全部放在帶有註解構造方法的引數中，並在構造方法中完成對應變數的初始化，這種方式，就是基於構造方法的注入。比如：

private final Svc svc;
    
@Autowired
public HelpService(@Qualifier("svcB") Svc svc) {
    this.svc = svc;
}複製程式碼
在 Spring 4.3 及以後的版本中，如果這個類只有一個構造方法，那麼這個構造方法上面也可以不寫 @Autowired 註解。

基於 field 注入的好處

正如你所見，這種方式非常的簡潔，程式碼看起來很簡單，通俗易懂。你的類可以專注於業務而不被依賴注入所汙染。你只需要把@Autowired扔到變數之上就好了，不需要特殊的構造器或者set方法，依賴注入容器會提供你所需的依賴。

基於 field 注入的壞處

成也蕭何敗也蕭何

基於 field 注入雖然簡單，但是卻會引發很多的問題。這些問題在我平常開發閱讀專案程式碼的時候就經常遇見。

  • 容易違背了單一職責原則
    使用這種基於 field 注入的方式，新增依賴是很簡單的，就算你的類中有十幾個依賴你可能都覺得沒有什麼問題，普通的開發者很可能會無意識地給一個類新增很多的依賴。但是當使用構造器方式注入，到了某個特定的點，構造器中的引數變得太多以至於很明顯地發現something is wrong。擁有太多的依賴通常意味著你的類要承擔更多的責任，明顯違背了單一職責原則（SRP：Single responsibility principle）。

    這個問題在我司的專案程式碼真的很常見。

  • 依賴注入與容器本身耦合

    依賴注入框架的核心思想之一就是受容器管理的類不應該去依賴容器所使用的依賴。換句話說，這個類應該是一個簡單的POJO(Plain Ordinary Java Object)能夠被單獨例項化並且你也能為它提供它所需的依賴。

    這個問題具體可以表現在：

    • 你的類和依賴容器強耦合，不能在容器外使用
    • 你的類不能繞過反射（例如單元測試的時候）進行例項化，必須通過依賴容器才能例項化，這更像是整合測試
  • 不能使用屬性注入的方式構建不可變物件(final 修飾的變數)

Spring 開發團隊的建議

Since you can mix constructor-based and setter-based DI, it is a good rule of thumb to use constructors for mandatory dependencies and setter methods or configuration methods for optional dependencies.

簡單來說，就是

  • 強制依賴就用構造器方式
  • 可選、可變的依賴就用setter 注入

    當然你可以在同一個類中使用這兩種方法。構造器注入更適合強制性的注入旨在不變性，Setter注入更適合可變性的注入。

讓我們看看Spring 這樣推薦的理由，首先是基於構造方法注入，

The Spring team generally advocates constructor injection as it enables one to implement application components as immutable objects and to ensure that required dependencies are not null. Furthermore constructor-injected components are always returned to client (calling) code in a fully initialized state. As a side note, a large number of constructor arguments is a bad code smell, implying that the class likely has too many responsibilities and should be refactored to better address proper separation of concerns.

Spring 團隊提倡使用基於構造方法的注入，因為這樣一方面可以將依賴注入到一個不可變的變數中 (注：final 修飾的變數)，另一方面也可以保證這些變數的值不會是 null。此外，經過構造方法完成依賴注入的元件 (注：比如各個 service)，在被呼叫時可以保證它們都完全準備好了。與此同時，從程式碼質量的角度來看，一個巨大的構造方法通常代表著出現了程式碼異味，這個類可能承擔了過多的責任。

而對於基於 setter 的注入，他們是這麼說的：

Setter injection should primarily only be used for optional dependencies that can be assigned reasonable default values within the class. Otherwise, not-null checks must be performed everywhere the code uses the dependency. One benefit of setter injection is that setter methods make objects of that class amenable to reconfiguration or re-injection later.

基於 setter 的注入，則只應該被用於注入非必需的依賴，同時在類中應該對這個依賴提供一個合理的預設值。如果使用 setter 注入必需的依賴，那麼將會有過多的 null 檢查充斥在程式碼中。使用 setter 注入的一個優點是，這個依賴可以很方便的被改變或者重新注入。

小結

以上就是本文的所有內容，希望閱讀本文之後能讓你對Spring 的依賴注入有更深的理解。

如果本文有幫助到你，希望能點個贊，這是對我的最大動力


相關文章