@DynamicPropertySource注解

---

什么是@DynamicPropertySource

@DynamicPropertySource 是 Spring Framework 5.2.5 及其后的版本中引入的一个注解，主要用于在 Spring 的集成测试中动态地设置 Environment 中的属性。它可以在测试执行时动态地为 Spring 环境中的属性设置值，通常与 Spring Boot 的测试上下文结合使用，尤其是在涉及到诸如容器化服务（如 Testcontainers） 或 动态端口等场景时。

主要用途：

• 动态设置配置属性： 在测试运行时，动态设置 Spring 应用上下文的配置属性。这些属性通常是依赖于外部环境的，例如数据库连接信息、服务端口等。
• 与 Testcontainers 集成： 经常用于与 Testcontainers（用于在测试中运行轻量级的容器化服务）集成，动态传递容器的配置信息（如数据库的 URL、端口等）。

工作原理：

• @DynamicPropertySource 被用来将一组动态生成的属性注册到 Spring 的 Environment中，使得这些属性可以在 Spring 的应用上下文中使用。
• 它注解在一个静态方法上，该方法接受一个 DynamicPropertyRegistry 类型的参数，通过它可以向 Spring 环境中动态添加属性。

示例用法：

场景：使用 Testcontainers 进行集成测试

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import org.testcontainers.containers.PostgreSQLContainer;

@SpringBootTest
public class MyRepositoryTest {

    // 启动 PostgreSQL 容器
    static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:13")
            .withDatabaseName("testdb")
            .withUsername("testuser")
            .withPassword("testpass");

    static {
        // 容器启动
        postgres.start();
    }

    // 动态属性设置
    @DynamicPropertySource
    static void configureProperties(DynamicPropertyRegistry registry) {
        // 动态设置数据库连接属性
        registry.add("spring.datasource.url", postgres::getJdbcUrl);
        registry.add("spring.datasource.username", postgres::getUsername);
        registry.add("spring.datasource.password", postgres::getPassword);
    }

    @Test
    void testRepository() {
        // 测试代码
    }
}

解释：

- PostgreSQLContainer： 通过 Testcontainers 启动一个 PostgreSQL 容器。

- @DynamicPropertySource： configureProperties 方法被 @DynamicPropertySource标记，意味着它会在测试上下文加载时执行，将动态生成的数据库 URL、用户名、密码注入到 Spring 环境中。

- DynamicPropertyRegistry： 这个对象用来动态设置属性，registry.add 方法可以为属性指定键和值。

使用 DynamicPropertyRegistry 动态注册属性：

DynamicPropertyRegistry 提供了两种 add 方法来添加属性：

1. add(String key, Supplier valueSupplier)：

• 传入一个属性名和一个 Supplier，Supplier 动态返回属性的值。
• 适用于简单的属性值生成。

示例：

registry.add("spring.datasource.url", () -> "jdbc:mysql://localhost:3306/testdb");

2. add(String key, Function<DynamicPropertyRegistry, Object> valueFunction)：

• 接受一个 Function，该函数可以根据DynamicPropertyRegistry 动态生成属性值。
• 适合更复杂的属性值计算。假设你正在使用一个 PostgreSQL 容器进行测试，并且想要动态设置数据库的连接属性。

典型使用场景：

1. 动态端口： 测试时你可能需要动态分配端口，尤其是当你使用随机端口或需要避免冲突时。
2. Testcontainers 集成： 常见于与Testcontainers 的集成使用，通过容器提供动态的配置（如数据库连接信息）。
3. 动态服务 URL： 如果在测试中使用外部服务（如
   Redis、Kafka 等），你可以动态设置这些服务的连接信息。

再看一个与 Testcontainers Kafka 集成的例子：

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import org.testcontainers.containers.KafkaContainer;

@SpringBootTest
public class KafkaTest {

    static KafkaContainer kafka = new KafkaContainer("confluentinc/cp-kafka:5.4.3");

    static {
        kafka.start();
    }

    @DynamicPropertySource
    static void configureKafkaProperties(DynamicPropertyRegistry registry) {
        // 动态设置 Kafka 的连接属性
        registry.add("spring.kafka.bootstrap-servers", kafka::getBootstrapServers);
    }

    @Test
    void testKafkaProducer() {
        // 测试 Kafka 生产者的代码
    }
}

在这个例子中：

• KafkaContainer 是 Testcontainers 提供的一个 Kafka 容器。
• @DynamicPropertySource 注入 Kafka 的 bootstrap-servers 属性。

@DynamicPropertySource 和 application.properties 的关系：

• @DynamicPropertySource 注入的属性优先级高于 application.properties
  中的属性。这意味着，测试时动态设置的属性会覆盖掉 application.properties 文件中对应的属性值。

总结：

• @DynamicPropertySource 是 Spring 集成测试中的一个注解，用于在测试运行时动态设置属性。
• 它常与Testcontainers 等工具一起使用，动态配置数据库、消息队列、服务端口等外部资源。
• 动态性是其核心特性，能够帮助我们根据测试环境的变化灵活地为测试配置属性，且其设置的属性优先级高于 application.properties或 application.yml 文件中的配置。

典型用法：

1. 在容器化测试中，使用 Testcontainers 创建数据库或服务容器。
2. 动态设置数据库连接、服务 URL、端口等。
3. 替换application.properties 中的固定配置，进行测试环境的灵活配置。