快捷導航

spring.profiles使用的方法步驟

更新時間：2023年07月21日 09:13:37 作者：wh柒八九

本文主要介紹了spring.profiles使用與spring.profiles.active和spring.profiles.include區(qū)別，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

業(yè)務(wù)場景

我們在開發(fā)Spring Boot應(yīng)用時，通常同一套程序會被應(yīng)用和安裝到幾個不同的環(huán)境，比如：開發(fā)、測試、生產(chǎn)等。其中每個環(huán)境的數(shù)據(jù)庫地址、服務(wù)器端口等等配置都會不同，如果在為不同環(huán)境打包時都要頻繁修改配置文件的話，那必將是個非常繁瑣且容易發(fā)生錯誤的事。

對于多環(huán)境的配置，各種項目構(gòu)建工具或是框架的基本思路是一致的，通過配置多份不同環(huán)境的配置文件，再通過打包命令指定需要打包的內(nèi)容之后進行區(qū)分打包，Spring Boot也不例外，或者說更加簡單。

spring.profiles.active屬性

一個好方法就是創(chuàng)建不同的配置文件，且命名規(guī)則遵循application-${profile}.yml，例如：

開發(fā)環(huán)境配置文件：application-dev.yml
測試環(huán)境配置文件：application-test.yml
生產(chǎn)環(huán)境配置文件：application-prod.yml

當然，我們不能刪除項目最頂層的application.yml配置，在該文件中，根據(jù)部署場景不同，切換不同的配置文件：配置spring.profiles.active，屬性值為${profile}。

spring.profiles.active=dev：啟用application-dev.yml
spring.profiles.active=test：啟用application-test.yml
spring.profiles.active=prod：啟用application-prod.yml

啟動時指定

在執(zhí)行有參啟動時，可以在命令中進行指定要選用的配置文件，例如：java -jar xx.jar --spring.profiles.active=test

這個命令的優(yōu)先級是最高的，即使application.yml中已經(jīng)配置spring.profiles.active=dev，最終程序還是會用application-test.yml配置文件。

spring.profiles.include屬性

再進一步，對于開發(fā)環(huán)境，想用不同的配置文件存儲開發(fā)環(huán)境不同的配置，例如：

application-dev1.yml中存儲jdbc信息
application-dev2.yml中存儲ip、端口信息

即在啟用application-dev.yml開發(fā)環(huán)境（主）配置文件時，同時啟用application-dev1.yml和application-dev2.yml。

那么，可以使用spring.profiles.include屬性：同時啟用其他的profile

配置方法

若是properties文件：spring.profiles.include=dev1,dev2

若是yaml文件中，spring.profiles.include:
-dev1
-dev2
或者：spring.profiles.include:dev1,dev2

配置位置

配置方式一：application.properties中，配置spring.profiles.active=dev的同時指定spring.profiles.include=dev1,dev2
配置方式二：application.properties中，配置spring.profiles.active=dev，application-dev.properties中，配置spring.profiles.include=dev1,dev2。使用application-dev.properties時自動就激活了dev1、dev2兩個文件，不用再次指定。（個人認為第二種方法更好）

配置區(qū)別

第一種方式啟動時，控制臺打印The following profiles are active:dev1,dev2,dev
第二種方式啟動時，控制臺打印The following profiles are active:dev, dev1,dev2

按照順序，后面的覆蓋前面的。

用示例來使用和區(qū)分

application.yml配置：

server:
  port: 8088
#激活的是開發(fā)環(huán)境配置文件
spring:
    profiles:
       active: dev

application-dev.yml配置：

server:
  port: 8089
#同時觸發(fā)dev1和dev2的激活
spring:
  profiles:
    include: dev1,dev2

application-dev1.yml配置：

server:
  port: 8090

application-dev2.yml配置：

server:
  port: 8091

application-prod.yml配置：

server:
  port: 9088
#同時觸發(fā)prod1和prod2的激活
spring:
  profiles:
    include: prod1,prod2

application-prod1.yml配置：

server:
  port: 9089

application-prod2.yml配置：

server:
  port: 9090

測試一

在application.yml配置文件中，指定

#激活的是開發(fā)環(huán)境配置文件
spring:
    profiles:
       active: dev

啟動時不指定參數(shù)

啟動dev2中的8091端口

測試二

在測試一的基礎(chǔ)上，啟動時指定參數(shù)：–spring.profiles.active=prod。優(yōu)先級最高，會使用生產(chǎn)環(huán)境配置文件

啟動結(jié)果

測試三

在application.yml配置文件中，指定

#激活的是開發(fā)環(huán)境配置文件
spring:
    profiles:
       active: dev
       include: dev1,dev2

啟動結(jié)果

編寫程序查看激活的yml文件

編寫程序查看激活的yml文件

package com.wideth;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
@Slf4j
@SpringBootApplication
public class AppApplication {
    public static void main(String[] args) {
        try {
            ApplicationContext ctx = SpringApplication.run
            (AppApplication.class, args);
            String[] activeProfiles = ctx.getEnvironment().
            getActiveProfiles();
            for (String profile : activeProfiles) {
                log.warn("Spring Boot 使用profile為:{}" , profile);
            }
        } catch (Exception e) {
            log.error("啟動失?。?,e);
        }
    }
}