知識庫 / Spring / Spring Boot RSS 訂閱

1. 概述

在開發和部署流程的不同階段，通常會創建不同的配置。實際上，當我們部署 Spring 應用時，可以為每個階段分配一個 Spring Profile，並創建專門的測試。

在本教程中，我們將重點介紹使用 JUnit 5 基於活動 Spring Profile 執行測試。

2. 項目設置

首先，讓我們將 <a href="https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-web">spring-boot-starter-web`` 依賴添加到我們的項目中：

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
</dependency>

現在讓我們創建一個簡單的 Spring Boot 應用程序：

@SpringBootApplication
public class ActiveProfileApplication {

    public static void main (String [] args){
        SpringApplication.run(Application.class);
    }
}

最後，讓我們創建一個 application.yaml 文件，用作我們的默認屬性源文件。

3. Spring 配置文件

Spring 配置文件提供了一種定義和管理不同環境的方法，通過將特定於每個環境的配置設置進行分組。

實際上，通過激活特定的配置文件，我們可以輕鬆地在不同的配置和設置之間切換。

3.1. 在屬性文件中啓用配置文件

我們可以通過在 application.yaml 文件中指定啓用配置文件：

spring:
  profiles:
    active: dev

現在，Spring 將檢索活動配置文件的所有屬性，並將所有專用 Bean 加載到應用程序上下文中。

在本教程中，我們將為每個配置文件創建專用屬性文件。這是因為為每個特定環境管理和更新配置的過程，擁有每個配置文件的專用文件可以簡化該過程。

因此，讓我們為 test 和 prod 環境創建兩個配置文件，每個配置文件都包含 profile.property.value 屬性，但具有與文件名相對應的不同值。

因此，讓我們創建一個 application-prod.yaml 文件並添加 profile.property.value 屬性：

profile:
  property:
    value: This the the application-prod.yaml file

同樣，我們對 application-test.yaml 也做相同的處理：

profile:
  property:
    value: This the the application-test.yaml file

最後，讓我們將相同的屬性添加到 application.yaml 中：

profile:
  property:
    value: This the the application.yaml file

現在，讓我們編寫一個簡單的測試，以驗證該應用程序在當前環境中是否按預期運行：

@SpringBootTest(classes = ActiveProfileApplication.class)
public class DevActiveProfileUnitTest {

    @Value("${profile.property.value}")
    private String propertyString;

    @Test
    void whenDevIsActive_thenValueShouldBeKeptFromApplicationYaml() {
        Assertions.assertEquals("This the the application.yaml file", propertyString);
    }
}

變量 propertyString 中注入的值來源於 application.yaml 中定義的屬性值。這是因為 dev 是在測試執行期間激活的 profile，並且沒有為該 profile 定義任何屬性文件。

3.2. 在測試類中設置活動配置文件

通過設置 spring.profiles.active 屬性，我們可以激活相應的配置文件並加載與之相關的配置文件。

但是，在某些情況下，我們可能需要以特定配置文件的形式執行測試類，從而覆蓋 properties 文件中定義的活動配置文件。

因此，我們可以使用 @ActiveProfiles 標註，該標註與 JUnit 5 兼容，用於聲明在加載測試類應用程序上下文時使用的活動配置文件。

例如，如果我們在測試類上添加 @ActiveProfiles 標註，並將 value 屬性設置為 test，則該測試類中的所有測試將使用 test 配置文件：

@SpringBootTest(classes = ActiveProfileApplication.class)
@ActiveProfiles(value = "test")
public class TestActiveProfileUnitTest {

    @Value("${profile.property.value}")
    private String propertyString;

    @Test
    void whenTestIsActive_thenValueShouldBeKeptFromApplicationTestYaml() {
        Assertions.assertEquals("This the the application-test.yaml file", propertyString);
    }
}

value 屬性，它是 profiles 屬性的別名，是一個字符串數組。 這是因為可以使用逗號分隔的列表指定多個活動配置文件。

例如，如果我們想指定活動配置文件為 test 和 prod，我們可以使用：

@ActiveProfiles({"prod", "test"})

這樣，應用程序上下文將使用 test 和 prod 配置文件特有的屬性和配置進行配置。

配置將在它們列出的順序上應用。 在不同配置文件的配置之間存在衝突的情況下，最後列出的配置將優先採用。

因此，基於活動配置運行測試對於確保應用程序在不同環境中行為正確至關重要。 但是，在其他環境中執行為特定配置文件設計的測試可能會帶來重大風險。 例如，在本地機器上運行測試時，我們可能會無意中運行為生產環境設計的測試。

為了避免這種情況，我們需要找到一種基於活動配置過濾測試執行的方法。

4. Annotation

#{environment.getActiveProfiles()[0] == 'prod'}

@SpringBootTest(classes = ActiveProfileApplication.class)
@EnabledIf(value = "#{environment.getActiveProfiles()[0] == 'prod'}", loadContext = true)
public class ProdActiveProfileUnitTest {

    @Value("${profile.property.value}")
    private String propertyString;

    @Test
    void whenProdIsActive_thenValueShouldBeKeptFromApplicationProdYaml() {
        Assertions.assertEquals("This the the application-prod.yaml file", propertyString);
    }

}

@SpringBootTest(classes = ActiveProfileApplication.class)
@EnabledIf(value = "#{environment.getActiveProfiles()[0] == 'prod'}", loadContext = true)
@ActiveProfiles(value = "prod")
public class ProdActiveProfileUnitTest {

    @Value("${profile.property.value}")
    private String propertyString;

    @Test
    void whenProdIsActive_thenValueShouldBeKeptFromApplicationProdYaml() {
        Assertions.assertEquals("This the the application-prod.yaml file", propertyString);
    }

}

#{{'test', 'prod'}.contains(environment.getActiveProfiles()[0])}

@SpringBootTest(classes = ActiveProfileApplication.class)
@EnabledIf(value = "#{{'test', 'prod'}.contains(environment.getActiveProfiles()[0])}", loadContext = true)
@ActiveProfiles(value = "test")
public class MultipleActiveProfileUnitTest {
    @Value("${profile.property.value}")
    private String propertyString;

    @Autowired
    private Environment env;

    @Test
    void whenDevIsActive_thenValueShouldBeKeptFromDedicatedApplicationYaml() {
        String currentProfile = env.getActiveProfiles()[0];
        Assertions.assertEquals(String.format("This the the application-%s.yaml file", currentProfile), propertyString);
    }
}