2.5 动态属性注入

---

动态属性注入

在集成测试中，某些属性值需在运行时动态确定（例如随机端口、临时数据库 URL 等）。Spring Test 结合 JUnit 5 提供了灵活的动态属性注入机制，适用于以下场景：

• 测试容器（Testcontainers）：动态获取 Docker 容器的 IP 和端口。
• 外部服务模拟：运行时生成模拟服务的 URL。
• 环境隔离：为不同测试类动态切换配置。

---

1. 使用 @DynamicPropertySource（推荐）

核心特性

• 动态注册属性 ：在测试类中通过静态方法注入属性，优先级高于 @TestPropertySource。
• 延迟解析：属性值在运行时动态计算（例如容器启动后获取端口）。
• 依赖：需 Spring Framework 5.2.5+ 和 JUnit 5.8+。

示例：集成 Testcontainers

@ExtendWith(SpringExtension.class)  
@ContextConfiguration(classes = DataSourceConfig.class)  
public class TestcontainerIntegrationTest {  
    // 启动 PostgreSQL 容器  
    @Container  
    static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:13");  

    // 动态注入数据库连接属性  
    @DynamicPropertySource  
    static void registerProperties(DynamicPropertyRegistry registry) {  
        registry.add("db.url", postgres::getJdbcUrl);  
        registry.add("db.username", postgres::getUsername);  
        registry.add("db.password", postgres::getPassword);  
    }  

    @Autowired  
    private DataSource dataSource;  

    @Test  
    void testConnection() throws SQLException {  
        assertNotNull(dataSource.getConnection());  
    }  
}  

代码解析

1. @Container：JUnit 5 扩展，管理容器生命周期。
2. @DynamicPropertySource ：标记静态方法，接收 DynamicPropertyRegistry 注册属性。
3. Lambda 表达式 ：延迟获取容器属性（如 postgres::getJdbcUrl），确保容器启动后解析。

---

2. 自定义 ApplicationContextInitializer

适用场景

• 需要更复杂的属性计算逻辑。
• 兼容旧版本 Spring（5.2.5 之前）。

实现步骤

步骤 1：实现上下文初始化器

public class DynamicPropertiesInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {  
    @Override  
    public void initialize(ConfigurableApplicationContext context) {  
        // 动态计算属性值  
        String mockServiceUrl = "http://localhost:" + findRandomPort();  
        // 将属性添加到环境  
        context.getEnvironment()  
              .getPropertySources()  
              .addFirst(new MapPropertySource("dynamicProps", Map.of("service.url", mockServiceUrl)));  
    }  

    private int findRandomPort() {  
        // 实现端口查找逻辑  
        return new Random().nextInt(10000) + 10000;  
    }  
}  

步骤 2：在测试类中引用初始化器

@ExtendWith(SpringExtension.class)  
@ContextConfiguration(  
    classes = AppConfig.class,  
    initializers = DynamicPropertiesInitializer.class  
)  
public class CustomInitializerTest {  
    @Value("${service.url}")  
    private String serviceUrl;  

    @Test  
    void testServiceUrl() {  
        assertTrue(serviceUrl.startsWith("http://localhost:"));  
    }  
}  

---

3. 手动操作 Environment

适用场景

• 简单属性覆盖，无需复杂逻辑。
• 测试方法级别动态调整属性。

示例代码

@ExtendWith(SpringExtension.class)  
@ContextConfiguration(classes = AppConfig.class)  
public class ManualPropertyTest {  
    @Autowired  
    private ConfigurableApplicationContext context;  

    @Test  
    void testOverrideProperty() {  
        // 获取当前环境  
        ConfigurableEnvironment env = context.getEnvironment();  
        // 添加或覆盖属性  
        env.getPropertySources().addFirst(  
            new MapPropertySource("manualProps", Map.of("app.timeout", "5000"))  
        );  

        // 验证属性生效  
        MyService service = context.getBean(MyService.class);  
        assertEquals(5000, service.getTimeout());  
    }  
}  

---

4. 动态属性注入的对比与选择

方法	优点	缺点	适用场景
@DynamicPropertySource	简洁、类型安全、与 JUnit 5 深度集成	需较新 Spring 版本	测试容器、运行时动态属性
ApplicationContextInitializer	灵活、兼容旧版本	代码量较多，需手动管理上下文	复杂属性初始化逻辑
手动操作 Environment	简单快速	破坏性修改，可能影响其他测试	临时调试或简单覆盖

---

5. 最佳实践与注意事项

1. 优先使用 @DynamicPropertySource：简洁且与 JUnit 5 生态兼容。
2. 隔离动态属性作用域 ：
   • 使用 @TestPropertySource(properties = "key=value") 定义静态属性。
   • 使用 @DynamicPropertySource 定义动态属性（优先级更高）。
3. 避免属性污染 ：
   • 在 @AfterEach 或 @AfterAll 中清理全局属性（如需）。
4. 版本兼容性检查 ：
   • 确保 Spring 和 JUnit 版本支持 @DynamicPropertySource。

---

通过动态属性注入，可轻松应对测试环境的不确定性，提升集成测试的可靠性和灵活性。