@ConfigurationProperties 註解使用姿勢，這一篇就夠了

2019 年 10 月 3 日
筆記

前言

在編寫項目程式碼時，我們要求更靈活的配置，更好的模組化整合。在 Spring Boot 項目中，為滿足以上要求，我們將大量的參數配置在 application.properties 或 application.yml 文件中，通過 @ConfigurationProperties 註解，我們可以方便的獲取這些參數值

使用 @ConfigurationProperties 配置模組

假設我們正在搭建一個發送郵件的模組。在本地測試，我們不想該模組真的發送郵件，所以我們需要一個參數來「開關」 disable 這個功能。另外，我們希望為這些郵件配置一個默認的主題，這樣，當我們查看郵件收件箱，通過郵件主題可以快速判斷出這是測試郵件

在 application.properties 文件中創建這些參數:

我們可以使用 @Value 註解或著使用 Spring Environment bean 訪問這些屬性，是這種注入配置方式有時顯得很笨重。我們將使用更安全的方式(@ConfigurationProperties )來獲取這些屬性

@ConfigurationProperties 的基本用法非常簡單:我們為每個要捕獲的外部屬性提供一個帶有欄位的類。請注意以下幾點:

前綴定義了哪些外部屬性將綁定到類的欄位上
根據 Spring Boot 寬鬆的綁定規則，類的屬性名稱必須與外部屬性的名稱匹配
我們可以簡單地用一個值初始化一個欄位來定義一個默認值
類本身可以是包私有的
類的欄位必須有公共 setter 方法

Spring 寬鬆綁定規則 (relaxed binding)

Spring使用一些寬鬆的綁定屬性規則。因此，以下變體都將綁定到 hostName 屬性上:

如果我們將 MailModuleProperties 類型的 bean 注入到另一個 bean 中，這個 bean 現在可以以類型安全的方式訪問那些外部配置參數的值。

但是，我們仍然需要讓 Spring 知道我們的 @ConfigurationProperties 類存在，以便將其載入到應用程式上下文中。

激活 @ConfigurationProperties

對於 Spring Boot，創建一個 MailModuleProperties 類型的 bean，我們可以通過下面幾種方式將其添加到應用上下文中

首先，我們可以通過添加 @Component 註解讓 Component Scan 掃描到

很顯然，只有當類所在的包被 Spring @ComponentScan 註解掃描到才會生效，默認情況下，該註解會掃描在主應用類下的所有包結構

我們也可以通過 Spring 的 Java Configuration 特性實現同樣的效果:

只要 MailModuleConfiguration 類被 Spring Boot 應用掃描到，我們就可以在應用上下文中訪問 MailModuleProperties bean

我們還可以使用 @EnableConfigurationProperties 註解讓我們的類被 Spring Boot 所知道，在該註解中其實是用了@Import(EnableConfigurationPropertiesImportSelector.class) 實現，大家可以看一下

激活一個 @ConfigurationProperties 類的最佳方式是什麼？

所有上述方法都同樣有效。然而，我建議模組化你的應用程式，並讓每個模組提供自己的@ConfigurationProperties 類，只提供它需要的屬性，就像我們在上面的程式碼中對郵件模組所做的那樣。這使得在不影響其他模組的情況下重構一個模組中的屬性變得容易。

因此，我不建議在應用程式類本身上使用 @EnableConfigurationProperties，如許多其他教程中所示，是在特定於模組的 @Configuration 類上使用@EnableConfigurationProperties，該類也可以利用包私有的可見性對應用程式的其餘部分隱藏屬性。

無法轉換的屬性

如果我們在 application.properties 屬性上定義的屬性不能被正確的解析會發生什麼？假如我們為原本應該為布爾值的屬性提供的值為 ‘foo’:

默認情況下，Spring Boot 將會啟動失敗，並拋出異常:

Failed to bind properties under 'myapp.mail.enabled' to java.lang.Boolean:        Property: myapp.mail.enabled      Value: foo      Origin: class path resource [application.properties]:1:20      Reason: failed to convert java.lang.String to java.lang.Boolean

當我們為屬性配置錯誤的值時，而又不希望 Spring Boot 應用啟動失敗，我們可以設置 ignoreInvalidFields 屬性為 true (默認為 false)

這樣，Spring Boot 將會設置 enabled 欄位為我們在 Java 程式碼里設定好的默認值。如果我們沒有設置默認值，enabled 將為 null，因為這裡定義的是 boolean 的包裝類 Boolean

未知的屬性

和上面的情況有些相反，如果我們在 application.properties 文件提供了 MailModuleProperties 類不知道的屬性會發生什麼？

默認情況下，Spring Boot 會忽略那些不能綁定到 @ConfigurationProperties 類欄位的屬性

然而，當配置文件中有一個屬性實際上沒有綁定到 @ConfigurationProperties 類時，我們可能希望啟動失敗。也許我們以前使用過這個配置屬性，但是它已經被刪除了，這種情況我們希望被觸發告知手動從 application.properties 刪除這個屬性

為了實現上述情況，我們僅需要將 ignoreUnknownFields 屬性設置為 false (默認是 true)

現在，應用啟動時，控制台會回饋我們異常資訊

Binding to target [Bindable@cf65451 type = com.example.configurationproperties.properties.MailModuleProperties, value = 'provided', annotations = array<Annotation>[@org.springframework.boot.context.properties.ConfigurationProperties(value=myapp.mail, prefix=myapp.mail, ignoreInvalidFields=false, ignoreUnknownFields=false)]] failed:        Property: myapp.mail.unknown-property      Value: foo      Origin: class path resource [application.properties]:3:29      Reason: The elements [myapp.mail.unknown-property] were left unbound.

棄用警告⚠️(Deprecation Warning)
ignoreUnknownFields 在未來 Spring Boot 的版本中會被標記為 deprecated，因為我們可能有兩個帶有 @ConfigurationProperties 的類，同時綁定到了同一個命名空間 (namespace) 上，其中一個類可能知道某個屬性，另一個類卻不知道某個屬性，這樣就會導致啟動失敗

啟動時校驗 @ConfigurationProperties

如果我們希望配置參數在傳入到應用中時有效的，我們可以通過在欄位上添加 bean validation 註解，同時在類上添加 @Validated 註解

如果我們忘記在 application.properties 文件設置 enabled 屬性，並且設置 defaultSubject 為空

應用啟動時，我們將會得到 BindValidationException

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'myapp.mail' to com.example.configurationproperties.properties.MailModuleProperties failed:        Property: myapp.mail.enabled      Value: null      Reason: must not be null        Property: myapp.mail.defaultSubject      Value: null      Reason: must not be empty

當然這些默認的驗證註解不能滿足你的驗證要求，我們也可以自定義註解

如果你的驗證邏輯很特殊，我們可以實現一個方法，並用 @PostConstruct 標記，如果驗證失敗，方法拋出異常即可。