我們在開發Spring Boot應用時,通常同一套程序會被應用和安裝到幾個不同的環境,比如:開發、測試、生產等。其中每個環境的數據庫地址、服務器端口等等配置都會不同,如果在為不同環境打包時都要頻繁修改配置文件的話,那必將是個非常繁瑣且容易發生錯誤的事。
對於多環境的配置,各種項目構建工具或是框架的基本思路是一致的,通過配置多份不同環境的配置文件,再通過打包命令指定需要打包的內容之后進行區分打包,Spring Boot也不例外,或者說更加簡單。
在Spring Boot中多環境配置文件名需要滿足application-{profile}.properties
的格式,其中{profile}
對應你的環境標識,比如:
- application-dev.properties:開發環境
- application-test.properties:測試環境
- application-prod.properties:生產環境
至於哪個具體的配置文件會被加載,需要在application.properties
文件中通過spring.profiles.active
屬性來設置,其值對應{profile}
值。
如:spring.profiles.active=test
就會加載application-test.properties
配置文件內容。
下面,以不同環境配置不同的服務端口為例,進行樣例實驗。
針對各環境新建不同的配置文件application-dev.properties
、application-test.properties
、application-prod.properties
在這三個文件均都設置不同的server.port
屬性,如:dev環境設置為8080,test環境設置為9090,prod環境設置為80
application.properties中設置spring.profiles.active=dev
,就是說默認以dev環境設置
測試不同配置的加載:
執行java -jar xxx.jar,可以觀察到服務端口被設置為8080,也就是默認的開發環境(dev)
執行java -jar xxx.jar --spring.profiles.active=test,可以觀察到服務端口被設置為9090,也就是測試環境的配置(test)
執行java -jar xxx.jar --spring.profiles.active=prod,可以觀察到服務端口被設置為80,也就是生產環境的配置(prod)
按照上面的實驗,可以如下總結多環境的配置思路:
application.properties中配置通用內容,並設置spring.profiles.active=dev,以開發環境為默認配置
application-{profile}.properties中配置各個環境不同的內容
通過命令行方式去激活不同環境的配置。
另外: 在yml配置文件中配置List<String> 的值,可以采用 -子項 的方式,如 :
spring.profiles.include:
- 子項1
- 子項2
- 子項3
也可以采用 逗號分隔元素列表的方式,如:
spring.profiles.include: 子項1,子項2,子項3