一文掌握 Spring Boot Profiles

Spring Boot Profiles 簡介

Profile 的概念其實很早在 Spring Framework 就有了，在 Spring Framework 3.1 版本引入了註解 @Profile 和 Environment 環境配置的抽象，只是在 Spring Boot 框架裡再進一步將 Profiles 功能進行擴充套件，使它也成為了 Spring Boot 特性之一，為此單獨在官方文件 25. Profiles 一節裡介紹，文件裡把 Spring Boot Profiles 也叫做 Spring Profiles。

那麼什麼又是 Spring Profiles，為什麼需要它呢？我們先來看一個熟悉的場景：我們平常專案開發，經常需要根據不同的環境進行配置的修改，比如在本地開發會載入本機的配置和開發環境資料庫，在測試伺服器上部署時就需要載入測試環境配置和資料庫，同樣地，當專案釋出生產環境時就需要設定為生產環境配置和資料庫。這樣一來，不同的環境部署都需要額外的處理來調整環境的配置，維護起來十分繁瑣，還容易出錯。

為了解決不同環境需要的配置切換問題，Spring Profiles 提供了一種方式允許我們指定在特定環境下只加載對應的程式配置，每一種環境配置對應一個 Profile，只有當前 Profile 處於啟用狀態時，才會將該 Profile 所對應的配置和 Bean 載入到 Spring 程式中。

Spring Profiles 就是針對應用程式，不同環境需要不同配置載入的一種解決方案。

當然 Spring 允許多個 Profile 處於啟用狀態，比如將應用配置進行細分成資料庫配置，訊息中介軟體配置，快取配置等，都為各自在不同環境定義不同的 Profile 名稱，在需要啟用環境對應配置時，指定多個 Profile。

Spring Profiles 實戰

在 Spring 程式中有兩種方式使用 Profiles：XML 配置和註解 @Profile。

XML 配置定義 Profile

雖然現在 XML 配置方式使用越來越少，還是簡單介紹下，通常我們在 XML 檔案定義的 Bean 時都有根元素 <beans>，在 beans 元素上多了一個屬性 profile 可以指定環境，比如說把開發環境的 profile 定義為 dev,生產環境的 profile 為：prod。

需要注意的是：必須要使用 Spring XML Beans Schema 版本為 4.0 以上才支援 profile 屬性。在 XML 檔案定義之後我們只需要啟用指定的 Profile 名稱就可以載入對應的 Bean 物件了，在 Spring 程式中啟用的方式主要兩種：

Java API 方式，獲取當前 Spring 容器的環境 Bean，設定 activeProfiles 屬性，然後啟動容器
採用啟動引數方式指定，固定格式：-Dspring.profiles.active=dev

註解 @Profiles 定義Profile

使用註解定義 Profile 也比較簡單，引入一個新的註解 @Profiles，通常 @Profiles 配合 @Component 或者 @Configuration 使用，如下示例：

啟用 Profile 的方式都是一樣的，只要指定 Profile 被啟用，其對應的 Bean 才會載入。在 Spring 程式中 Profile 預設為 default，當前我們可以通過 spring.profiles.default 配置方式或者 org.springframework.core.env.AbstractEnvironment#setDefaultProfiles API 方式修改。

Spring Boot Profile 實戰

好了，現在我們再來看下在 Spring Boot 程式中如何使用 Profile。通常一個 Spring Boot 程式的配置檔案為 yml 或者 properties 格式，由於 yml 格式檔案的結構簡潔已讀，備受官方推崇，我們可以看下如何在 application.yml 定義 Profile 和對應的配置。

與yml格式檔案不同，正對不同的 Profile，無法在一個 properties 檔案設定，官方採用命名形式為 applications-${profile}.properties 格式來達成一樣的效果。為了看到指定 Profile 啟用後的效果，我們可以通過下方的一個例子實踐下，通過啟用不同 Profile 啟動程式，來請求 /enviroment 介面來獲取當前的環境配置變數。

這裡我們介紹如何在配置檔案中啟用 Profile 的方式：在 application.yml 頂部新增如下配置，表明當前所啟用的 Profile 為 prod，當然也可以前文介紹的啟動引數方式啟用：

然後啟動程式，curl 方式訪問 http://localhost:9000/enviroment 可以得到如下輸出結果：

同樣如果上述的 active 屬性值指定為 dev，將輸出內容： current app enviroment is prod。

Spring Boot API 方式啟用 Profile

在 Spring Boot 程式除了上述的方法來啟用 Profile 外，還可以使用 Spring Boot API 方式啟用：

SpringApplication.setAdditionalProfiles(…)
SpringApplicationBuilder.profiles(...)

但需要注意的是使用 Spring Boot API 的話需要在程式啟動前設定，也就是 SpringApplication.run(...) 方法執行前，否則沒有效果。採用 Spring Boot API 方式新增的Profile 是屬於額外啟用的 Profile，也就是說覆蓋掉外部傳入的 spring.profiles.activie 指定的 Profile。

總結

在Spring Boot 程式中，我們通常定義不同 Profiles 的配置檔案，如 application-{profile}.properties，在預設配置檔案 application.properties 中設定 spring.profiles.active=dev ，用於平常開發使用，當需要打包上傳伺服器時，通過啟動引數方式 jar -Dspring.profiles.active=prod xxx.jar 指定對應環境的 Profile 啟動程式來載入對應環境的配置，到這裡我們學習如何通過 Spring Boot Profiles 特性來應對程式中不同環境配置的切換，希望對工作中的小夥伴有所幫助，也歡迎小夥伴留言分享應對專案環境配置區分載入的實踐心得。若有錯誤或者不當之處，還請大家批評指正，一起學習交流。

下篇文章將通過解讀原始碼的方式具體講解 Spring Boot Profiles 實現原理，敬請關注期待。

示例程式碼

本文示例程式碼可以通過下面倉庫地址獲取：

springboot-actions-profiles：https://github.com/wrcj12138aaa/springboot-actions-profiles

環境支援：

JDK 8
SpringBoot 2.1.6
Maven 3.6.0

參考資料

How to use profiles in Spring Boot Application：http://1t.click/yUj
Spring Boot Doc：http://1t.click/yUh
Spring Doc：http://1t.click/yUg
全面解讀 Spring Profile 的用法：https://mp.weixin.qq.com/s/0iWpGefYPqnkly4EmaPAug

一文掌握 Spring Boot Profiles

Spring Boot Profiles 簡介