Spring Boot 載入外部配置檔案
Spring Boot 允許你從外部載入配置,這樣的話,就可以在不同的環境中使用相同的程式碼。支援的外部配置源包括:Java屬性檔案、YAML檔案、環境變數、命令列引數。
用@Value註解可以將屬性值直接注入到beans中。命令列引數以 -- 開頭
配置檔案載入的順序如下:
- Application properties packaged inside your jar (application.properties and YAML variants)
- Profile-specific application properties packaged inside your jar (application-{profile}.properties
- Application properties outside of your packaged jar (application.properties and YAML variants)
- Profile-specific application properties outside of your packaged jar (application-{profile}.properties and YAML variants)
應用程式啟動的時候,Spring Boot 會自動從以下位置查詢並載入 application.properties 和 application.yaml
- The classpath root
- The classpath /config package
- The current directory
- The /config subdirectory in the current directory
- Immediate child directories of the /config subdirectory
查詢順序按優先順序來,後面的可以覆蓋前面的。檔案中的每一項會作為PropertySources被新增到Spring Environment
如果你不想用"application"作為配置檔名稱,可以在環境屬性中通過spring.config.name
注意,spring.config.name 和 spring.config.location 必須定義為一個環境屬性(通常是一個OS環境變數、一個系統屬性或一個命令列引數)
如果 spring.config.location 指定的是一個目錄,那麼必須以 / 結尾
無論直接指定檔案還是包含在目錄中,配置檔案必須在其名稱中包含副檔名。通常,副檔名支援 .properties, .yaml, .yml
舉個栗子
指定單個檔案
$ java -jar myproject.jar --spring.config.name=myproject
指定多個位置
$ java -jar myproject.jar --spring.config.location=optional:classpath:/default.properties,optional:classpath:/override.properties
預設情況下,如果指定的位置不存在,則會報錯。如果你不確定它是否存在,使用使用 optional: 字首
例如:
optional:classpath:/custom-config/,optional:file:./custom-config/
Profile Specific Files
Spring Boot 會嘗試載入按照命名規約 application-{profile} 的檔案,我們把這樣的檔案稱為Profile-specific檔案。
例如,如果你激活了一個名稱為prod的profile,並且使用YAML檔案,那麼application.yml 和 application-prod.yml 都會被嘗試載入。
Profile-specific檔案必須要和application.properties在相同的位置,而且profile-specific檔案中的配置項會覆蓋非profile-specific檔案中相同的配置項。如果有多個profile-specific檔案被啟用,則後面會覆蓋前面的。
舉個例子,假設spring.profiles.active=prod,live,那麼application-prod.properties中的配置項會被application-live.properties中的同名配置項覆蓋。如果沒有明確指定啟用哪個profile,則application-default會被考慮啟用。
YAML 檔案
考慮下面的配置檔案
hello: world: "hehe" my: roles: - "admin" - "guest"
轉換成properties檔案應該是:
hello.world=hehe my.roles[0]=admin my.roles[1]=guest
Spring Framework提供了兩個方便的類,可以用來載入YAML文件。YamlPropertiesFactoryBean 將 YAML 作為 Properties 載入,而 YamlMapFactoryBean 將 YAML 作為一個 Map 載入。
可以用@Value註解將屬性值注入到bean中
@Value("${hello.world}") private String wahaha; @Value("${my.roles[1]}") private String roles1;
劃重點
1、支援四種外部配置源:Java屬性檔案、YAML檔案、環境變數、命令列引數;
2、配置檔案查詢位置,依次為:
(1) classpath 根路徑
(2) classpath 根路徑下config目錄
(3) jar包當前目錄
(4) jar包當前目錄的config目錄
(5) /config子目錄的直接子目錄
3、配置檔案載入順序:
(1) 當前jar包內部的application.properties和application.yml
(2) 當前jar包內部的application-{profile}.properties 和 application-{profile}.yml
(3) 引用的外部jar包的application.properties和application.yml
(2) 引用的外部jar包的application-{profile}.properties 和 application-{profile}.yml
4、後面的可以覆蓋前面的同名配置項