SpringBoot配置文件優先順序

来源:https://www.cnblogs.com/hans-hu/archive/2022/05/08/16247235.html
-Advertisement-
Play Games

在開發過程中,不知道有沒有這樣的經歷,項目實際讀取的配置信息有時候總是與預期不符,今天就來研究下 SpringBoot 讀取配置文件順序。 一、SpringBoot 配置文件載入優先順序 SpringBoot官方文檔說明瞭載入的順序如下,越靠前優先順序越高。 Spring Boot uses a ver ...


在開發過程中,不知道有沒有這樣的經歷,項目實際讀取的配置信息有時候總是與預期不符,今天就來研究下 SpringBoot 讀取配置文件順序。

一、SpringBoot 配置文件載入優先順序

SpringBoot官方文檔說明瞭載入的順序如下,越靠前優先順序越高。

Spring Boot uses a very particular PropertySource order that is designed to allow sensible overriding of values. Properties are considered in the following order


1. 開發者工具 Devtools 全局配置參數;  

2. 單元測試上的 [@TestPropertySource](mailto:@TestPropertySource)` 註解指定的參數;  

3. 單元測試上的 [@SpringBootTest](mailto:@SpringBootTest)` 註解指定的參數;  

4. 命令行指定的參數,如 java -jar springboot.jar --name="xxx";  

5. 命令行中的 SPRING_APPLICATION_JSON 指定參數, 如 java -Dspring.application.json='{"name":"xxx"}' -jar springboot.jar  

6. ServletConfig初始化參數;  

7. ServletContext初始化參數;  

8. JNDI參數(如 java:comp/env/spring.application.json);  

9. Java系統參數(來源:System.getProperties());  

10. 操作系統環境變數參數;  

11. RandomValuePropertySource 隨機數,僅匹配:ramdom.*;  

12. JAR包外面的配置文件參數(application-{profile}.properties(YAML))  

13. JAR包裡面的配置文件參數(application-{profile}.properties(YAML))  

14. JAR包外面的配置文件參數(application.properties(YAML))  

15. JAR包裡面的配置文件參數(application.properties(YAML))  

16. @Configuration (mailto:@Configuration)配置文件上 @PropertySource(mailto:@PropertySource) 註解載入的參數;  

17. 預設參數(通過 SpringApplication.setDefaultProperties 指定);  


這裡我們只對比常用的幾個地方的配置優先順序:

命令行參數 > JAR包外面的 application-{profile}.properties > JAR包內的 application-{profile}.properties > JAR包外的 application.properties > JAR包內的 application.properties

這樣可能不太直觀,而且有的項目會將 application.properties 文件放在config文件夾內,於是進一步對比了這兩個位置的優先順序,結果如下

SpringBoot 應用程式在啟動時會遵循以下順序進行載入配置文件

  1. 類路徑下的配置文件
  2. 類路徑內config子目錄的配置文件
  3. 項目根目錄下的配置文件
  4. 項目根目錄下config子目錄的配置文件
. project-sample  
├── config  
│   ├── application.yml (4)  
│   └── src/main/resources  
|   │   ├── application.yml (1)  
|   │   └── config  
|   |   │   ├── application.yml (2)  
├── application.yml (3)  
  
註:src/main/resources下的配置文件在項目編譯時,會放在target/classes下  

啟動時載入配置文件順序:1 -> 2 -> 3 -> 4,優先順序 4 > 3 > 2 > 1

註意:

  • 如果在IDEA中是多 module 項目,3 和 4 的位置是指的是項目根目錄下的位置
  • 當 .properties 和 .yml 文件同時存在時,.properties會失效,.yml會起作用。

二、bootstrap.yml配置文件

SpringCloud 的項目中,我們常常會碰到另外一個配置文件 bootstrap.yml。這個配置文件主要是用於應用程式上下文的引導階段,該配置文件的載入是在 application.yml 之前。

bootstrap.yml 和 application.yml 文件的區別可參考:What is the difference between putting a property on application.yml or bootstrap.yml in spring boot

在 SpringCloud 中有兩種上下文,一種是 bootstrap, 另外一種是 application, bootstrap 是應用程式的父上下文。官方的原話是 A Spring Cloud application operates by creating a “bootstrap” context, which is a parent context for the main application

