SpringBoot 通過 profile 實(shí)現(xiàn)在不同環(huán)境下的配置切換，比如常見的開發(fā)環(huán)境、測(cè)試環(huán)境、生產(chǎn)環(huán)境。

SpringBoot 常用配置文件主要有 2 種：properties 文件和 yml 文件。對(duì)于 properties 文件來說，主要通過多 profile 配置文件的方式來實(shí)現(xiàn)；對(duì)于 yml 文件來說，主要通過多片段的方式來實(shí)現(xiàn)（在一個(gè) yml 文件中通過 3 個(gè)橫杠來劃分配置片段）。

Profile 在實(shí)際工作中使用比較方便，SpringBoot 程序開發(fā)好后，最終會(huì)打包成 jar 包進(jìn)行使用，我們可以把配置文件放在外部，在外部的配置文件中指定 profile 名稱，從而決定采用哪種環(huán)境（開發(fā)環(huán)境、測(cè)試環(huán)境、生產(chǎn)環(huán)境）的配置參數(shù)。

本篇博客主要通過代碼的方式，介紹 SpringBoot 有關(guān) profile 的使用，在博客的最后會(huì)提供源代碼下載。

一、搭建工程

本篇博客的 Demo 搭建了 2 個(gè) SpringBoot 工程，分別展示 2 種 profile 的使用方式。

Demo1 通過多個(gè) properties 文件來實(shí)現(xiàn)，Demo2 通過單個(gè) yml 文件來實(shí)現(xiàn)，搭建結(jié)果如下所示：

對(duì)于 SpringBoot 來說，如果編寫的類，在啟動(dòng)類所在的包或子包下時(shí)，那么就不需要再啟動(dòng)類上配置掃描包了，因?yàn)?SpringBoot 默認(rèn)情況下就會(huì)掃描啟動(dòng)類所在的包及其子包下所有的類文件中的注解。因此為了演示方便，后續(xù)的 Demo 都在啟動(dòng)類所在的包或子包下編寫類文件。

在兩個(gè) Demo 中都編寫了相同代碼的 TestController 類，用于提供無參數(shù)接口訪問，返回的結(jié)果是當(dāng)前所啟用的 profile 名稱和 profile 配置文件中配置的端口號(hào)，方便大家在進(jìn)行 Demo 測(cè)試時(shí)進(jìn)行驗(yàn)證結(jié)果，其實(shí)也可以直接看 IDEA 控制臺(tái)中打印的信息進(jìn)行驗(yàn)證結(jié)果。下面列出 TestController 類的具體內(nèi)容：

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("啟動(dòng)的 profile 名稱為：").append(activeProfiles[0]);

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

        String portValue = env.getProperty("server.port");
        sb.append("啟動(dòng)的端口為：").append(portValue);
        return sb.toString();
    }
}

二、多文件配置方式

Demo1 中的 SpringBoot 程序采用 properties 文件作為配置文件，因此采用多文件的配置方式實(shí)現(xiàn) profile 。

SpringBoot 的配置文件，必須以 application 開頭，對(duì)于 properties 文件來說，采用 application-profile名稱.properties 的命名形式實(shí)現(xiàn) profile 多環(huán)境配置，在 Demo1 中使用了 application-dev.properties ，application-test.properites ，application-pro.properties 三個(gè)文件來代表開發(fā)環(huán)境、測(cè)試環(huán)境、生產(chǎn)環(huán)境的配置文件，配置內(nèi)容分別如下，為了方便，這里僅僅配置 SpringBoot 的啟動(dòng)端口來進(jìn)行演示：

# application-dev.properties 配置內(nèi)容
# 配置文件必須以 application 開頭
# 后面的 dev 表示 profile 配置文件的名稱
server.port=8081
# application-test.properties 配置內(nèi)容
# 配置文件必須以 application 開頭
# 后面的 test 表示 profile 配置文件的名稱
server.port=8082
# application-pro.properties 配置內(nèi)容
# 配置文件必須以 application 開頭
# 后面的 pro 表示 profile 配置文件的名稱
server.port=8083

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

# application-pro.properties 配置內(nèi)容
# 本 Demo 中編寫了多個(gè)以 application 開頭的配置文件
# 通過以下配置項(xiàng)指定 profile 名稱，設(shè)置所要啟動(dòng)的配置文件
spring.profiles.active=test

然后啟動(dòng) Demo1 的 SpringBoot 程序，如上面的例子采用的是 profile 是 test ，對(duì)應(yīng)的啟動(dòng)端口是 8082 ，因此訪問 TestController 中提供的 localhost:8082/getport 接口，即可對(duì) profile 配置信息進(jìn)行驗(yàn)證。

三、多片段配置方式

Demo2 中的 SpringBoot 程序采用 yml 文件作為配置文件，因此采用多片段的配置方式實(shí)現(xiàn) profile 。

在 application.yml 中采用三個(gè)橫杠（---）來分隔配置片段，如下所示：

# 本 Demo 中只編寫了一個(gè) application.yml 的配置文件
# 通過三個(gè)橫杠（---）來分隔開 3 種配置文件
# 通過 spring.config.activate.on-profile 設(shè)置 profile 的名稱

# 通過以下配置項(xiàng)指定 profile 名稱，設(shè)置所要啟動(dòng)的配置文件
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

然后啟動(dòng) Demo2 的 SpringBoot 程序，如以上的例子中采用的 profile 是 pro，對(duì)應(yīng)的啟動(dòng)端口是 9093 ，因此訪問 TestController 中提供的 localhost:9093/getport 接口，即可對(duì) profile 配置信息進(jìn)行驗(yàn)證。

四、使用外部配置文件

SpringBoot 程序開發(fā)好之后，會(huì)連同配置文件一起打包成 jar 包，導(dǎo)致無法更改配置文件。因此我們可以將配置文件復(fù)制一份到外部，與 jar 包放在一起，采用命令行啟動(dòng) SpringBoot 程序，并通過命令行參數(shù)（--spring.config.location）指定所使用的外部配置文件路徑。在外部配置文件中可以修改 profile 配置，實(shí)現(xiàn)不同環(huán)境下配置的切換。

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

然后在此目錄下運(yùn)行以下命令行，啟動(dòng) SpringBoot 程序：

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

由于在 application.properties 中配置的 profile 是 test ，因此啟動(dòng)的是 8082 端口。

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

然后在此目錄下運(yùn)行以下命令行，啟動(dòng) SpringBoot 程序：

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

由于在 application.yml 中配置的 profile 是 pro，因此啟動(dòng)的是 9093 端口。

到此為止，有關(guān) SpringBoot 通過 profile 實(shí)現(xiàn)不同環(huán)境下配置信息的切換，已經(jīng)介紹完畢。

到此這篇關(guān)于SpringBoot通過Profile實(shí)現(xiàn)不同環(huán)境下的配置切換的文章就介紹到這了,更多相關(guān)SpringBoot配置切換內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論