Maven Surefire中Log4j2自定义Appender能否跨线程复用？

问题根源 #

1. 静态Extension实例冲突：测试类中使用static LoggerExtension，Surefire并行测试时多个测试线程共享同一个实例，outContent被多线程交叉重置/覆盖，导致日志丢失。
2. Log4j2上下文全局共享：LogManager.getContext(false)获取的是进程级的LoggerContext，所有测试线程共用同一套日志配置。同名Appender会被后注册的覆盖，afterEach移除Appender时也会误删其他测试的有效Appender。
3. 资源隔离不足：未为每个测试用例分配独立的日志输出流和Appender，多线程下资源竞争导致日志无法正确捕获。

解决方案 #

核心修改点 #

• 取消Extension的静态声明，让每个测试实例拥有独立的Extension对象。
• 利用JUnit5的ExtensionContext.Store存储每个测试专属的输出流和Appender名称，实现完全隔离。
• 为每个测试生成唯一的Appender名称，避免全局配置中的名称冲突。
• 完善Appender的清理逻辑，确保测试结束后彻底移除并销毁资源。

修改后的LoggerExtension代码 #

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.appender.WriterAppender;
import org.apache.logging.log4j.core.config.Configuration;
import org.junit.jupiter.api.extension.AfterEachCallback;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.assertj.core.api.Assertions;

import java.io.ByteArrayOutputStream;
import java.io.OutputStreamWriter;
import java.util.UUID;

public class LoggerExtension implements BeforeEachCallback, AfterEachCallback {

    // 为每个测试生成唯一的Appender名称前缀
    private static final String APPENDER_NAME_PREFIX = "TestAppender-";

    @Override
    public void beforeEach(ExtensionContext context) {
        // 创建当前测试专属的输出流
        ByteArrayOutputStream outContent = new ByteArrayOutputStream();
        // 生成唯一的Appender名称
        String appenderName = APPENDER_NAME_PREFIX + UUID.randomUUID();

        // 获取Log4j2上下文
        LoggerContext loggerContext = (LoggerContext) LogManager.getContext(false);
        Configuration config = loggerContext.getConfiguration();

        // 配置并添加专属Appender
        Appender appender = WriterAppender.newBuilder()
                .setName(appenderName)
                .setTarget(new OutputStreamWriter(outContent))
                .setLayout(config.getDefaultLayout()) // 确保使用当前配置的布局
                .build();
        appender.start();
        config.addAppender(appender);
        // 将Appender关联到根日志器
        config.getRootLogger().addAppender(appender, Level.INFO, null);
        loggerContext.updateLoggers();

        // 将输出流和Appender名称存入当前测试的上下文存储，确保隔离
        ExtensionContext.Store store = context.getStore(ExtensionContext.Namespace.create(getClass(), context.getUniqueId()));
        store.put("outContent", outContent);
        store.put("appenderName", appenderName);
    }

    @Override
    public void afterEach(ExtensionContext context) {
        ExtensionContext.Store store = context.getStore(ExtensionContext.Namespace.create(getClass(), context.getUniqueId()));
        String appenderName = store.get("appenderName", String.class);
        if (appenderName == null) {
            return;
        }

        LoggerContext loggerContext = (LoggerContext) LogManager.getContext(false);
        Configuration config = loggerContext.getConfiguration();
        Appender appender = config.getAppender(appenderName);

        // 彻底清理Appender：移除关联、停止、删除
        config.getRootLogger().removeAppender(appenderName);
        if (appender != null) {
            appender.stop();
            config.removeAppender(appenderName);
        }
        loggerContext.updateLoggers();

        // 清理存储中的资源
        store.remove("outContent");
        store.remove("appenderName");
    }

    public void verifyMessage(ExtensionContext context, String message) {
        ExtensionContext.Store store = context.getStore(ExtensionContext.Namespace.create(getClass(), context.getUniqueId()));
        ByteArrayOutputStream outContent = store.get("outContent", ByteArrayOutputStream.class);
        Assertions.assertThat(outContent.toString()).contains(message);
    }
}

测试用例修改 #

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

public class TestCase {
    // 取消static，每个测试实例拥有独立的Extension
    @RegisterExtension
    public LoggerExtension logVerifier = new LoggerExtension();

    @Test
    public void shouldDoSomething(ExtensionContext context) {
        // 产生日志的业务代码
        // ...

        // 传入ExtensionContext获取当前测试的专属输出流
        logVerifier.verifyMessage(context, "match the log string");
    }
}

关键修改解释 #

1. 非静态Extension实例：每个测试类实例对应一个LoggerExtension，避免多线程共享同一outContent。
2. 唯一Appender名称：通过UUID生成唯一名称，彻底解决多线程下Appender覆盖问题。
3. ExtensionContext存储：使用JUnit5的上下文存储保存每个测试的私有资源，确保线程隔离，不会被其他测试干扰。
4. 完善的清理逻辑：测试结束后停止Appender、从配置中删除，避免资源泄漏。

额外建议 #

如果需要保留reuseForks=true以提升测试速度，可结合Surefire的并行配置优化：

<!-- pom.xml中Surefire配置示例 -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>3.2.5</version>
    <configuration>
        <parallel>methods</parallel>
        <threadCount>4</threadCount>
        <reuseForks>true</reuseForks>
        <forkCount>2</forkCount>
    </configuration>
</plugin>

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