bootstrap.yml配置文件的使用場景:

  • 使用配置中心時,這時需要在bootstrap配置文件中添加連接到配置中心的信息,來載入外部配置中心的配置信息
  • 一些固定的不能被覆蓋的屬性
  • 一些加密/解密的信息

項目中 bootstrap.yml 示例


spring:
  application:
    name: 
  profiles:
    active: local
  cloud:
    nacos:
      # 遠程配置
      config:
        server-addr: 
        namespace: 
        group: ${spring.profiles.active}
        file-extension: yml
      # 服務發現
      discovery:
        server-addr: 
        namespace: 
        group: ${spring.profiles.active}

三、配置中心的配置

SpringCloud 項目中,我們的配置常由配置中心進行統一管理,這就涉及到本地與遠程配置文件的優先順序問題。這裡只說明遇到過的兩種: SpringCloud Config 和 Nacos。

  1. SpringCloud Config

SpringCloud Config 中的遠程配置,預設是無法被本地覆蓋,如果需要本地配置覆蓋遠程配置,需要在遠程做如下配置:

spring:  
  cloud:  
    config:  
      allowOverride: true  
      overrideNone: true  
      overrideSystemProperties: false

上面的說法可以在如下鏈接中得到驗證:
https://cloud.spring.io/spring-cloud-commons/multi/multi__spring_cloud_context_application_context_services.html#overriding-bootstrap-properties

  1. Nacos

Nacos中的遠程配置,似乎不支持本地覆蓋,在Nacos項目中Issue中得到證實,似乎官方也沒有這種打算。值得一提的是,即使通過命令行指定的參數,也不能覆蓋遠程配置。

關於該問題的Issue:

四、踩過的坑

在一次開發過程中,我們希望服務(serviceA)的某些節點的配置與其他節點配置不同,剛開始的想法是在啟動命令行加入參數 spring.application.name=serviceB,然後在配置中心 nacos 中複製一份serviceA的配置命名為 service B。但是實際測試中,不能修改 application.name 的值,因為參與到一些業務配置。

接著我們想直接在命令行中加入區別於其他節點的參數,希望能夠覆蓋遠程的配置,但前面也說過,命令行的配置無法覆蓋遠程Nacos配置,且Nacos沒有提供支持覆蓋的開關,所以也沒能達到我們預期的結果。

實際測試的結果,配置優先順序:nacos上的配置 > 命令行配置 > system env > classpath:application.yml > classpath:bootstrap.yml

最後我們發現nacos支持指定服務配置,以及服務發現的名稱,這些配置是在 bootstap.yml 文件中指定,預設值是 spring.application.name。實際測試結果,通過命令行可以覆蓋該文件中的配置,這樣正好能夠滿足我們的需求:不修改application.name,又可以使部分節點的配置區別於其他節點。

java -jar ./app.jar --spring.profiles.active=local --spring.cloud.nacos.config.name=serviceB --spring.cloud.nacos.discovery.service=serviceB

五、參考資料


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

-Advertisement-
Play Games
更多相關文章
  • MySQL8新增降序索引 桃花塢里桃花庵,桃花庵里桃花仙。桃花仙人種桃樹,又摘桃花賣酒錢。 一、MySQL5.7 降序索引 MySQL在語法上很早就已經支持降序索引,但實際上創建的卻仍然是升序索引,如下MySQL 5.7 所示,row2欄位降序,但是從show create table看 row2  ...
  • Linux環境下,MySQL的主要目錄及其作用、資料庫和數據表在文件系統上的存儲結構。 ...
  • HarmonyOS Connect智能硬體開放生態即將步入富設備產業化時代!為了讓廣大開發者能搶先體驗鴻蒙智聯富設備開發,本期我們將為大家帶來七款支持富設備開發的開發板。 ...
  • 字元串是用引號包裹的,表示語言文字。 用雙引號包裹的都是字元串 註意:變數不能包裹在雙引號里 輸出 布爾類型 true和false 註意都是小寫 ...
  • 認識js 在谷歌瀏覽器的控制臺中右鍵單擊空白處,選擇檢查可以打開控制台 查看console.log輸出的內容。 JS的註釋 是”//”或者”/* */”,前者是行註釋,後者是塊註釋 1變數 js的變數必須申明在用,聲明後賦值,變數才可使用,使用過程中可以改變類型。 變數的命名規則: 變數名只能由字母 ...
  • 幾天的內容不是很多,因為我們腳手架的學習告一段落了,也是為了跟明天開始的內容有一個區分。 明天將會有一個非常重要的內容來了,各位,vue中的ajax他來了,這個絕對是重量級,有點興奮! 十一.TODOList編輯 新增一個編輯功能,要完成的邏輯就是,當我們一點擊編輯按鈕,對象會新增一個屬性edit為 ...
  • # JavaScript經典案例練習 P1:支付10秒倒計時 效果: 功能: 點擊立即支付彈出確認款 確認付款後跳轉到支付成功頁面並開始計時 計時結束或者點擊立即返回按鈕返迴首頁 知識點: window.confirm() 用於顯示一個帶有指定消息和確認及取消按鈕的對話框,如果訪問者點擊‘確認’, ...
  • ${}字元串可以用於字元串拼接,一般用於模糊查詢中(因為有sql註入的風險,很少用) ...
