JUnit5如何实现Suite级别的全局前置与后置逻辑？

一、实现Suite级别全局前置后置逻辑的可行方案 #

方案1：使用JUnit5官方@Suite配合静态@BeforeAll/@AfterAll #

首先确保引入必要依赖（以Maven为例）：

<dependency>
    <groupId>org.junit.platform</groupId>
    <artifactId>junit-platform-suite-api</artifactId>
    <version>5.10.0</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.junit.platform</groupId>
    <artifactId>junit-platform-suite-engine</artifactId>
    <version>5.10.0</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-api</artifactId>
    <version>5.10.0</version>
    <scope>test</scope>
</dependency>

编写Suite类，注意**@BeforeAll和@AfterAll必须为静态方法**，通过@Suite指定要包含的测试类：

import org.junit.platform.suite.api.SelectClasses;
import org.junit.platform.suite.api.Suite;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.AfterAll;

@Suite
@SelectClasses({TestClass1.class, TestClass2.class})
public class GlobalTestSuite {

    @BeforeAll
    public static void globalSetup() {
        // 全局初始化逻辑，仅在所有测试类执行前运行一次
        System.out.println("=== 全局前置初始化开始 ===");
        // 示例：初始化数据库连接、启动测试服务等
    }

    @AfterAll
    public static void globalTeardown() {
        // 全局清理逻辑，仅在所有测试类执行完成后运行一次
        System.out.println("=== 全局后置清理完成 ===");
        // 示例：关闭数据库连接、停止测试服务等
    }
}

测试类示例（TestClass1）：

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.BeforeEach;

public class TestClass1 {

    @BeforeEach
    void setUp() {
        System.out.println("TestClass1 单测前置准备");
    }

    @Test
    void testMethod1() {
        System.out.println("执行 TestClass1.testMethod1");
    }

    @Test
    void testMethod2() {
        System.out.println("执行 TestClass1.testMethod2");
    }
}

执行Suite类的输出顺序：

=== 全局前置初始化开始 ===
TestClass1 单测前置准备
执行 TestClass1.testMethod1
TestClass1 单测前置准备
执行 TestClass1.testMethod2
TestClass2 单测前置准备
执行 TestClass2.testMethod1
...
=== 全局后置清理完成 ===

方案2：自定义Extension结合@Suite（复杂场景适配） #

如果需要更灵活的逻辑控制，可以自定义Extension实现Suite级别的前后置：

自定义Extension类：

import org.junit.jupiter.api.extension.BeforeAllCallback;
import org.junit.jupiter.api.extension.AfterAllCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.platform.suite.api.Suite;

public class GlobalSuiteExtension implements BeforeAllCallback, AfterAllCallback {

    @Override
    public void beforeAll(ExtensionContext context) throws Exception {
        // 仅作用于Suite级别
        if (context.getTestClass().isPresent() && context.getTestClass().get().isAnnotationPresent(Suite.class)) {
            System.out.println("=== 自定义Extension全局前置初始化 ===");
        }
    }

    @Override
    public void afterAll(ExtensionContext context) throws Exception {
        if (context.getTestClass().isPresent() && context.getTestClass().get().isAnnotationPresent(Suite.class)) {
            System.out.println("=== 自定义Extension全局后置清理 ===");
        }
    }
}

在Suite类上注册Extension：

@Suite
@SelectClasses({TestClass1.class, TestClass2.class})
@ExtendWith(GlobalSuiteExtension.class)
public class GlobalTestSuite {
    // 逻辑已在Extension中实现，无需额外编写@BeforeAll/@AfterAll
}

方案3：使用LauncherSessionListener（全局测试会话级别） #

如果需要对整个测试会话（所有Suite）做初始化/清理，可自定义LauncherSessionListener：

1. 自定义Listener类：

import org.junit.platform.launcher.LauncherSession;
import org.junit.platform.launcher.LauncherSessionListener;

public class GlobalLauncherListener implements LauncherSessionListener {

    @Override
    public void launcherSessionOpened(LauncherSession session) {
        // 所有测试启动前执行
        System.out.println("=== 全局测试会话启动，初始化 ===");
    }

    @Override
    public void launcherSessionClosed(LauncherSession session) {
        // 所有测试结束后执行
        System.out.println("=== 全局测试会话结束，清理 ===");
    }
}

2. 通过SPI注册：在src/test/resources/META-INF/services下创建文件org.junit.platform.launcher.LauncherSessionListener，内容为自定义Listener的全类名：

com.yourpackage.GlobalLauncherListener

二、自定义TestExecutionListener未触发的原因 #

1. SPI注册缺失：
   JUnit5通过SPI加载TestExecutionListener，需在src/test/resources/META-INF/services下创建org.junit.platform.launcher.TestExecutionListener文件，写入自定义Listener的全类名。

2. 方法重写错误：
   需确保正确重写TestExecutionListener的方法（如testPlanExecutionStarted、testPlanExecutionFinished），而非错误实现其他接口方法。

3. 测试引擎不兼容：
   TestExecutionListener是JUnit Platform级别的接口，若使用的测试引擎不是JUnit Jupiter（如JUnit Vintage），会导致Listener不生效。

4. 配置过滤问题：
   检查junit-platform.properties中是否设置了junit.platform.listeners.deactivate属性，该属性可能禁用了自定义Listener。

5. 类路径问题：
   自定义Listener的类必须在测试类路径下，否则JUnit无法加载该类。

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