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

Posted on by

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:\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 實現不同環境下配置信息的切換，已經介紹完畢。

到此這篇關於SpringBoot通過Profile實現不同環境下的配置切換的文章就介紹到這瞭,更多相關SpringBoot配置切換內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：