如何在JUnit 5中替代@Rule注解？

需求回顾 #

你需要替换这段JUnit 4的@Rule实现（用于在测试开始时打印方法名日志）为JUnit 5代码，且不能使用@Rule注解，同时困惑于JUnit 5的ExtendWith和Extension机制。

原JUnit 4代码：

@Rule
public TestWatcher watchman = new TestWatcher() {
    @Override
    public void starting(final Description description) {
        logger.info("STARTING test: " + description.getMethodName());
    }
};

解决方案1：单个测试类快速实现（@BeforeEach + TestInfo） #

如果仅需在单个测试类中实现该逻辑，直接使用JUnit 5的@BeforeEach注解结合TestInfo即可，无需自定义扩展：

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.TestInfo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class YourTestClass {
    private static final Logger logger = LoggerFactory.getLogger(YourTestClass.class);

    @BeforeEach
    void logTestStart(TestInfo testInfo) {
        // 获取测试方法名（如果需要显示完整名称用getDisplayName()）
        String methodName = testInfo.getTestMethod()
                .map(method -> method.getName())
                .orElse("unknown-test-method");
        logger.info("STARTING test: " + methodName);
    }

    // 你的测试方法示例
    // @Test
    // void sampleTest() { ... }
}

解决方案2：全局复用（自定义Extension + @ExtendWith） #

如果需要在多个测试类中复用该日志逻辑，自定义JUnit 5 Extension是更合适的选择：

步骤1：实现自定义Extension

创建一个实现BeforeTestExecutionCallback的扩展类，该接口的方法会在测试方法执行前触发（对应JUnit 4 TestWatcher的starting时机）：

import org.junit.jupiter.api.extension.BeforeTestExecutionCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TestStartLoggingExtension implements BeforeTestExecutionCallback {
    private static final Logger logger = LoggerFactory.getLogger(TestStartLoggingExtension.class);

    @Override
    public void beforeTestExecution(ExtensionContext context) {
        // 直接获取当前测试方法的名称
        String methodName = context.getRequiredTestMethod().getName();
        logger.info("STARTING test: " + methodName);
    }
}

步骤2：在测试类中启用扩展

在需要使用该日志逻辑的测试类上添加@ExtendWith注解：

import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(TestStartLoggingExtension.class)
public class YourTestClass {
    // 你的测试方法示例
    // @Test
    // void sampleTest() { ... }
}

关键说明 #

• JUnit 5没有直接对应JUnit 4 TestWatcher的starting方法，但BeforeTestExecutionCallback的触发时机完全匹配测试开始前的需求。
• ExtensionContext提供了丰富的测试上下文信息，除了方法名，还可以获取测试类、测试标签等内容。

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