如何为@TestInstance(PER_METHOD)的@SpringBootTest实现非静态类级清理

问题背景 #

使用Spring Boot 3.5.4，测试类配置@TestInstance(Lifecycle.PER_METHOD) + @SpringBootTest，测试套件共享一个基于GenericContainer的高成本Docker环境。其中某测试类为有状态设计，需要在所有测试方法执行完毕后调用依赖Spring注入Bean的非静态cleanup()方法，确保环境干净。

尝试过@PreDestroy注解，但它会在@SpringBootTest上下文关闭时触发，而非测试类实例销毁阶段；不想通过反射实现TestExecutionListener来判断最后一个测试方法并调用清理逻辑，希望用更优雅的Spring/JUnit原生方式解决。

可行方案 #

方案1：自定义TestExecutionListener + 标记接口（推荐） #

通过标记接口实现类型安全的清理逻辑调用，无需反射：

1. 定义标记接口

public interface TestClassCleanup {
    void cleanup();
}

2. 测试类实现接口并编写清理逻辑

@SpringBootTest
@TestInstance(Lifecycle.PER_METHOD)
// 注册自定义Listener，合并默认Listener
@TestExecutionListeners(listeners = CleanupTestExecutionListener.class, mergeMode = MergeMode.MERGE_WITH_DEFAULTS)
public class StatefulTest implements TestClassCleanup {

    @Autowired
    private SomeBean someBean; // 依赖注入的Bean

    @Test
    @Order(1)
    void testFirst() {
        // 测试逻辑
    }

    @Test
    @Order(2)
    void testLast() {
        // 测试逻辑
    }

    @Override
    public void cleanup() {
        // 调用Bean的清理方法
        someBean.clearSharedState();
        // 其他自定义清理逻辑
    }
}

3. 实现TestExecutionListener
   在测试类所有方法执行完毕后触发清理：

public class CleanupTestExecutionListener implements TestExecutionListener {

    @Override
    public void afterTestClass(TestContext testContext) throws Exception {
        Object testInstance = testContext.getTestInstance();
        // 仅对实现标记接口的测试类执行清理
        if (testInstance instanceof TestClassCleanup) {
            ((TestClassCleanup) testInstance).cleanup();
        }
    }
}

afterTestClass会在整个测试类的所有测试方法执行完成后调用，此时testContext.getTestInstance()返回最后一个测试方法使用的实例（已完成Spring依赖注入），可安全调用清理方法。

方案2：@AfterAll + 静态Bean持有者 #

利用JUnit 5的@AfterAll（PER_METHOD模式下需为静态方法），通过静态变量持有Spring Bean实例：

@SpringBootTest
@TestInstance(Lifecycle.PER_METHOD)
public class StatefulTest {

    @Autowired
    private SomeBean someBean;

    // 静态变量持有Bean实例（上下文共享单例，无线程安全问题）
    private static SomeBean staticCleanupBean;

    @BeforeEach
    void setUp() {
        // 每次测试前更新静态变量
        staticCleanupBean = this.someBean;
    }

    @Test
    @Order(1)
    void testFirst() {
        // 测试逻辑
    }

    @Test
    @Order(2)
    void testLast() {
        // 测试逻辑
    }

    @AfterAll
    static void cleanup() {
        if (staticCleanupBean != null) {
            staticCleanupBean.clearSharedState();
        }
    }
}

该方案无需额外编写扩展类，适合简单场景，但依赖静态变量持有Bean。

方案3：全局Spring事件监听 #

通过Spring的ApplicationListener监听测试类执行完成事件，全局生效：

1. 实现事件监听器

@Component
public class GlobalTestCleanupListener implements ApplicationListener<TestContextEvent> {

    @Override
    public void onApplicationEvent(TestContextEvent event) {
        // 监听测试类执行完成事件
        if (event instanceof AfterTestClassEvent) {
            TestContext testContext = ((AfterTestClassEvent) event).getTestContext();
            Object testInstance = testContext.getTestInstance();
            if (testInstance instanceof TestClassCleanup) {
                ((TestClassCleanup) testInstance).cleanup();
            }
        }
    }
}

2. 测试类只需实现标记接口
   无需额外注册Listener，监听器会被Spring自动发现并生效：

@SpringBootTest
@TestInstance(Lifecycle.PER_METHOD)
public class StatefulTest implements TestClassCleanup {
    // ... 测试方法和cleanup实现
}

方案对比 #

内容的提问来源于stack exchange，提问作者Pablo Cavalieri