優雅哥 SpringBoot 2.7.2 實戰基礎 - 06 -多環境配置

在一個項目的開發過程中，通常伴隨著多套環境：本地環境 local、開發環境 dev、集成測試環境 test、用戶接受測試環境 uat、預生產環境 pre、生產環境 prod。本節的內容有些脫離真實企業開發，因為在真實的企業開發中，不會只開發一個獨立的服務，而是多個微服務。發展至今，雲原生也越來越普遍。面對多套環境，通常是”一套代碼 + 配置中心“的方式，將代碼編譯打包後，在啟動服務時或服務運行過程中，從配置中心讀取配置，保證各個環境代碼完全一致，僅配置不同。關於配置中心，在後面的系列文章中會詳細介紹。

1 配置文件

1.1 配置文件優先順序

在第一篇文章中就談到，Spring Boot 預設核心配置文件名為 application，支持 application.properties、application.yml、application.yaml。後面兩個本質上同一種類型。當三者同時存在時，優先順序為：properties > yaml > yml。也就是說，當某個配置項在幾者中都存在時，該配置項的值就使用 application.properties 中的值。

此外，配置文件的優先順序與目錄有關。通常情況下，我們都把核心配置文件放在 src/main/resources 下，本質上是在類路徑下（編譯後 src/main/resources 下的文件會編譯到 target/classes/下麵）。如果放到 config目錄下（如： src/main/resources/config/application.yml），config目錄下的核心配置文件優先順序會更高。

官方文檔中還提到核心配置文件放在項目根路徑等情景，在項目中到目前為止都沒碰到過，這裡就不提了。

最後說明一點，優先順序最最高的，是在啟動命令行後面的參數。如 server.port，無論在配置文件中配置什麼，只要在啟動命令後面配置了該參數，就使用該參數的值：

java -jar hero-springboot-demo.jar --server.port=9099

1.2 bootstrap.yml

也許在很多代碼里會看到 bootstrap.yml文件，有些文章說 bootstrap.yml 的優先順序最高。這種說法是不完全準確的！

bootstrap.yml 文件在純粹的 Spring Boot 應用中不會生效，它只有在 Spring Cloud 下才會生效，在 Spring Cloud 中，應用會直接或間接依賴 spring-cloud-context，此時才會讀取 bootstrap.yml 文件和 application.yml 文件，這種情況下 bootstrap.yml 優先順序高於其他核心配置文件。

1.3 準備配置文件

為多個環境準備不同的配置文件，這裡模擬三個環境：本地環境 local、開發環境 dev、測試環境 test。在 src/main/resources 目錄下複製 application.yml 到當前目錄，分別重命名為 application-local.yml、application-dev.yml、application-test.yml。埠號 server.port 分別修改為 9099、9091、9092。

src/main/resources/
|- application.yml
|- application-local.yml	9099
|- application-dev.yml		9091
|- application-test.yml		9092
|- ....

上面複製的三個文件命名方式都是：application-{環境名稱}，按照這種方式命名，就不需要分別在每個環境的配置文件中使用 spring.profiles 來設置名字了。application.yml為主文件。

2 多環境兩種配置方式

2.1 spring.profiles.active

這種方式可以通過設置 spring.profiles.active 的值來指定使用的環境配置文件。修改 application.yml ，刪除裡面的全部內容，添加 profile 配置，如下：

spring:
  profiles:
    active: local

上面的配置指定了環境為 local，會載入 application-local.yml 文件。

同樣的，可以將 local修改為dev、test，分別對應 application-dev.yml、application-test.yml。

此外，在打包後，也可以在運行 jar 包時指定生效的環境：

java -jar hero-springboot-demo.jar --spring.profiles.active=test

由於啟動參數中指定了 test，無論 application.yml 中配置什麼，都會被命令行參數 test 覆蓋，讀取 application-test.yml 的配置。

2.2 Maven

除了上面手動修改 spring.profiles.active 的方式，還可以通過 Maven打包實現。

application.yml 中 spring.profiles.active 配置一個占位符，在 Maven 打包時，通過具體的 profile，替換 application.yml 中的占位符。具體實現如下：

1）application.yml 中使用占位符

spring:
  profiles:
    active: @env@

2）pom.xml 中配置多環境

首先配置 profile：

<profiles>
    <profile>
        <id>local</id>
        <properties>
            <env>local</env>
        </properties>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
    </profile>
    <profile>
        <id>dev</id>
        <properties>
            <env>dev</env>
        </properties>
    </profile>
    <profile>
        <id>test</id>
        <properties>
            <env>test</env>
        </properties>
    </profile>
</profiles>

上面配置了三套 profile，env的值分別定義為 local、dev、test，且 local 為預設激活。 接著在 <build> 中添加資源的處理：

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <excludes>
                <exclude>application-*.yml</exclude>
            </excludes>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
            <includes>
                <include>application.yml</include>
                <include>application-${env}*.yml</include>
            </includes>
        </resource>
    </resources>
    <plugins>
       ...
    </plugins>
</build>

filtering設置為 true，表示利用占位符進行替換。上面的配置先排除 application- 開頭的資源文件，然後在根據生效的profile 對應的 env的值，打包對應的 application-xxx.yml 文件。

現在啟動服務，正常載入使用 application-local.yml，埠號為 9099。

接下來測試打包。打包有兩種方式：使用命令行和IDEA。

命令行：

mvn clean package -Pdev

-P後面就是對應的環境。

使用圖形界面，需要先選擇profile，如下圖所示：

兩種方式打包後都會在 target 目錄下生成 hero-springboot-demo.jar，可以在命令行中啟動，查看載入的環境配置文件和運行的埠號：

java -jar target/hero-springboot-demo-1.0-SNAPSHOT.jar

今日程式員優雅哥（\/ youyacoder）學習到此結束~~~