知識庫 / Spring RSS 訂閱

6.1. 使用 環境

我們可以通過注入 環境 對象來訪問當前的活動配置文件。

public class ProfileManager {
    @Autowired
    private Environment environment;

    public void getActiveProfiles() {
        for (String profileName : environment.getActiveProfiles()) {
            System.out.println("Currently active profile - " + profileName);
        }  
    }
}

6.2. 使用 spring.profiles.active

或者，我們可以通過注入屬性 spring.profiles.active 來訪問它們。

@Value("${spring.profiles.active}")
private String activeProfile;

在這裏，我們的 activeProfile 變量將包含當前活動 Profile 的名稱，如果存在多個，則以逗號分隔。

然而，我們應該 考慮如果根本沒有活動 Profile 的情況。 憑藉我們上面編寫的代碼，如果沒有活動 Profile，則會阻止應用程序上下文的創建。 這將導致 IllegalArgumentException，因為變量中缺少佔位符進行注入。

為了避免這種情況，我們可以 定義一個默認值：

@Value("${spring.profiles.active:}")
private String activeProfile;

現在，如果沒有任何活動配置文件，我們的 activeProfile 將只包含一個空字符串。

如果想要像之前示例一樣訪問這些配置文件列表，我們可以通過分割 activeProfile 變量來實現：

public class ProfileManager {
    @Value("${spring.profiles.active:}")
    private String activeProfiles;

    public String getActiveProfiles() {
        for (String profileName : activeProfiles.split(",")) {
            System.out.println("Currently active profile - " + profileName);
        }
    }
}

7. 示例：使用配置文件隔離數據源配置

現在我們已經掌握了基本知識，讓我們來看一個實際示例。

7.1. 單個配置文件

考慮一個場景，即我們需要維護開發和生產環境的數據源配置。

讓我們創建一個通用的接口 DatasourceConfig，該接口需要由所有數據源實現類實現：

public interface DatasourceConfig {
    public void setup();
}

接下來，我們來編寫開發環境的配置：

@Component
@Profile("dev")
public class DevDatasourceConfig implements DatasourceConfig {
    @Override
    public void setup() {
        System.out.println("Setting up datasource for DEV environment. ");
    }
}

讓我們查看生產環境的配置：

@Component
@Profile("production")
public class ProductionDatasourceConfig implements DatasourceConfig {
    @Override
    public void setup() {
       System.out.println("Setting up datasource for PRODUCTION environment. ");
    }
}

現在，讓我們創建兩個測試並注入我們的 DatasourceConfig 接口。 根據當前激活的 profile，Spring 將注入 DevDatasourceConfig 或 ProductionDatasourceConfig bean：

@RunWith(SpringJUnit4ClassRunner.class)
@ActiveProfiles("dev")
@ContextConfiguration(classes = { SpringProfilesConfig.class }, loader = AnnotationConfigContextLoader.class)
public class DevProfileWithAnnotationIntegrationTest {
    @Autowired
    DatasourceConfig datasourceConfig;

    @Test
    public void testSpringProfiles() {
        Assert.assertTrue(datasourceConfig instanceof DevDatasourceConfig);
    }
}

@RunWith(SpringJUnit4ClassRunner.class)
@ActiveProfiles("production")
@ContextConfiguration(classes = { SpringProfilesConfig.class }, loader = AnnotationConfigContextLoader.class)
public class ProductionProfileWithAnnotationIntegrationTest {

    @Autowired
    DatasourceConfig datasourceConfig;

    @Test
    public void testSpringProfiles() {
        Assert.assertTrue(datasourceConfig instanceof ProductionDatasourceConfig);
    }
}

在實際項目中，我們經常需要處理多個環境（或配置文件）。接下來，我們來學習如何在 Spring 中組合環境（或配置文件）。

7.2. 組合多個配置文件

我們將通過示例理解配置文件組合。

假設我們希望僅為 MySQL 數據庫和 Tomcat 平台注入 DatasourceConfig Bean，則可以定義 Bean 為：

@Component
@Profile("tomcat & mysql")
public class TomcatAndMySqlDatasourceConfig implements DatasourceConfig {

    @Override
    public void setup() {
        System.out.println("Setting up MySql datasource for Tomcat environment. ");
    }
}

如示例所示，僅當 tomcat 和 mysql 配置文件同時啓用時，才會生成 TomcatAndMySqlDatasourceConfig 實例作為應用程序中的 DatasourceConfig Bean。

接下來，我們創建一個測試來驗證這一點：

@RunWith(SpringJUnit4ClassRunner.class)
@ActiveProfiles({"tomcat", "mysql"})
@ContextConfiguration(classes = { SpringProfilesConfig.class }, loader = AnnotationConfigContextLoader.class)
public class TomcatAndMySqlProfileWithAnnotationIntegrationTest {
    @Autowired
    DatasourceConfig datasourceConfig;

