Junit5使用教程(4) --扩展模型

JUnit 5扩展模型详解与自定义

原创

已于 2025-02-12 08:23:57 修改 · 859 阅读

18 ·

CC 4.0 BY-SA版权

文章标签：

#junit #java

于 2025-02-05 21:42:34 首次发布

第四部分：JUnit 5 扩展模型

1. JUnit 5 扩展机制概述

JUnit 5 的扩展机制（Extension Model）是其最强大的特性之一，允许开发者通过自定义逻辑干预测试生命周期、增强测试功能，或与第三方框架无缝集成。它通过模块化扩展取代了 JUnit 4 中基于 @RunWith 的单继承模型，提供了更高的灵活性和可维护性。

一、扩展机制的核心思想

非侵入式设计
无需继承特定基类，通过实现接口或使用注解即可插入自定义逻辑。
生命周期钩子
允许在测试的各个阶段（如初始化、执行、清理）插入自定义代码。
组合式扩展
支持同时使用多个扩展，通过 @ExtendWith 注解组合功能。

二、扩展的核心组件

组件	说明
扩展接口	定义扩展行为的接口（如 `BeforeEachCallback`、`ParameterResolver`）。
扩展实现类	实现扩展接口的具体逻辑（如 `MockitoExtension`）。
扩展注册	通过 `@ExtendWith` 注解或配置文件（`ServiceLoader`）注册扩展。

三、常用扩展接口

JUnit 5 提供了多种扩展接口，覆盖测试生命周期的不同阶段：

接口名称	作用阶段	典型场景
`BeforeAllCallback`	所有测试前执行	全局资源初始化
`BeforeEachCallback`	每个测试方法前执行	测试数据准备
`AfterEachCallback`	每个测试方法后执行	清理临时资源
`AfterAllCallback`	所有测试后执行	全局资源释放
`TestExecutionCondition`	动态决定是否执行测试	条件测试（如环境变量检查）
`ParameterResolver`	解析测试方法参数	依赖注入（如 Mock 对象、数据库连接）
`TestWatcher`	监控测试结果（成功、失败、跳过）	日志记录、报告生成
`TestInstanceFactory`	控制测试实例的创建方式	单例模式测试、依赖注入容器集成

四、扩展的注册方式

类级注册
通过 @ExtendWith 注解将扩展附加到测试类：

@ExtendWith(MockitoExtension.class)
class MyTest {
     
     
    // 测试方法
}

方法级注册
针对单个测试方法注册扩展：

class MyTest {
     
     
    @Test
    @ExtendWith(CustomExtension.class)
    void myTest() {
     
      ... }
}

全局注册
通过 META-INF/services 配置文件自动加载扩展，无需显式注解：

# 文件路径：src/test/resources/META-INF/services/org.junit.jupiter.api.extension.Extension
com.example.MyGlobalExtension

同时配置文件junit-platform.properties需要启用自动Extension检测：

# 文件路径：src/test/resources/junit-platform.properties
junit.jupiter.extensions.autodetection.enabled=true

五、扩展的执行顺序

同类型扩展的顺序
JUnit 5 默认不保证相同类型扩展的执行顺序，但可通过 @Order 注解指定优先级：

@Order(1)  // 值越小优先级越高
public class ExtensionA implements BeforeEachCallback {
     
      ... }

扩展与生命周期注解的交互
- @BeforeAll 前：BeforeAllCallback → @BeforeAll
- @BeforeEach 前：BeforeEachCallback → @BeforeEach
- @AfterEach 后：@AfterEach → AfterEachCallback
- @AfterAll 后：@AfterAll → AfterAllCallback

六、自定义扩展的开发步骤

选择扩展接口
根据需求实现对应接口（如 ParameterResolver 用于依赖注入）。
实现接口方法
编写核心逻辑（如解析参数、监控测试状态）。
注册扩展
通过 @ExtendWith 或全局配置启用扩展。

示例：自定义参数解析器

public class RandomNumberResolver implements ParameterResolver {
   
   
    @Override
    public boolean supportsParameter(ParameterContext paramCtx, ExtensionContext extCtx) {
   
   
        return paramCtx.getParameter().getType() == int.class;
    }

    @Override
    public Object resolveParameter(ParameterContext paramCtx, ExtensionContext extCtx) {
   
   
        return new Random().nextInt(100);
    }
}

// 使用扩展
@ExtendWith(RandomNumberResolver.class)
class MyTest {
   
   
    @Test
    void testWithRandomNumber(int number) {
   
   
        Assertions.assertTrue(number >= 0 && number < 100);
    }
}