一文掌握 Spring Boot Profiles

来源:https://www.cnblogs.com/one12138/archive/2019/07/30/11273031.html
-Advertisement-
Play Games

Spring Boot Profiles 簡介 Profile 的概念其實很早在 Spring Framework 就有了,在 Spring Framework 3.1 版本引入了註解 和 環境配置的抽象,只是在 Spring Boot 框架里再進一步將 Profiles 功能進行擴展,使它也成為了 ...


Spring Boot Profiles 簡介

Profile 的概念其實很早在 Spring Framework 就有了,在 Spring Framework 3.1 版本引入了註解 @ProfileEnvironment 環境配置的抽象,只是在 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

推薦閱讀


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • SpringBoot讀取配置值的方式 方法一: @Value註解的方式取值 設定appliction.properties的配置信息 使用@Value取值 頁面展示 小明==》性別:boy 年齡:18 分數:98 方法二: 使用@ConfigurationProperties賦值給實體類 設定app ...
  • 一、Eureka基本架構 1、Eureka角色結構圖 角色職責如下: 1)、Register:服務註冊中心,它是一個Eureka Server ,提供服務註冊和發現功能。 2)、Provider:服務提供者,它是一個Eureka Client ,提供服務。 3)、Consumer:服務消費者,它是一 ...
  • 前言 前言 這篇文章的ArrayList源碼是基於jdk1.8版本的源碼,如果與前後版本的實現細節出現不一致的地方請自己多加註意。先上一個它的結構圖 ArrayList作為一個集合工具,對於我而言它值得我們註意的地方有: 那麼我就由這四個細節對ArrayList進行分析。 ArrayList的參數細 ...
  • C++ 基礎中的基礎 引用 引用的概念:引用變數是一個別名,也就是說,它是某個已存在變數的另一個名字。一旦把引用初始化為某個變數,就可以使用該引用名稱或變數名稱來指向變數。比如: 好,現在,我們定義了一個引用。並將其初始化為某個變數。這時,r就成了n的一個別名。你對r進行操作就相當於對n本尊進行操作 ...
  • 操作系統 : CentOS7.5.1804_x64 Python 版本 : 3.6.8 1、使用pip線上安裝 1.1 安裝單個package 格式如下: 示例如下: 1.2 安裝多個package 示例如下: req.txt 可以通過以下命令獲取: 1.3 線上安裝的其它問題 1.3.1 代理問題 ...
  • 第十章 資料庫 10.1 資料庫介紹 1、資料庫相關概念 資料庫伺服器:本質就是一個台電腦,該電腦之上安裝有資料庫管理軟體的服務端 資料庫管理系統RDBMS:本質就是一個C/S架構的套接字軟體 庫(文件夾)| 表(文件) 記錄:抽取一個事物所有典型的特征/數據 2、資料庫管理系統/軟體分類: 關 ...
  • 1、冒泡排序法(Bubble Sort) 比較相鄰的元素。如果第一個比第二個大,就交換它們兩個; 對每一對相鄰元素作同樣的工作,從開始第一對到結尾的最後一對,這樣在最後的元素應該會是最大的數; 針對所有的元素重覆以上的步驟,除了最後一個; 重覆步驟1~3,直到排序完成。 2、快速排序法(Quick ...
  • T1 立方數 題目 【題目描述】 作為XX戰隊的狂熱粉絲,MdZzZZ看到了自己心儀的隊伍在半決賽落敗,頓時心灰意冷。看著自己手中的從黃牛那裡搶來的天價總決賽門票,MdZzZZ覺得去鳥巢已經沒有意義了,於是他決定去跳“水立方”。在他準備進“水立方”體育館時,一位大媽攔住了他的去路,並產生了一下對話: ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...