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
  • Github / Gitee QQ群(1群) : 813100564 / QQ群(2群) : 579033769 視頻教學 介紹 MiniWord .NET Word模板引擎,藉由Word模板和數據簡單、快速生成文件。 Getting Started 安裝 nuget link : https:// ...
  • Array.Sort Array類中相當實用的我認為是Sort方法,相比起冗長的冒泡排序,它的出現讓排序更加的簡化 結果如下: 還可以聲明一個靜態方法用來專門調用指定數組排序,從名為 array 的一維數組中 a 索引處開始,到 b 元素 從小到大排序。 註意: a + b 不能大於 array 的 ...
  • 前言 在上一篇文章CLR類型系統概述里提到,當運行時掛起時, 垃圾回收會執行堆棧遍歷器(stack walker)去拿到堆棧上值類型的大小和堆棧根。這裡我們來翻譯BotR里一篇專門介紹Stackwalking的文章,希望能加深理解。 順便說一句,StackWalker在中文里似乎還沒有統一的翻譯,J ...
  • 使用過 nginx 的小伙伴應該都知道,這個中間件是可以設置跨域的,作為今天的主角,同樣的 反向代理中間件的 YARP 毫無意外也支持了跨域請求設置。 有些小伙伴可能會問了,怎樣才算是跨域呢? 在 HTML 中,一些標簽,例如 img、a 等,還有我們非常熟悉的 Ajax,都是可以指向非本站的資源的 ...
  • 什麼是Git Git 是一個開源的分散式版本控制系統,用於敏捷高效地處理任何或小或大的項目。 Git 是 Linus Torvalds 為了幫助管理 Linux 內核開發而開發的一個開放源碼的版本控制軟體。 Git 與常用的版本控制工具 CVS, Subversion 等不同,它採用了分散式版本庫的 ...
  • 首先CR3是什麼,CR3是一個寄存器,該寄存器內保存有頁目錄表物理地址(PDBR地址),其實CR3內部存放的就是頁目錄表的記憶體基地址,運用CR3切換可實現對特定進程記憶體地址的強制讀寫操作,此類讀寫屬於有痕讀寫,多數驅動保護都會將這個地址改為無效,此時CR3讀寫就失效了,當然如果能找到CR3的正確地址... ...
  • 說明 onlyoffice為一款開源的office線上編輯組件,提供word/excel/ppt編輯保存操作 以下操作均基於centos8系統,officeonly鏡像版本7.1.2.23 鏡像下載地址:https://yunpan.360.cn/surl_y87CKKcPdY4 (提取碼:1f92 ...
  • 二叉樹查找指定的節點 前序查找的思路 1.先判斷當前節點的no是否等於要查找的 2.如果是相等,則返回當前節點 3.如果不等,則判斷當前節點的左子節點是否為空,如果不為空,則遞歸前序查找 4.如果左遞歸前序查找,找到節點,則返回,否繼續判斷,當前的節點的右子節點是否為空,如果不為空,則繼續向右遞歸前 ...
  • ##Invalid bound statement (not found)出現原因和解決方法 ###前言: 想必各位小伙伴在碼路上經常會碰到奇奇怪怪的事情,比如出現Invalid bound statement (not found),那今天我就來分析以下出現此問題的原因。 其實出現這個問題實質就是 ...
  • ###一、背景知識 爬蟲的本質就是一個socket客戶端與服務端的通信過程,如果我們有多個url待爬取,只用一個線程且採用串列的方式執行,那隻能等待爬取一個結束後才能繼續下一個,效率會非常低。 需要強調的是:對於單線程下串列N個任務,並不完全等同於低效,如果這N個任務都是純計算的任務,那麼該線程對c ...