SpringBoot 如何通過 Profile 實現不同環境下的設定切換

SpringBoot 通過 profile 實現在不同環境下的設定切換，比如常見的開發環境、測試環境、生產環境。

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

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

本篇部落格主要通過程式碼的方式，介紹 SpringBoot 有關 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:javacodedemo1 資料夾中，如下圖所示：

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

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

由於在 application.properties 中設定的 profile 是 test ，因此啟動的是 8082 埠。

我們將 Demo2 打包的 jar 包和組態檔，放在 d:javacodedemo2 資料夾中，如下圖所示：

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

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

由於在 application.yml 中設定的 profile 是 pro，因此啟動的是 9093 埠。

到此為止，有關 SpringBoot 通過 profile 實現不同環境下設定資訊的切換，已經介紹完畢。

到此這篇關於SpringBoot通過Profile實現不同環境下的設定切換的文章就介紹到這了,更多相關SpringBoot設定切換內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！