很多時候,我們項目在開發環境和生產環境的配置是不一樣的,例如,數據庫配置,在開發的時候,我們一般用測試數據庫,而在生產環境,我們要用生產數據庫,這時候,我們可以利用 profile 在不同的環境下配置用不同的配置文件或者不同的配置。
Spring Boot 允許你通過命名約定按照一定的格式 (application-{profile}.properties) 來定義多個配置文件,然后通過在 application.properties 通過 spring.profiles.active 來具體激活一個或者多個配置文件,如果沒有指定任何 profile 的配置文件,Spring Boot 默認會啟動 application-default.properties。
一、具體配置實現方法參考如下
- 在 application.properties 文件的同路徑下,創建不同的環境參數文件,命名格式為:application-{profile}.properties,其中 {profile} 對應環境標識。
如上圖所示,項目共配置了三個不同的環境,分別為:
- application-dev.properties:開發環境
- application-test.properties:測試環境
- application-prod.properties:生產環境
至于哪個具體的配置文件會被加載,需要在 application.properties 文件中通過 spring.profiles.active 屬性來設置,其值對應 {profile} 值。
-
修改 application.properties 文件內容,指定生效的環境,內容如下。
spring.profiles.active=dev
spring.profiles.active 取值可為 dev、prod、test。上述配置指定開發環境配置文件有效,即取 application-dev.properties 文件中的相關配置。
-
啟動時指定生效的 profiles 參數,啟動腳本示例如下所示。
nohup java -Xms3g -Xmx3g -Xmn1g -Xss256k -XX:+PrintGCDetails -XX:+PrintGCDateStamps -Xloggc:/logdisk/gclog/gctest.log -jar test-1.0-SNAPSHOT.jar --spring.profiles.active=prod >/dev/null 2>&1 &
二、配置文件(application.properties)所在目錄不同,加載優先級也不同
在 Spring Boot 源碼文件(spring-boot-2.1.3.RELEASE.jar)中,org.springframework.boot.context.config 包下的 ConfigFileApplicationListener 類中定義了默認配置文件和默認搜索路徑,也可以通過該類中的 setSearchLocations() 和 setSearchNames() 方法來設置其他的搜索位置或者設置其它配置文件名稱。
ConfigFileApplicationListener 是一個 ApplicationListener,也是一個 EnvironmentPostProcessor。作為 ApplicationListener,它監聽了事件 ApplicationEnvironmentPreparedEvent 和 ApplicationPreparedEvent。ApplicationEnvironmentPreparedEvent 事件發生時,它將 Spring Boot 內置配置的其他 EnvironmentPostProcessor 和自己放到一起,排序,然后應用到應用上下文環境對象上。該 EnvironmentPostProcessor 對應用上下文環境所做的操作就是讀取配置文件將它們添加到應用上下文環境中去。ConfigFileApplicationListener 類所在的包路徑如下圖所示。
ConfigFileApplicationListener 類部分源碼如下所示。
// Note the order is from least to most specific (last one wins)private static final String DEFAULT_SEARCH_LOCATIONS = "classpath:/,classpath:/config/,file:./,file:./config/";
缺省情況下,配置屬性會從以下路徑的 application.properties/yml 文件中讀取:
- classpath:/
- classpath:/config/
- file:./
- file:./config/
如注釋所言,上述配置文件優先級由低到高,重復的配置被高優先級覆蓋,不重復的配置互補。如下圖所示,application.properties 優先級從 1 到 4 遞減。
三、外部配置
Spring Boot 也可以采用外部配置文件來配置不同環境的屬性,具體可以參考官方文檔:https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-external-config。截取部分文檔內容如下,完整文檔可以閱讀官網。
文章參考:
- 7.springboot配置文件配置運行環境、放置位置
- https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-external-config
- Springboot內置ApplicationListener–ConfigFileApplicationListener