JUnit 5中替换@Rule：使用@BeforeEach和自定义扩展

在junit 4中，@rule注解提供了一种灵活的方式来在测试生命周期中注入行为，例如资源管理或测试状态监控。testwatcher是一个常见的@rule实现，允许开发者在测试开始、成功、失败或跳过时执行特定操作。然而，junit 5引入了全新的扩展模型，取代了junit 4的@rule和@classrule。本文将重点讲解如何在junit 5中实现类似testwatcher的starting方法功能，即在每个测试方法开始前执行特定逻辑。

1. 使用 @BeforeEach 注解进行简单配置

对于只需要在每个测试方法执行前简单记录日志或执行一些初始化操作的场景，JUnit 5提供了@BeforeEach注解。这个注解标记的方法会在当前测试类中的每一个@Test方法执行前运行。

@BeforeEach注解修饰的方法可以接收TestInfo类型的参数。TestInfo对象提供了关于当前正在执行的测试的信息，例如测试类的显示名称、测试方法的名称等。这使得我们能够像在JUnit 4的TestWatcher.starting(Description description)中那样，获取并利用测试方法的详细信息。

示例代码：

import java.lang.reflect.Method;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInfo;
import org.slf4j.Logger; // 假设使用SLF4J作为日志框架
import org.slf4j.LoggerFactory;

class ExampleTests {

  // 初始化日志记录器
  private static final Logger logger = LoggerFactory.getLogger(ExampleTests.class);

  @BeforeEach
  void logStartOfTest(TestInfo info) {
    // 使用TestInfo获取测试方法的名称
    String methodName = info.getMethod().map(Method::getName).orElse("Unknown Method");
    logger.info("STARTING test: " + methodName);
  }

  @Test
  void testFoo() {
    logger.info("Executing testFoo()");
    // 执行测试断言
  }

  @Test
  void testBar() {
    logger.info("Executing testBar()");
    // 执行测试断言
  }
}

代码解析：

百度文心百中

百度大模型语义搜索体验中心

22

查看详情

• @BeforeEach注解确保logStartOfTest方法在每个@Test方法前被调用。
• TestInfo info参数由JUnit 5自动注入，提供了当前测试的上下文信息。
• info.getMethod().map(Method::getName).orElse("Unknown Method")安全地获取测试方法的名称。

这种方法适用于单个测试类内部的简单前置逻辑。如果需要在多个测试类中复用相同的逻辑，或者逻辑更为复杂，那么自定义扩展是更好的选择。

2. 创建自定义扩展实现 BeforeEachCallback

JUnit 5的扩展模型是其核心特性之一，它允许开发者通过实现特定的扩展接口来钩入测试生命周期的各个阶段。要实现类似TestWatcher.starting的功能，我们可以创建一个自定义扩展，实现BeforeEachCallback接口。

BeforeEachCallback接口定义了一个beforeEach(ExtensionContext context)方法，该方法会在每个测试方法执行前被调用。ExtensionContext参数提供了比TestInfo更丰富的上下文信息，包括测试类、测试方法、测试实例等。

步骤一：创建自定义扩展类

import java.lang.reflect.Method;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class MyLoggingExtension implements BeforeEachCallback {

    // 扩展类通常也需要自己的日志记录器
    private static final Logger logger = LoggerFactory.getLogger(MyLoggingExtension.class);

    @Override
    public void beforeEach(ExtensionContext context) {
        // 使用ExtensionContext获取测试方法的名称
        String methodName = context.getTestMethod().map(Method::getName).orElse("Unknown Method");
        String className = context.getTestClass().map(Class::getName).orElse("Unknown Class");
        logger.info("STARTING test: " + className + "#" + methodName);
    }
}

代码解析：

• MyLoggingExtension实现了BeforeEachCallback接口。
• beforeEach方法在每个测试方法执行前被调用。
• ExtensionContext context提供了测试的详细信息，context.getTestMethod()用于获取当前测试方法。

步骤二：在测试类中应用扩展

创建完扩展类后，可以通过@ExtendWith注解将其应用到测试类上。

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@ExtendWith(MyLoggingExtension.class) // 应用自定义扩展
class ExtendedExampleTests {

    private static final Logger logger = LoggerFactory.getLogger(ExtendedExampleTests.class);

    @Test
    void testFooWithExtension() {
        logger.info("Executing testFooWithExtension()");
        // perform assertions
    }

    @Test
    void testBarWithExtension() {
        logger.info("Executing testBarWithExtension()");
        // perform assertions
    }
}

代码解析：

• @ExtendWith(MyLoggingExtension.class)注解告诉JUnit 5在运行ExtendedExampleTests类中的测试时，应用MyLoggingExtension。
• 这样，MyLoggingExtension中定义的beforeEach逻辑就会在testFooWithExtension()和testBarWithExtension()执行前自动运行。

这种方式的优点在于：

• 可复用性： MyLoggingExtension可以被应用到任何需要相同前置逻辑的测试类中。
• 解耦： 测试逻辑与前置处理逻辑分离，使得代码更清晰。
• 灵活性： 一个扩展类可以实现多个扩展接口，以处理测试生命周期中的不同阶段。

3. 扩展阅读：其他生命周期回调

除了BeforeEachCallback，JUnit 5还提供了其他丰富的扩展接口，用于处理测试生命周期的不同阶段，例如：

• AfterEachCallback：在每个测试方法执行后调用。
• BeforeAllCallback：在所有测试方法执行前调用一次。
• AfterAllCallback：在所有测试方法执行后调用一次。
• TestWatcher：这是一个更高级的接口，允许监控测试的成功、失败、跳过等状态。它提供了testDisabled, testSuccessful, testAborted, testFailed等方法。需要注意的是，TestWatcher接口在JUnit 5.7版本才成为稳定API。

如果需要监控测试的最终结果（例如，测试是成功还是失败），可以实现org.junit.jupiter.api.extension.TestWatcher接口。

总结

JUnit 5通过其强大的扩展模型，提供了比JUnit 4 @Rule更灵活、更强大的测试生命周期管理能力。对于简单的测试前置逻辑，可以直接使用@BeforeEach注解配合TestInfo参数。而对于需要跨多个测试类复用、或逻辑更为复杂的场景，创建自定义扩展并实现BeforeEachCallback接口，然后通过@ExtendWith注解应用，是更为推荐和专业的做法。掌握这些机制，将有助于构建更健壮、更易于维护的JUnit 5测试套件。

建议开发者查阅官方的JUnit 5用户指南，以获取更全面和详细的扩展模型信息。

以上就是JUnit 5中替换@Rule：使用@BeforeEach和自定义扩展的详细内容，更多请关注php中文网其它相关文章！