如何不重新編譯讓 Spring Boot 配置文件生效?
今天聊一個小伙伴在星球上的提問:
問題不難,解決方案也有很多,因此我決定擼一篇文章和大家仔細說說這個問題。
1. 配置文件位置
首先小伙伴們要明白,Spring Boot 默認加載的配置文件是 application.properties 或者 application.yaml,默認的加載位置一共有五個,五個位置可以分為兩類:
從 classpath 下加載,這個又細分為兩種:
- 直接讀取 classpath 下的配置文件,對應到 Spring Boot 項目中,就是 resources 目錄下的配置。
- 讀取 classpath:/config/ 目錄下的文件,對應到 Spring Boot 項目中就是 resources/config 目錄下的配置。
這兩種情況如下圖:
從項目所在的當前目錄下加載,這個又細分為三種情況:
從項目當前目錄下加載配置文件。
從項目當前目錄下的 config 文件夾中加載配置文件。
從項目當前目錄下的 config 文件夾的子文件夾中加載(孫子文件夾不可以)。
這三種情況如下圖:
config 目錄下的配置文件可以被加載,config/a 目錄下的配置文件也可以被加載,但是 config/a/b 目錄下的配置文件不會被加載,因為不是直接子文件夾。
配置文件可以放在這么多不同的位置,如果同一個屬性在多個配置文件中都寫了,那么后面加載的配置會覆蓋掉前面的。例如在 classpath:application.yaml? 中設置項目端口號是 8080,在 項目當前目錄/config/a/application.yaml 中設置項目端口是 8081,那么最終的項目端口號就是 8081。
這是默認的文件位置。
如果你不想讓自己的配置文件叫 application.properties 或者 application.yaml,那么也可以自定義配置文件名稱,只需要在項目啟動的時候指定配置文件名即可,例如我想設置我的配置文件名為 app.yaml,那么我們可以在啟動 jar 包的時候按照如下方式配置,此時系統會自動去上面提到的五個位置查找對應的配置文件:
如果項目已經打成 jar 包啟動了,那么前面所說的目錄中,后三個中的項目當前目錄就是指 jar 包所在的目錄。
如果你不想去這五個位置查找,那么也可以在啟動 jar 包的時候明確指定配置文件的位置和名稱,如下:
注意,我在 classpath 前面加上了 optional:? 表示如果這個配置文件不存在,則按照默認的方式啟動,而不會報錯說找不到這個配置文件。如果不加這個前綴,那么當系統找不到指定的配置文件時,就會拋出 ConfigDataLocationNotFoundException 異常,進而導致應用啟動失敗。
如果配置文件和 jar 包在相同的目錄結構下,如下圖:
那么啟動腳本如下:
如果 spring.config.location 的配置,只是指定了目錄,那么必須以 / 結尾,例如上面這個啟動腳本,也可以按照如下方式啟動:
通過 spring.config.location 屬性鎖定配置文件的位置,通過 spring.config.name 屬性鎖定配置文件的文件名。
2. 額外位置
前面我們關于配置文件位置的設置,都是覆蓋掉已有的配置,如果不想覆蓋掉 Spring Boot 默認的配置文件查找策略,又想加入自己的,那么可以按照如下方式指定配置文件位置:
如果這個額外指定的配置文件和已有的配置文件有沖突,那么還是以后來者為準。
3. 位置通配符
有一種情況,假設我有 redis 和 mysql 的配置,我想將之放在兩個不同的文件夾中以便于管理,像下面這樣:
那么在項目啟動時,可以通過通配符 * 批量掃描相應的文件夾:
使用通配符批量掃描 mysql 和 redis 目錄時,默認的加載順序是按照文件夾的字母排序,即先加載 mysql 目錄后加載 redis 目錄。
需要注意的是,通配符只能用在外部目錄中,不可以用在 classpath 中的目錄上。另外,包含了通配符的目錄,只能有一個通配符 *?,不可以有多個,并且還必須是以 */ 結尾,即一個目錄的最后部分可以不確定。
4. 導入外部配置
從 Spring Boot2.4 開始,我們也可以使用 spring.config.import? 方法來導入配置文件,相比于 additional-location 配置,這個 import 導入更加靈活,可以導入任意名稱的配置文件。
甚至,這個 spring.config.import 還可以導入無擴展名的配置文件,例如我有一個配置文件,是 properties 格式的,但是這個這個配置文件沒有擴展名,現在我想將之作為 properties 格式的配置文件導入,方式如下:
好啦,看完上面的內容,文章一開始的問題答案就不用我多說了吧~