JUnit5：多测试场景下测试扩展注入为空问题

我在搭建多数据库测试套件时遇到了JUnit5参数化测试与扩展配合的问题：目标是让抽象测试类ADaoTest能注入对应数据库的扩展资源，实现一套测试逻辑适配多数据库的场景。手动遍历测试资源时一切正常，但使用参数化测试时，方法源里的getResource()会返回null，还偶尔出现首次运行后空值的非确定性问题。需要在不改变现有类结构的前提下解决该问题。

测试目录结构 #

.
└── daoimpl/
    └── src/
        ├── main/
        │   ├── java/
        │   │   └── ...
        │   └── resources/
        │       └── ...
        └── test/
            ├── java/
            │   └── com/
            │       └── foo/
            │           └── baz/
            │               ├── dao/
            │               │   ├── ADaoTest.java
            │               │   ├── Db1DaoTest.java
            │               │   └── Db2DaoTest.java
            │               └── resources/
            │                   ├── ATestResource.java
            │                   ├── Db1TestResource.java
            │                   └── Db2TestResource.java
            └── resources/
                └── ... // test context configurations

相关类代码 #

ATestResource.java #

@ExtendWith(SpringExtension.class)
public abstract class ATestResource implements AfterEachCallback, BeforeEachCallback {

    public List<String> schemas;

    public Map<String, List<Table>> tables;
}

Db1TestResource.java #

public final class Db1TestResource extends ATestResource {

    @Override
    public void afterEach(ExtensionContext context) {
        // NOP
    }

    @Override
    public void beforeEach(ExtensionContext context) {
        initSchemas();
        initTables();
    }
}

ADaoTest.java #

@ExtendWith(SpringExtension.class)
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
public abstract class ADaoTest {

    @Autowired
    DaoImpl dao;

    abstract ATestResource getResource();

    private Stream<Arguments> prepareSchemas() {
        return getResource().schemas.stream()
                .map(Arguments::of);
    }

    @ParameterizedTest
    @MethodSource("prepareSchemas")
    void getAllTablesForDefinedSchemasTest(String schema) {
        final List<Table> extractedTables = dao.getAllTablesBySchema(schema);
        assertTables(getResource().tables.get(schema), extractedTables);
    }
    // ...more tests
}

Db1DaoTest.java #

@ExtendWith(Db1TestResource.class)
@ContextConfiguration(locations = { "/Db1DaoTest.xml" })
class Db1DaoTest extends ADaoTest {

    @RegisterExtension
    Db1TestResource testResource = new Db1TestResource();

    @Override
    Db1TestResource getResource() {
        return testResource;
    }
}

问题核心 #

使用@ParameterizedTest时，prepareSchemas()方法中调用getResource()返回null，且偶尔在首次测试运行后出现空值，表现出非确定性。本质原因是JUnit5参数化测试的方法源（MethodSource）执行时机早于@RegisterExtension字段的初始化，同时@ExtendWith注册的扩展是类级别的，无法直接通过实例方法获取有效实例。

解决方案 #

方案1：通过ExtensionContext获取@RegisterExtension实例 #

修改ADaoTest，通过反射从测试实例中获取标记了@RegisterExtension的资源字段，避免依赖未初始化的实例变量：

修改ADaoTest.java

@ExtendWith(SpringExtension.class)
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
public abstract class ADaoTest {

    @Autowired
    DaoImpl dao;

    // 从ExtensionContext中获取已注册的扩展实例
    private <T extends ATestResource> T getResource(ExtensionContext context) {
        return context.getRequiredTestInstance()
                .getClass()
                .getDeclaredFields()
                .stream()
                .filter(field -> ATestResource.class.isAssignableFrom(field.getType()))
                .filter(field -> field.isAnnotationPresent(RegisterExtension.class))
                .map(field -> {
                    try {
                        field.setAccessible(true);
                        return (T) field.get(context.getRequiredTestInstance());
                    } catch (IllegalAccessException e) {
                        throw new RuntimeException(e);
                    }
                })
                .findFirst()
                .orElseThrow(() -> new IllegalStateException("No ATestResource extension found"));
    }

    // 方法源接收ExtensionContext参数
    private Stream<Arguments> prepareSchemas(ExtensionContext context) {
        return getResource(context).schemas.stream()
                .map(Arguments::of);
    }

    @ParameterizedTest
    @MethodSource("prepareSchemas")
    void getAllTablesForDefinedSchemasTest(String schema, ExtensionContext context) {
        final List<Table> extractedTables = dao.getAllTablesBySchema(schema);
        assertTables(getResource(context).tables.get(schema), extractedTables);
    }
    // ...more tests
}

修改Db1DaoTest.java（移除重复的@ExtendWith）

@ContextConfiguration(locations = { "/Db1DaoTest.xml" })
class Db1DaoTest extends ADaoTest {

    @RegisterExtension
    Db1TestResource testResource = new Db1TestResource();
}

方案2：将扩展实例存入ExtensionContext存储区 #

在资源类的beforeEach方法中，把实例存入JUnit5的扩展存储区，后续测试方法和方法源从存储区获取：

修改ATestResource.java

@ExtendWith(SpringExtension.class)
public abstract class ATestResource implements AfterEachCallback, BeforeEachCallback {

    public List<String> schemas;

    public Map<String, List<Table>> tables;

    @Override
    public void beforeEach(ExtensionContext context) {
        initSchemas();
        initTables();
        // 将当前实例存入命名空间存储区
        context.getStore(ExtensionContext.Namespace.create(getClass()))
                .put("resource", this);
    }
}

修改ADaoTest.java

@ExtendWith(SpringExtension.class)
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
public abstract class ADaoTest {

    @Autowired
    DaoImpl dao;

    // 新增抽象方法，返回对应资源类
    abstract Class<? extends ATestResource> getResourceClass();

    // 从存储区获取资源实例
    private <T extends ATestResource> T getResource(ExtensionContext context) {
        return context.getStore(ExtensionContext.Namespace.create(getResourceClass()))
                .get("resource", getResourceClass());
    }

    private Stream<Arguments> prepareSchemas(ExtensionContext context) {
        return getResource(context).schemas.stream()
                .map(Arguments::of);
    }

    @ParameterizedTest
    @MethodSource("prepareSchemas")
    void getAllTablesForDefinedSchemasTest(String schema, ExtensionContext context) {
        final List<Table> extractedTables = dao.getAllTablesBySchema(schema);
        assertTables(getResource(context).tables.get(schema), extractedTables);
    }
    // ...more tests
}

修改Db1DaoTest.java

@ExtendWith(Db1TestResource.class)
@ContextConfiguration(locations = { "/Db1DaoTest.xml" })
class Db1DaoTest extends ADaoTest {

    @Override
    Class<Db1TestResource> getResourceClass() {
        return Db1TestResource.class;
    }
}

关键说明 #

两种方案都无需修改核心类结构，仅调整方法实现：

1. 方案1通过反射直接从测试实例中获取已注册的扩展字段，确保拿到初始化后的实例
2. 方案2利用JUnit5的扩展存储区，在beforeEach（资源初始化完成后）存入实例，后续环节安全读取

内容的提问来源于stack exchange，提问作者michal.kyjovsky