一周排行
    -Advertisement-
    Play Games
  • 一個自定義WPF窗體的解決方案,借鑒了呂毅老師的WPF製作高性能的透明背景的異形視窗一文,併在此基礎上增加了滑鼠穿透的功能。可以使得透明窗體的滑鼠事件穿透到下層,在下層窗體中響應。 ...
  • 在C#中使用RabbitMQ做個簡單的發送郵件小項目 前言 好久沒有做項目了,這次做一個發送郵件的小項目。發郵件是一個比較耗時的操作,之前在我的個人博客裡面回覆評論和友鏈申請是會通過發送郵件來通知對方的,不過當時只是簡單的進行了非同步操作。 那麼這次來使用RabbitMQ去統一發送郵件,我的想法是通過 ...
  • 當你使用Edge等瀏覽器或系統軟體播放媒體時,Windows控制中心就會出現相應的媒體信息以及控制播放的功能,如圖。 SMTC (SystemMediaTransportControls) 是一個Windows App SDK (舊為UWP) 中提供的一個API,用於與系統媒體交互。接入SMTC的好 ...
  • 最近在微軟商店,官方上架了新款Win11風格的WPF版UI框架【WPF Gallery Preview 1.0.0.0】,這款應用引入了前沿的Fluent Design UI設計,為用戶帶來全新的視覺體驗。 ...
  • 1.簡單使用實例 1.1 添加log4net.dll的引用。 在NuGet程式包中搜索log4net並添加,此次我所用版本為2.0.17。如下圖: 1.2 添加配置文件 右鍵項目,添加新建項,搜索選擇應用程式配置文件,命名為log4net.config,步驟如下圖: 1.2.1 log4net.co ...
  • 之前也分享過 Swashbuckle.AspNetCore 的使用,不過版本比較老了,本次演示用的示例版本為 .net core 8.0,從安裝使用開始,到根據命名空間分組顯示,十分的有用 ...
  • 在 Visual Studio 中,至少可以創建三種不同類型的類庫: 類庫(.NET Framework) 類庫(.NET 標準) 類庫 (.NET Core) 雖然第一種是我們多年來一直在使用的,但一直感到困惑的一個主要問題是何時使用 .NET Standard 和 .NET Core 類庫類型。 ...
  • WPF的按鈕提供了Template模板,可以通過修改Template模板中的內容對按鈕的樣式進行自定義。結合資源字典,可以將自定義資源在xaml視窗、自定義控制項或者整個App當中調用 ...
  • 實現了一個支持長短按得按鈕組件,單擊可以觸發Click事件,長按可以觸發LongPressed事件,長按鬆開時觸發LongClick事件。還可以和自定義外觀相結合,實現自定義的按鈕外形。 ...
  • 一、WTM是什麼 WalkingTec.Mvvm框架(簡稱WTM)最早開發與2013年,基於Asp.net MVC3 和 最早的Entity Framework, 當初主要是為瞭解決公司內部開發效率低,代碼風格不統一的問題。2017年9月,將代碼移植到了.Net Core上,併進行了深度優化和重構, ...