前言

Spring Boot 不僅可以通過配置文件進行配置，還可以通過環(huán)境變量、命令行參數(shù)等多種形式進行配置。

這些配置都可以讓開發(fā)人員在不修改任何代碼的前提下，直接將一套 Spring Boot 應(yīng)用程序在不同的環(huán)境中運行。

一、Spring Boot 配置優(yōu)先級

以下是常用的 Spring Boot 配置形式及其加載順序（優(yōu)先級由高到低）：

• 命令行參數(shù)
• 來自 java:comp/env 的 JNDI 屬性
• Java 系統(tǒng)屬性（System.getProperties()）
• 操作系統(tǒng)環(huán)境變量
• RandomValuePropertySource 配置的 random.* 屬性值
• 配置文件（YAML文件、Properties 文件）
• @Configuration 注解類上的 @PropertySource 指定的配置文件
• 通過SpringApplication.setDefaultProperties 指定的默認屬性

以上所有形式的配置都會被加載，當存在相同配置內(nèi)容時，高優(yōu)先級的配置會覆蓋低優(yōu)先級的配置；存在不同的配置內(nèi)容時，高優(yōu)先級和低優(yōu)先級的配置內(nèi)容取并集，共同生效，形成互補配置。

二、命令行參數(shù)

Spring Boot 中的所有配置，都可以通過命令行參數(shù)進行指定，其配置形式如下。

java -jar {Jar文件名} --{參數(shù)1}={參數(shù)值1} --{參數(shù)2}={參數(shù)值2}

示例 1

在 springbootdemo 項目啟動時，使用以下命令。

java -jar springbootdemo-0.0.1-SNAPSHOT.jar --server.port=8081 --server.servlet.context-path=/bcb

命令行參數(shù)說明如下：

• –server.port：指定服務(wù)器端口號；
• –server.servlet.context-path：指定上下文路徑（項目的訪問路徑）。

執(zhí)行結(jié)果如下圖。

配置文件

Spring Boot 啟動時，會自動加載 JAR 包內(nèi)部及 JAR 包所在目錄指定位置的配置文件（Properties 文件、YAML 文件）

下圖中展示了 Spring Boot 自動加載的配置文件的位置及其加載順序，同一位置下，Properties 文件優(yōu)先級高于 YAML 文件。

說明如下：

• /myBoot：表示 JAR 包所在目錄，目錄名稱自定義；
• /childDir：表示 JAR 包所在目錄下 config目錄的子目錄，目錄名自定義；
• JAR：表示 Spring Boot 項目打包生成的 JAR；
• 其余帶有“/”標識的目錄的目錄名稱均不能修改。
• 紅色數(shù)字：表示該配置文件的優(yōu)先級，數(shù)字越小優(yōu)先級越高。

這些配置文件的優(yōu)先級順序，遵循以下規(guī)則：

• 先加載 JAR 包外的配置文件，再加載 JAR 包內(nèi)的配置文件；
• 先加載 config 目錄內(nèi)的配置文件，再加載 config 目錄外的配置文件；
• 先加載 config 子目錄下的配置文件，再加載 config 目錄下的配置文件；
• 先加載 appliction-{profile}.properties/yml，再加載application.properties/yml；
• 先加載 .properties 文件，再加載 .yml 文件。

示例 2

1、創(chuàng)建一個名為 mybootdemo 的 Spring Boot 項目，并在src/main/resoources下創(chuàng)建以下4個配置文件。

application.yml：默認配置application-dev.yml：開發(fā)環(huán)境配置application-test.yml：測試環(huán)境配置application-prod.yml：生產(chǎn)環(huán)境配置

1）在 applcation.yml 文件中，指定默認服務(wù)端口號（port）為 “8080”，上下文路徑（context-path）為“/mybootdemo”，并激活開發(fā)環(huán)境（dev）的 profile。

server:
  port: 8080 #端口號
  servlet:
    context-path: /mybootdemo #上下文路徑或項目訪問路徑
spring:
  profiles:
    active: dev #激活開發(fā)環(huán)境配置

2）在 application-dev.yml 中，指定開發(fā)環(huán)境端口號為 “8081”，上下文路徑為“/in-dev”，配置如下。

server:
  port: 8081 #開發(fā)環(huán)境端口號 8081
  servlet:
    context-path: /in-dev #開發(fā)環(huán)境上下文路徑為 in-dev
spring:
  config:
    activate:
      on-profile: dev #開發(fā)環(huán)境

3）在 application-test.yml 中，指定測試環(huán)境端口號為 “8082”，上下文路徑為“/in-test”，配置如下。

#測試環(huán)境配置
server:
  port: 8082 #測試環(huán)境端口 8082
  servlet:
    context-path: /in-test #測試環(huán)境上下文路徑 /in-test
spring:
  config:
    activate:
      on-profile: test

4）在 application-prod.yml 中，指定生產(chǎn)環(huán)境端口號為 “8083”，上下文路徑為“/in-prod”，配置如下。

#生產(chǎn)環(huán)境配置
server:
  port: 8083 #端口號
  servlet:
    context-path: /in-prod #上下文路徑
spring:
  config:
    activate:
      on-profile: prod

2、執(zhí)行以下 mvn 命令，將 mybootdemo 打包成 JAR，并將該 JAR 包移動到本次磁盤的某個目錄下（例如 mySpringBoot 目錄）。

mvn clean package

3、在 JAR 包所在目錄下創(chuàng)建 application.yml ，并設(shè)置上下文路徑為“/out-default”，并激活生產(chǎn)環(huán)境（prod）Profile。

#JAR 包外默認配置
server:
  servlet:
    context-path: /out-default
#切換配置
spring:
  profiles:
    active: prod #激活開發(fā)環(huán)境配置

打開命令行窗口，跳轉(zhuǎn)到 mySpringBoot 目錄下，執(zhí)行以下命令啟動 Spring Boot。

java -jar mybootdemo-0.0.1-SNAPSHOT.jar

啟動結(jié)果如下圖。

三、示例分析

Spring Boot 在啟動時會加載全部的 5 個配置文件，其中位于 JAR 包外的 application.yml 優(yōu)先級最高；

在 JAR 包外的 application.yml 中，配置激活了生產(chǎn)環(huán)境（prod）Profile，即 JAR 包內(nèi)部的 application-prod.yml 生效。此時，該項目中的配置文件優(yōu)先級順序為：JAR 包外 3. application.yml >

• JAR 包內(nèi) application-prod.yml >JAR 包內(nèi)其他配置文件; application-prod.yml的配置內(nèi)容會覆蓋 JAR包內(nèi)所有其他配置文件的配置內(nèi)容，即端口號（port）為“8083”，上下文路徑（context-path）為“/in-prod”;
• JAR 包內(nèi)的 application-prod.yml 中的上下文路徑會被 JAR 包外的 application.yml 覆蓋為“/out-default”;
• JAR 包內(nèi)的 application-prod.yml 與 JAR 包外的 application.yml，形成互補配置，即，端口號為“8083”，上下文路徑為“/out-default”。

總結(jié)

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論