在使用 JUnit 5 时，@ExtendWith 注解用于扩展测试类的功能，使你能够通过加载自定义的扩展类，增强测试用例的行为。JUnit 5 引入了扩展模型（Extension Model），@ExtendWith 是这一模型的核心注解，允许你在测试执行过程中通过扩展类进行额外的操作，如注入依赖、拦截生命周期事件、修改测试方法执行流程等。
@ExtendWith 注解的作用
@ExtendWith 的主要功能是注册一个或多个扩展类（Extension Classes）。这些扩展类实现了 JUnit 5 的扩展接口（如 BeforeEachCallback, AfterEachCallback 等），从而可以在测试的不同生命周期阶段执行额外逻辑。该注解可以用于测试类或测试方法上。
扩展模型的作用场景
扩展模型为测试提供了非常强大的功能，常见的应用场景包括：
- 依赖注入: 使用扩展类注入测试所需的资源或对象，类似于 Spring 的依赖注入。
- 生命周期管理: 在测试类的生命周期中的不同阶段（如测试前准备、测试后清理）执行自定义操作。
- Mock 对象注入: 可以通过扩展类集成类似于 Mockito 的 Mock 框架，自动生成 Mock 对象。
- 参数化测试: 提供自定义的参数解析和注入逻辑。
- 自定义断言: 扩展测试行为，生成定制化的断言或日志。
如何使用 @ExtendWith
1. 基本用法
假设你有一个自定义扩展类 MyCustomExtension，它实现了 JUnit 5 的扩展接口：
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.BeforeEachCallback;
public class MyCustomExtension implements BeforeEachCallback {
@Override
public void beforeEach(ExtensionContext context) throws Exception {
System.out.println("Before each test");
}
}
然后在测试类中使用 @ExtendWith 注解来注册该扩展：
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
@ExtendWith(MyCustomExtension.class)
public class MyTest {
@Test
void testExample() {
System.out.println("Test is running");
}
}
输出:
Before each test
Test is running
在这个例子中，MyCustomExtension 的 beforeEach 方法会在每个测试方法执行前运行。
2. 与多个扩展一起使用
你可以通过 @ExtendWith 注解注册多个扩展类：
@ExtendWith({MyCustomExtension.class, AnotherExtension.class})
public class MyTest {
// 测试代码
}
这样可以同时使用多个扩展，分别处理不同的测试逻辑。
3. 在测试方法上使用
除了在类级别使用 @ExtendWith，你还可以在测试方法级别使用，作用范围仅限于指定的方法：
@ExtendWith(MyCustomExtension.class)
public class MyTest {
@Test
@ExtendWith(AnotherExtension.class) // 仅对这个方法生效
void testExample() {
// 测试代码
}
}
常用扩展接口
JUnit 5 提供了许多内置的扩展接口供你实现，下面是一些常用的扩展接口：
BeforeAllCallback和AfterAllCallback: 在所有测试方法执行前或执行后执行逻辑。BeforeEachCallback和AfterEachCallback: 在每个测试方法执行前或执行后执行逻辑。TestExecutionExceptionHandler: 拦截和处理测试执行中的异常。ParameterResolver: 提供参数解析逻辑，允许在测试方法中注入参数。ExecutionCondition: 动态控制是否执行测试方法或测试类（例如基于运行环境跳过某些测试）。
常见的扩展示例
-
MockitoExtension: 当你使用 Mockito 进行单元测试时，
MockitoExtension通过@ExtendWith注解可以自动管理@Mock注解和@InjectMocks的对象。@ExtendWith(MockitoExtension.class) public class MyMockTest { @Mock MyService myService; @InjectMocks MyController myController; @Test void testService() { // 测试代码 } } -
SpringExtension: 当使用 Spring 框架进行集成测试时，
SpringExtension允许将 Spring 的上下文注入到测试类中。@ExtendWith(SpringExtension.class) @ContextConfiguration(classes = MyConfig.class) public class MySpringTest { @Autowired MyService myService; @Test void testService() { // 使用 Spring 注入的 myService } }
总结
@ExtendWith的作用: 用于注册扩展类，增强测试的功能，通过扩展机制定制化测试的执行流程。- 应用场景: 依赖注入、Mock 框架集成、生命周期管理、参数化测试、自定义断言等。
- 扩展类: 可以实现 JUnit 5 提供的扩展接口（如
BeforeEachCallback、AfterEachCallback等），以实现定制化的逻辑。
通过 @ExtendWith，你可以大幅增强 JUnit 5 的功能，适应复杂的测试需求。