Java Spring Boot如何对日志记录进行单元测试？是否必须测试日志？

• 非强制要求，可根据日志的作用判断：
  • 如果日志仅用于日常问题排查、调试记录，无业务关联属性，不需要为了凑JaCoCo覆盖率额外编写单元测试，覆盖率仅为代码质量参考指标，无需追求100%无意义覆盖
  • 如果日志属于合规审计类内容、或后续有其他系统消费日志做告警、计费、行为分析等业务操作，必须编写单元测试保证日志输出的正确性、规范性

Spring Boot项目默认使用SLF4J+Logback的日志框架，常用两种测试方案：

方案1：使用Spring Boot自带的OutputCaptureExtension捕获日志输出 #

适合简单的日志内容断言，无需额外引入依赖：

import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import static org.junit.jupiter.api.Assertions.assertTrue;

@ExtendWith(OutputCaptureExtension.class)
class YourServiceTest {
    private final YourService yourService = new YourService();

    @Test
    void testLog(CapturedOutput output) {
        // 构造场景触发目标日志打印
        yourService.testMethod();
        // 断言日志输出包含预期内容
        assertTrue(output.contains("预期的日志内容"));
    }
}

方案2：自定义Logback的ListAppender捕获日志 #

适合需要精准校验日志级别、MDC属性、日志参数的场景，灵活性更高：

import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.read.ListAppender;
import org.slf4j.LoggerFactory;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertTrue;

class YourServiceTest {
    private ListAppender<ILoggingEvent> logAppender;
    private YourService yourService;

    @BeforeEach
    void init() {
        // 获取目标类的Logger实例，添加自定义捕获Appender
        Logger logger = (Logger) LoggerFactory.getLogger(YourService.class);
        logAppender = new ListAppender<>();
        logAppender.start();
        logger.addAppender(logAppender);
        yourService = new YourService();
    }

    @Test
    void testLogContentAndLevel() {
        // 构造异常等场景，触发对应日志分支
        yourService.bizMethod();

        // 校验日志级别、内容是否符合预期
        boolean matchLog = logAppender.list.stream()
                .anyMatch(event -> "ERROR".equals(event.getLevel().levelStr)
                        && event.getFormattedMessage().contains("预期的错误日志内容"));
        assertTrue(matchLog);
    }
}

注意：如果日志位于异常分支，需要在单元测试中Mock依赖组件抛出对应异常，触发日志打印逻辑，JaCoCo才会统计该行代码被覆盖。

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