Log4j如何为每个测试用例生成独立日志文件？

问题根源 #

Log4j2默认的LoggerContext是JVM级别的单例，当你在每个测试类的@BeforeClass中调用Configurator.initialize时，后续测试类的初始化会覆盖之前的配置（包括日志文件路径），而且旧的日志Appender可能未被正确关闭，导致所有测试日志都写入最后一个初始化的文件中。

具体解决步骤 #

1. 修改Log4j2配置文件，支持动态日志文件名

将log4j2.xml中的File Appender的fileName改为系统变量占位符，方便每个测试类动态设置：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <!-- 使用系统变量动态指定日志文件名 -->
        <File name="LogFile" fileName="${sys:test.log.file}" append="false">
            <PatternLayout pattern="%d [%t] %-5p %c %x - %m%n" />
        </File>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console" />
            <AppenderRef ref="LogFile" />
        </Root>
    </Loggers>
</Configuration>

2. 重构BaseClass的日志初始化与清理逻辑

在BaseClass中，不仅要在测试前初始化日志，还要在测试后彻底清理Log4j2上下文，避免后续测试受影响：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.LoggerContext;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;

public class BaseClass {

    @BeforeClass
    public static void setUpLogging() {
        // 获取当前测试类的类名，生成专属日志文件
        String testClassName = new Throwable().getStackTrace()[1].getClassName();
        String logFilePath = "src//test//resources//logs//" + testClassName + ".log";
        
        // 设置系统变量，指定当前测试类的日志文件路径
        System.setProperty("test.log.file", logFilePath);
        
        // 重新配置Log4j2上下文，加载新的配置
        LoggerContext context = (LoggerContext) LogManager.getContext(false);
        context.reconfigure();
    }

    @AfterClass
    public static void tearDownLogging() {
        // 获取当前LoggerContext并停止，关闭所有Appender
        LoggerContext context = (LoggerContext) LogManager.getContext(false);
        context.stop();
        
        // 清除系统变量，避免影响下一个测试类
        System.clearProperty("test.log.file");
    }
}

3. 关键注意点

• 不要重复调用Configurator.initialize，改用context.reconfigure()：前者会创建新的上下文实例，但旧上下文不会自动关闭，容易导致文件句柄泄漏和日志混乱；后者会在现有上下文上重新加载配置，更安全。
• 确保每个测试类的日志文件名唯一：用测试类名作为文件名的一部分，从根本上避免日志覆盖。
• 如果使用并行测试：可以在文件名中加入线程ID或随机字符串，进一步避免冲突，比如logFilePath = "src//test//resources//logs//" + testClassName + "_" + Thread.currentThread().getId() + ".log";

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