如何在Spring的TestExecutionListener中获取JUnit5的TestInstance.Lifecycle

要正确获取测试实例的生命周期（包括通过注解、全局属性或系统环境配置的默认值），可以借助JUnit Jupiter提供的TestInstanceLifecycleUtils工具类，它能按照JUnit 5的优先级规则解析最终生效的生命周期配置。

具体实现步骤 #

1. 确保依赖完整性：项目中需包含junit-jupiter-api依赖（Spring Boot项目通常已通过spring-boot-starter-test间接引入）。
2. 在TestExecutionListener中调用工具类：从TestContext获取测试类后，使用TestInstanceLifecycleUtils.getDefaultLifecycle()方法获取最终的生命周期。

代码示例 #

import org.springframework.test.context.TestContext;
import org.springframework.test.context.TestExecutionListener;
import org.junit.jupiter.api.TestInstance;
import org.junit.jupiter.api.TestInstance.Lifecycle;
import org.junit.jupiter.api.support.TestInstanceLifecycleUtils;

public class CustomTestExecutionListener implements TestExecutionListener {

    @Override
    public void afterTestMethod(TestContext testContext) throws Exception {
        // 获取测试类
        Class<?> testClass = testContext.getTestClass();
        // 解析最终生效的生命周期
        Lifecycle lifecycle = TestInstanceLifecycleUtils.getDefaultLifecycle(testClass);
        
        // 根据生命周期做后续处理
        if (Lifecycle.PER_CLASS.equals(lifecycle)) {
            // PER_CLASS 逻辑
        } else {
            // PER_METHOD 逻辑
        }
    }
}

原理说明 #

TestInstanceLifecycleUtils会严格遵循JUnit 5的生命周期解析优先级：

• 优先读取测试类上直接标注的@TestInstance注解指定的生命周期
• 若未标注，则读取全局配置属性junit.jupiter.testinstance.lifecycle.default（支持通过系统变量、环境变量、junit-platform.properties等方式配置）
• 上述都未配置时，默认使用PER_METHOD

这种方式覆盖了所有可能的生命周期配置场景，比直接读取注解的方法更完善。

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