摘要:需要注意的是必須要使用版本為以上才支持屬性。與格式文件不同,正對不同的,無法在一個文件設置,官方采用命名形式為格式來達成一樣的效果。采用方式添加的是屬于額外激活的,也就是說覆蓋掉外部傳入的指定的。
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 時都有根元素
需要注意的是:必須要使用 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/wrcj12138a...
環境支持:
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/0i...
推薦閱讀如何優雅關閉 Spring Boot 應用
需要接口管理的你了解一下?
Java 之 Lombok 必知必會
Java 微服務新生代之 Nacos
掌握設計模式之適配器模式
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/75694.html
摘要:有了配置文件之后,啟動程序,我們首先可以看到日志輸入,由此可以看出程序讀取了的配置。首先,根據的全局查找功能,直接搜索這些詞出現的位置,進行定位,可以找到這個日志出現于方法之中。由于我們的配置文件在下,所以只要留意當為的程序執行情況即可。 前言 上文《一文掌握 Spring Boot Profiles》 是對 Spring Boot Profiles 的介紹和使用,因此本文將從源碼角度...
摘要:如何測試進入到項目目錄,此處以我本地目錄為主然后打開程序,不會在當前目錄打開的請自行百度,輸入打包完畢后進入到目錄中去,我們可以發現一個名為的包接著在打開程序,輸入。 SpringBoot 是為了簡化 Spring 應用的創建、運行、調試、部署等一系列問題而誕生的產物,自動裝配的特性讓我們可以更好的關注業務本身而不是外部的XML配置,我們只需遵循規范,引入相關的依賴就可以輕易的搭建出...
摘要:此時可以嘗試或命令打包,安裝包內的文件中占位符已被替換。整合原理項目中一般都會加上可以查看的文件,里面包含定義的值是這樣插件會將或文件中的替換為中對應的值。 在Maven和Spring中,都有profile這個概念。profile是用于區分各種環境的,例如開發環境、測試環境、正式環境等。Maven的profile用于在打包時根據指定環境替換不同環境的配置文件配置,如數據庫配置。Spri...
摘要:第二步在應用的配置文件中,增加環境配置第三步啟動應用,我們可以看到日志中打印了,加載的配置文件使用實現在中是用來對做集合管理的重要概念。深入思考上面我們分別利用配置管理功能中的幾個不同緯度來實現多環境的配置管理。 前情回顧: 《Spring Cloud Alibaba基礎教程:使用Nacos實現服務注冊與發現》 《Spring Cloud Alibaba基礎教程:支持的幾種服務消費方...
摘要:使用還是,根據個人喜好即可。如果錯誤頁面也需要使用模板引擎動態生成,那么放在下面的路徑。數據庫自動配置嵌入式數據庫如果類路徑中包含或的相應包,那么就會自動配置這些嵌入式數據庫的實例和數據源。 本文參考自Spring Boot文檔。 Spring Boot 簡介 Spring框架功能很強大,但是就算是一個很簡單的項目,我們也要配置很多東西。因此就有了Spring Boot框架,它的作用很...
閱讀 982·2021-11-23 09:51
閱讀 2695·2021-08-23 09:44
閱讀 656·2019-08-30 15:54
閱讀 1433·2019-08-30 13:53
閱讀 3101·2019-08-29 16:54
閱讀 2527·2019-08-29 16:26
閱讀 1186·2019-08-29 13:04
閱讀 2313·2019-08-26 13:50