当前位置：首页 > article >正文

TestContext 框架核心机制详解

article 2025/2/10 8:53:26

TestContext 框架核心机制详解

TestContext 框架是 Spring Test 的底层核心，负责管理测试的上下文、依赖注入和生命周期。以下通过 具体场景 和 代码示例 解析其核心机制。

1. 上下文缓存机制

问题背景

每次测试都重新加载 Spring 上下文（ApplicationContext）会非常耗时，尤其是大型项目。

解决方案

TestContext 框架通过 上下文缓存 复用已加载的上下文。

缓存规则：相同配置（相同的 @ContextConfiguration）的测试类共享同一个上下文。
缓存失效：使用 @DirtiesContext 标记的测试会触发缓存清理。

示例代码

// 测试类 A
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = AppConfig.class)
public class TestA {
    @Autowired
    private UserService userService;

    @Test
    void testA() {
        assertNotNull(userService);
    }
}

// 测试类 B（与 TestA 共享同一个上下文）
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = AppConfig.class)
public class TestB {
    @Autowired
    private OrderService orderService; // 同一上下文中注入的 Bean

    @Test
    void testB() {
        assertNotNull(orderService);
    }
}

// 测试类 C（触发缓存清理）
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = AppConfig.class)
@DirtiesContext
public class TestC {
    @Test
    void testC() {
        // 测试结束后，AppConfig 的上下文会被销毁
    }
}

关键日志（启用 Spring 日志后）：

第一次运行 TestA 时，会输出 Loading ApplicationContext for @ContextConfiguration。
运行 TestB 时，无加载日志，直接复用缓存。
运行 TestC 后，输出 Closing ApplicationContext，后续测试需要重新加载上下文。

2. 依赖注入机制

核心原理

TestContext 框架通过 TestContextManager 管理测试类的依赖注入：

加载 ApplicationContext。
扫描测试类中的 @Autowired 字段或方法。
从上下文中查找匹配的 Bean 并注入。

示例代码

@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = ServiceConfig.class)
public class InjectionTest {
    @Autowired
    private UserService userService; // 直接注入已配置的 Bean

    @Autowired
    private ApplicationContext context; // 甚至能注入上下文本身

    @Test
    void testInjection() {
        assertNotNull(userService);
        assertTrue(context.containsBean("userService"));
    }
}

注入的底层步骤：

SpringExtension 调用 TestContextManager 准备测试实例。
通过 DependencyInjectionTestExecutionListener 执行注入。
最终调用 AutowiredAnnotationBeanPostProcessor 完成注入逻辑。

3. 事务管理机制

核心行为

默认事务回滚：测试方法默认在事务中执行，结束后自动回滚。
手动控制事务：通过 @Commit 或 @Rollback(false) 提交事务。

示例代码

@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = DataSourceConfig.class)
@Transactional // 整个类启用事务
public class TransactionTest {
    @Autowired
    private JdbcTemplate jdbcTemplate;

    @Test
    void testInsert() {
        jdbcTemplate.update("INSERT INTO users (name) VALUES ('Alice')");
        Integer count = jdbcTemplate.queryForObject("SELECT COUNT(*) FROM users", Integer.class);
        assertEquals(1, count); // 事务未提交时，此处仍能查到数据（同一事务内可见）
    }

    @Test
    @Commit // 提交事务
    void testCommit() {
        jdbcTemplate.update("INSERT INTO users (name) VALUES ('Bob')");
    }
}

// 测试结束后：  
// testInsert() 插入的数据被回滚，表中无记录。  
// testCommit() 插入的数据被提交，表中永久保留。

事务控制原理：

TransactionalTestExecutionListener 监听测试方法执行。
在方法开始前开启事务，结束后根据注解决定提交或回滚。

4. 扩展机制（TestExecutionListener）

自定义监听器

通过实现 TestExecutionListener 接口，干预测试生命周期。

示例：统计测试执行时间

public class TimeLoggingListener implements TestExecutionListener {
    private long startTime;

    @Override
    public void beforeTestMethod(TestContext testContext) {
        startTime = System.currentTimeMillis();
    }

    @Override
    public void afterTestMethod(TestContext testContext) {
        long duration = System.currentTimeMillis() - startTime;
        String methodName = testContext.getTestMethod().getName();
        System.out.println(methodName + " 执行耗时: " + duration + "ms");
    }
}

// 注册监听器
@TestExecutionListeners(
    listeners = TimeLoggingListener.class,
    mergeMode = MergeMode.MERGE_WITH_DEFAULTS // 保留默认监听器
)
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = AppConfig.class)
public class ListenerTest {
    @Test
    void testSlowMethod() throws InterruptedException {
        Thread.sleep(1000);
    }
}

// 输出：  
// testSlowMethod 执行耗时: 1002ms

5. 上下文加载机制（ContextLoader）

自定义上下文加载

通过实现 ContextLoader 接口，完全控制上下文的创建方式。

示例：动态生成配置类

public class DynamicContextLoader implements ContextLoader {
    @Override
    public ApplicationContext loadContext(String... locations) {
        // 动态创建一个配置类
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        context.register(DynamicConfig.class); // 动态注册配置
        context.refresh();
        return context;
    }
}

// 使用自定义加载器
@ExtendWith(SpringExtension.class)
@ContextConfiguration(loader = DynamicContextLoader.class)
public class DynamicContextTest {
    @Autowired
    private Environment env;

    @Test
    void testProperty() {
        assertEquals("dynamic", env.getProperty("config.source"));
    }
}

// 动态配置类
public class DynamicConfig {
    @Bean
    public Environment environment() {
        Map<String, Object> props = new HashMap<>();
        props.put("config.source", "dynamic");
        return new MapPropertySource("dynamicSource", props);
    }
}