SpringBoot怎麼透過Profile實現不同環境下的設定切換

SpringBoot 透過 profile 實現在不同環境下的配置切換，例如常見的開發環境、測試環境、生產環境。

SpringBoot 常用設定檔主要有 2 種：properties 檔案和 yml 檔案。對於 properties 檔案來說，主要透過多 profile 設定檔的方式來實現；對於 yml 檔案來說，主要透過多片段的方式來實現（在一個 yml 檔案中透過 3 個橫槓來劃分配置片段）。

Profile 在實際工作中使用比較方便，SpringBoot 程式開發好後，最終會打包成jar 套件進行使用，我們可以把設定檔放在外部，在外部的設定檔中指定profile 名稱，從而決定採用哪一種環境（開發環境、測試環境、生產環境）的配置參數。

一、搭建工程

本篇部落格的 Demo 搭建了 2 個 SpringBoot 工程，分別展示 2 種 profile 的使用方式。

Demo1 透過多個properties 檔案來實現，Demo2 透過單一yml 檔案來實現，建立結果如下所示：

#對於SpringBoot 來說，如果編寫的類，在啟動類所在的包或子包下時，那麼就不需要再啟動類上配置掃描包了，因為SpringBoot 預設會掃描啟動類所在的包及其子包下所有的類文件中的註解。因此為了示範方便，後續的 Demo 都在啟動類別所在的套件或子包下編寫類別檔案。

在兩個Demo 中都編寫了相同程式碼的TestController 類，用於提供無參數介面訪問，返回的結果是當前所啟用的profile 名稱和profile 設定檔中配置的連接埠號，方便大家在進行Demo 測試時進行驗證結果，其實也可以直接看IDEA 控制台中列印的資訊進行驗證結果。以下列出 TestController 類別的具體內容：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @Autowired
    private Environment env;

    @RequestMapping("/getport")
    public String getPort()
    {
        StringBuilder sb = new StringBuilder();

        String[] activeProfiles = env.getActiveProfiles();
        sb.append("启动的 profile 名称为：").append(activeProfiles[0]);

        sb.append("<br/>");

        String portValue = env.getProperty("server.port");
        sb.append("启动的端口为：").append(portValue);
        return sb.toString();
    }
}

二、多檔案設定方式

Demo1 中的 SpringBoot 程式採用 properties 檔案作為設定文件，因此採用多檔案的設定方式實作 profile 。

SpringBoot 的配置文件，必須以application 開頭，對於properties 文件來說，採用application-profile名稱.properties 的命名形式實現profile 多環境配置，在Demo1 中使用了application-dev.properties ，application -test.properites ，application-pro.properties 三個文件來代表開發環境、測試環境、生產環境的配置文件，配置內容分別如下，為了方便，這裡僅配置SpringBoot 的啟動端口來進行演示：

# application-dev.properties 配置内容
# 配置文件必须以 application 开头
# 后面的 dev 表示 profile 配置文件的名称
server.port=8081
# application-test.properties 配置内容
# 配置文件必须以 application 开头
# 后面的 test 表示 profile 配置文件的名称
server.port=8082
# application-pro.properties 配置内容
# 配置文件必须以 application 开头
# 后面的 pro 表示 profile 配置文件的名称
server.port=8083

要想使用具體的一種profile 配置文件，需要在application.properties 進行配置profile 名稱：

# application-pro.properties 配置内容
# 本 Demo 中编写了多个以 application 开头的配置文件
# 通过以下配置项指定 profile 名称，设置所要启动的配置文件
spring.profiles.active=test

然後啟動Demo1 的SpringBoot 程序，如上面的例子採用的是profile 是test ，對應的啟動端口是8082 ，因此訪問TestController 中提供的localhost:8082/getport 接口，即可對profile 配置資訊進行驗證。

三、多片段設定方式

Demo2 中的 SpringBoot 程式採用 yml 檔案作為設定文件，因此採用多片段的設定方式實作 profile 。

在application.yml 中採用三個橫槓（---）來分隔配置片段，如下所示：

# 本 Demo 中只编写了一个 application.yml 的配置文件
# 通过三个横杠（---）来分隔开 3 种配置文件
# 通过 spring.config.activate.on-profile 设置 profile 的名称

# 通过以下配置项指定 profile 名称，设置所要启动的配置文件
spring:
  profiles:
    active: pro
---
server:
  port: 9091

spring:
  config:
    activate:
      on-profile: dev
---
server:
  port: 9092

spring:
  config:
    activate:
      on-profile: test
---
server:
  port: 9093

spring:
  config:
    activate:
      on-profile: pro

然後啟動Demo2 的SpringBoot 程序，如以上的例子中採用的profile 是pro，對應的啟動端口是9093 ，因此訪問TestController 中提供的localhost:9093/getport 接口，即可對profile 配置資訊進行驗證。

四、使用外部設定檔

SpringBoot 程式開發好之後，會連同設定檔一起打包成 jar 包，導致無法變更設定檔。因此我們可以將設定檔複製一份到外部，與 jar 套件放在一起，採用命令列啟動 SpringBoot 程序，並透過命令列參數（--spring.config.location）指定所使用的外部設定檔路徑。在外部設定檔中可以修改 profile 配置，以實現不同環境下配置的切換。

我們將Demo1 打包的jar 套件和配置文件，放在d:\javacode\demo1 資料夾中，如下圖所示：

然後在此目錄下執行以下命令列，啟動SpringBoot 程式：

D:\javacode\demo1> java -jar .\demo1-0.0.1-SNAPSHOT.jar --spring.config.location=.\application.properties

由於在application.properties 中配置的profile 是test ，因此啟動的是8082 連接埠。

我們將Demo2 打包的jar 套件和配置文件，放在d:\javacode\demo2 資料夾中，如下圖所示：

然後在此目錄下執行以下命令列，啟動SpringBoot 程式：

D:\javacode\demo2> java -jar .\demo2-0.0.1-SNAPSHOT.jar --spring.config.location=.\application.yml

由於在application.yml 中配置的profile 是pro，因此啟動的是9093 連接埠。

以上是SpringBoot怎麼透過Profile實現不同環境下的設定切換的詳細內容。更多資訊請關注PHP中文網其他相關文章！