Log4j2中如何安全刷新并停止FileAppender避免日志读取异常？

背景 #

测试框架使用Logback的RoutingAppender将每个测试的日志输出到独立文件，配置如下：

Routing:
  - Name: TestCaseRouted
    Routes:
      Pattern: "${ctx:TestCaseId}"
      Route:
        - File:
            Name: TestCaseLogs
            FileName: "${ctx:TestCaseId}.log"
            Append: false
        - key: "${ctx:TestCaseId}"

测试结束后通过Junit5 Extension读取日志文件并上报，核心代码：

// Junit5 extension
public void afterEach(ExtensionContext context) {
    deleteCurrentLogAppender();
    ThreadContext.clearMap();
    final File logFile = new File(getTestCaseId() + ".log");
    if (logFile.exists()) {
        byte[] bytes = FileUtils.readFileToByteArray(logFile); 
        // Publish bytes to reporter
    }
}

private void deleteCurrentLogAppender() {
    final LoggerContext loggerContext = (LoggerContext) LogManager.getContext(false);
    RoutingAppender routingAppender = loggerContext.getConfiguration().getAppender("TestCaseRouted");
    routingAppender.deleteAppender(getTestCaseId());
}

问题现象 #

删除FileAppender（内部调用Appender.stop()）后，仍有未刷新的日志写入文件，甚至出现文件截断，导致读取时抛出IOException: Unexpected read size, current: 4096, expected: 6084，或上报的日志内容不完整。

解决方案 #

1. 配置FileAppender实时刷新 #

修改Logback配置，给FileAppender添加ImmediateFlush: true，强制日志实时写入磁盘，减少内存缓冲：

Routing:
  - Name: TestCaseRouted
    Routes:
      Pattern: "${ctx:TestCaseId}"
      Route:
        - File:
            Name: TestCaseLogs
            FileName: "${ctx:TestCaseId}.log"
            Append: false
            ImmediateFlush: true  # 开启实时刷新
        - key: "${ctx:TestCaseId}"

2. 手动刷新并停止目标FileAppender #

修改deleteCurrentLogAppender方法，先获取对应测试用例的FileAppender，手动刷新缓冲区并停止，再执行删除操作：

private void deleteCurrentLogAppender() {
    final LoggerContext loggerContext = (LoggerContext) LogManager.getContext(false);
    RoutingAppender routingAppender = loggerContext.getConfiguration().getAppender("TestCaseRouted");
    String testCaseId = getTestCaseId();
    // 获取对应测试用例的FileAppender实例
    Appender<?> appender = routingAppender.getAppender(testCaseId);
    
    if (appender instanceof FileAppender) {
        FileAppender<?> fileAppender = (FileAppender<?>) appender;
        try {
            // 手动刷新输出流，确保所有缓冲日志写入磁盘
            fileAppender.getOutputStream().flush();
        } catch (IOException e) {
            e.printStackTrace();
        }
        // 停止Appender，释放相关资源
        fileAppender.stop();
    }
    // 最后删除该Appender
    routingAppender.deleteAppender(testCaseId);
}

3. 读取前等待文件稳定 #

如果仍存在异步写入的情况，可在读取文件前检查文件修改时间，等待文件内容稳定后再读取：

final File logFile = new File(getTestCaseId() + ".log");
if (logFile.exists()) {
    long lastModified = 0;
    int retryCount = 3;
    // 最多等待3次，每次间隔100ms，确保文件不再被修改
    while (retryCount-- > 0) {
        long currentModified = logFile.lastModified();
        if (currentModified == lastModified) {
            break;
        }
        lastModified = currentModified;
        try {
            Thread.sleep(100);
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
            break;
        }
    }
    // 读取文件内容
    byte[] bytes = FileUtils.readFileToByteArray(logFile); 
    // Publish bytes to reporter
}

原理说明 #

• ImmediateFlush: true会让FileAppender每次写入日志后立即刷新缓冲区，避免日志滞留在内存中；
• 手动调用flush()和stop()可以确保在删除Appender前，所有缓冲的日志都已写入磁盘，且Appender不再持有文件句柄；
• 等待文件稳定是额外的兜底措施，应对可能存在的异步日志写入线程。

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