JUnit 5 Suite类中使用RegisterExtension管理外部资源遇问题

问题根源 #

JUnit 5的@RegisterExtension注解在套件类中默认不会被自动识别执行，因为套件的生命周期管理逻辑和普通测试类不同。你当前的写法是把普通测试类的扩展用法直接套在了套件类上，所以beforeAll方法不会触发。

正确实现方式 #

有两种可行的修复方案：

方案1：使用@SuiteExtension注解（JUnit 5.10+） #

如果你的JUnit 5版本是5.10或更高，推荐使用专门的套件扩展注解：

1. 修改JUnit5Server类，实现SuiteExtension接口（替代BeforeAllCallback和AfterAllCallback）：

import org.junit.platform.suite.api.SuiteExtension;
import org.junit.platform.suite.api.SuiteExtensionContext;

public class JUnit5Server implements SuiteExtension {
    @Override
    public void beforeSuite(SuiteExtensionContext context) throws Exception {
        // 启动服务器逻辑
    }

    @Override
    public void afterSuite(SuiteExtensionContext context) throws Exception {
        // 停止服务器逻辑
    }
}

2. 在套件类上直接用@SuiteExtension注册扩展：

import org.junit.platform.suite.api.SelectClasses;
import org.junit.platform.suite.api.Suite;
import org.junit.platform.suite.api.SuiteExtension;

@Suite
@SelectClasses({FirstTest.class, SecondTest.class})
@SuiteExtension(JUnit5Server.class)
public class JUnit5Suite {
    // 无需静态字段，@SuiteExtension会自动实例化并执行扩展逻辑
    // 若需在测试中访问服务器实例，可通过SuiteExtensionContext存储
}

方案2：通过ExtensionContext存储实例（兼容旧版本） #

如果你的JUnit 5版本低于5.10，可通过扩展注册+上下文存储的方式实现：

1. 保持JUnit5Server实现BeforeAllCallback和AfterAllCallback，调整逻辑以共享实例：

import org.junit.jupiter.api.extension.AfterAllCallback;
import org.junit.jupiter.api.extension.BeforeAllCallback;
import org.junit.jupiter.api.extension.ExtensionContext;

public class JUnit5Server implements BeforeAllCallback, AfterAllCallback {
    private static JUnit5Server instance;

    public static JUnit5Server getInstance() {
        return instance;
    }

    @Override
    public void beforeAll(ExtensionContext context) throws Exception {
        instance = this;
        // 启动服务器逻辑
    }

    @Override
    public void afterAll(ExtensionContext context) throws Exception {
        // 停止服务器逻辑
        instance = null;
    }
}

2. 在套件类上使用@ExtendWith注册扩展：

import org.junit.platform.suite.api.SelectClasses;
import org.junit.platform.suite.api.Suite;
import org.junit.jupiter.api.extension.ExtendWith;

@Suite
@SelectClasses({FirstTest.class, SecondTest.class})
@ExtendWith(JUnit5Server.class)
public class JUnit5Suite {
    // 测试类中通过JUnit5Server.getInstance()获取服务器实例
}

补充说明 #

• 确保项目依赖了正确的JUnit Platform Suite Engine，以Maven为例：

<dependency>
    <groupId>org.junit.platform</groupId>
    <artifactId>junit-platform-suite-engine</artifactId>
    <version>你的JUnit5版本</version>
    <scope>test</scope>
</dependency>

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