    @Test
    public void testSpringProfiles() {
        Assert.assertTrue(datasourceConfig instanceof TomcatAndMySqlDatasourceConfig);
    }
}

在本次測試中，我們使用 @ActiveProfiles 註解同時激活了兩個配置文件。

迄今為止，我們在示例應用程序中定義了以下配置文件：dev、production、tomcat 和 mysql。

現在，如果我們的 Spring 應用程序的活動配置文件既不在上述任何一個配置中，則我們需要注入一個特殊的 DatasourceConfig Bean：

@Component
@Profile("!dev & !production & !mysql & !tomcat")
public class SpecialDatasourceConfig implements DatasourceConfig {

    @Override
    public void setup() {
        System.out.println("Setting up a very special datasource. ");
    }
}

我們可以看到，我們使用了（“!a & !b & !c …”）在 <em @Profile</em> 註解中來實現它。 讓我們通過一個簡單的測試來驗證其行為：

@RunWith(SpringJUnit4ClassRunner.class)
@ActiveProfiles("something-very-special")
@ContextConfiguration(classes = { SpringProfilesConfig.class }, loader = AnnotationConfigContextLoader.class)
public class SpecialProfileWithAnnotationIntegrationTest {
    @Autowired
    DatasourceConfig datasourceConfig;

    @Test
    public void testSpringProfiles() {
        Assert.assertTrue(datasourceConfig instanceof SpecialDatasourceConfig);
    }
}

在本次測試中，我們激活了 something-very-special 配置文件，並獲得了預期的 DatasourceConfig Bean。

8. Spring Boot 中的配置文件

Spring Boot 支持迄今為止所有列出的配置文件，並具有一些額外的功能。

8.1. 激活或設置配置文件

初始化參數 <em >spring.profiles.active</em>, 在第 4 節中介紹的，也可以作為 Spring Boot 屬性進行設置，以定義當前激活的配置文件。這是一種 Spring Boot 自動識別的標準屬性：

spring.profiles.active=dev

然而，從 Spring Boot 2.4 版本開始，此屬性不能與 spring.config.activate.on-profile 結合使用，因為這可能引發 ConfigDataException（例如，InvalidConfigDataPropertyException 或 InactiveConfigDataAccessException）。

要通過編程方式設置 profile，我們還可以使用 SpringApplication 類：

SpringApplication.setAdditionalProfiles("dev");

為了使用 Maven 在 Spring Boot 中設置配置文件，可以在 <em>pom.xm</em><em>l</em> 中指定配置文件的名稱：

<plugins>
    <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <version>3.5.7</version>
        <configuration>
            <profiles>
                <profile>dev</profile>
            </profiles>
        </configuration>
    </plugin>
    ...
</plugins>

並執行針對 Spring Boot 的 Maven 目標：

mvn spring-boot:run

8.2. 基於角色的屬性文件

Spring Boot 最重要的基於角色的特性是 基於角色的屬性文件。 這些文件必須採用 application-{profile}.properties 的命名格式。

Spring Boot 會自動加載所有角色的 application.properties 文件，並且僅針對指定角色加載 .properties 文件。

例如，我們可以通過使用名為 application-dev.properties 和 application-production.properties 的兩個文件，為 dev 和 production 角色配置不同的數據源：

在 application-production.properties 文件中，我們可以設置一個 MySql 數據源：

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/db
spring.datasource.username=root
spring.datasource.password=root

然後，我們可以為 dev 配置文件在 application-dev.properties 文件中配置相同的屬性，以使用內存中的 H2 數據庫：

spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:mem:db;DB_CLOSE_DELAY=-1
spring.datasource.username=sa
spring.datasource.password=sa

通過這種方式，我們可以輕鬆地為不同的環境提供不同的配置。

在 Spring Boot 2.4 之前，可以通過特定於文檔的配置文件來激活配置文件是可行的。但現在不行了；在後續版本中，框架會在這種情況下再次拋出 InvalidConfigDataPropertyException 或 InactiveConfigDataAccessException。

8.3. 多文檔文件

為了進一步簡化為不同環境定義屬性，我們可以將同一文件的所有屬性組合在一起，並使用分隔符來指示配置文件。

從 Spring Boot 2.4 版本開始，它擴展了對多文檔文件的支持，用於屬性文件，除了之前支持的 YAML 之外，現在我們可以在同一個 application.properties 中指定 dev 和 production 屬性。

my.prop=used-always-in-all-profiles
#---
spring.config.activate.on-profile=dev
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/db
spring.datasource.username=root
spring.datasource.password=root
#---
spring.config.activate.on-profile=production
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:mem:db;DB_CLOSE_DELAY=-1
spring.datasource.username=sa
spring.datasource.password=sa

spring.profiles.group.production=proddb,prodquartz