背景
很多時候,我們項目在開發環境和生成環境的環境配置是不一樣的,例如,數據庫配置,在開發的時候,我們一般用測試數據庫,而在生產環境的時候,我們是用正式的數據,這時候,我們可以利用profile在不同的環境下配置用不同的配置文件或者不同的配置。
spring boot 提供
spring boot允許你通過命名約定按照一定的格式(application-{profile}.properties)來定義多個配置文件,然后通過在application.properyies通過spring.profiles.active來具體激活一個或者多個配置文件,如果沒有沒有指定任何profile的配置文件的話,spring boot默認會啟動application-default.properties。
profile的配置文件可以按照application.properyies的放置位置一樣,放於以下四個位置:
- 當前目錄的 “/config”的子目錄下
- 當前目錄下
- classpath根目錄的“/config”包下
- classpath的根目錄下
demo 演示
在這里我們就定義倆個profile文件,
application-sit.properties和application-prd.properties,
並在倆個文件中都分別
寫上變量

和

這個是配置文件

我們在application.properyies也寫上,並把profile切換到application-sit.properties的配置文件

可以通過這樣子來測試

在瀏覽器中輸入:http://localhost:8889/task/ 或者http://localhost:8889/task
出現如下返回內容

在這里可以看到spring.profiles.active激活的profile不同,打印出來的結果也不一樣。
除了可以用profile的配置文件來分區配置我們的環境變量,在代碼里,我們還可以直接用@Profile注解來進行配置,例如數據庫配置,這里我們先定義一個接口

分別定義倆個實現類來實現它


通過在配置文件激活具體使用哪個實現類

然后就可以這么使用

再次在瀏覽器中輸入
localhost:8889/task/

查看后台日志:

說明生效。
注意到,此時之前配置的property文件失效了,采用了默認的application.properties中配置的值。同時也看到,相同的屬性只能配置一條。
相同的屬性不可以重復

所以:
除了spring.profiles.active來激活一個或者多個profile之外,還可以用spring.profiles.include來疊加profile
例如,剛剛我想讓java中配置的,以及properties中配置的都生效為prd環境,
那么 application.properties內容為:

再次 在瀏覽器中輸入 localhost:8889/task/

后台日志:

以上就是spring boot用profile的作用。
以下為可選(主要是命令行使用):
通過命令行設置屬性值
相信使用過一段時間Spring Boot的用戶,一定知道這條命令:java -jar xxx.jar --server.port=8888,通過使用–server.port屬性來設置xxx.jar應用的端口為8888。
在命令行運行時,連續的兩個減號–就是對application.properties中的屬性值進行賦值的標識。所以,java -jar xxx.jar --server.port=8888命令,等價於我們在application.properties中添加屬性server.port=8888,該設置在樣例工程中可見,讀者可通過刪除該值或使用命令行來設置該值來驗證。
通過命令行來修改屬性值固然提供了不錯的便利性,但是通過命令行就能更改應用運行的參數,那豈不是很不安全?是的,所以Spring Boot也貼心的提供了屏蔽命令行訪問屬性的設置,只需要這句設置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)。
多環境配置
以上都不是重點,這才是重點,這才是重點,這才是重點,重要的事情說3遍。我們在開發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配置文件內容
下面,以不同環境配置不同的服務端口為例,進行樣例實驗。
測試不同配置的加載:
執行java -jar xxx.jar,可以觀察到服務端口被設置為8080,也就是默認的開發環境(dev)

按照上面的實驗,可以如下總結多環境的配置思路:
application.properties中配置通用內容,並設置spring.profiles.active=dev,以開發環境為默認配置
application-{profile}.properties中配置各個環境不同的內容
通過命令行方式去激活不同環境的配置。
多環境高級應用
在某些情況下,應用的某些業務邏輯可能需要有不同的實現。例如郵件服務,假設EmailService中包含的send(String email)方法向指定地址發送電子郵件,但是我們僅僅希望在生產環境中才執行真正發送郵件的代碼,而開發環境里則不發送以免向用戶發送無意義的垃圾郵件。
我們可以借助Spring的注解@Profile實現這樣的功能,這樣需要定義兩個實現EmailService借口的類:
發送郵件的具體實現(prod-生產環境的代碼):

Profile(“dev”)表明只有Spring定義的Profile為dev時才會實例化DevEmailService這個類。那么如何設置Profile呢?
在application.properties中加入:

