如何在单个JUnit5单元测试中动态修改Logger Level？

问题描述 #

需要在JUnit5单元测试中动态调整Logger级别，验证不同级别下目标日志语句是否输出。待测试代码如下：

public void question(final Foo foo) {
    if (LOGGER.isInfoEnabled() && someConditionVerified(foo)) {
        LOGGER.debug("condition has been verified on Foo");
    }
}

已尝试的测试代码无法实现日志级别动态修改，导致无法验证两种场景的日志输出。

解决方案 #

根据你使用的日志框架，选择对应实现方式，测试前后务必恢复原日志级别，避免影响其他测试用例。

场景1：SLF4J + Logback #

直接通过Logback的LoggerContext操作目标Logger：

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import org.slf4j.LoggerFactory;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;

@ExtendWith(OutputCaptureExtension.class)
class YourTestClass {
    private Logger targetLogger;
    private Level originalLevel;
    // 替换为你的目标类全限定名
    private static final String TARGET_LOGGER = YourService.class.getName();

    @BeforeEach
    void init() {
        // 获取目标Logger并保存原始级别
        targetLogger = (Logger) LoggerFactory.getLogger(TARGET_LOGGER);
        originalLevel = targetLogger.getLevel();
    }

    @AfterEach
    void resetLogLevel() {
        // 恢复原始日志级别
        targetLogger.setLevel(originalLevel);
    }

    @Test
    void testLogOutputByLevel(CapturedOutput output) {
        // 第一步：设置为INFO级别，DEBUG日志不会输出
        targetLogger.setLevel(Level.INFO);
        question(new Foo());
        assertFalse(output.getOut().contains("condition has been verified on Foo"));

        // 第二步：设置为DEBUG级别，DEBUG日志会输出
        targetLogger.setLevel(Level.DEBUG);
        question(new Foo());
        assertTrue(output.getOut().contains("condition has been verified on Foo"));
    }

    // 确保测试时someConditionVerified返回true，否则日志不会触发
    private boolean someConditionVerified(Foo foo) {
        return true;
    }

    private void question(Foo foo) {
        if (targetLogger.isInfoEnabled() && someConditionVerified(foo)) {
            targetLogger.debug("condition has been verified on Foo");
        }
    }
}

场景2：SLF4J + Log4j2 #

使用Log4j2的Configurator动态修改级别：

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.Logger;
import org.apache.logging.log4j.core.config.Configurator;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;

@ExtendWith(OutputCaptureExtension.class)
class YourTestClass {
    private Logger targetLogger;
    private Level originalLevel;
    private static final String TARGET_LOGGER = YourService.class.getName();

    @BeforeEach
    void init() {
        targetLogger = (Logger) LogManager.getLogger(TARGET_LOGGER);
        originalLevel = targetLogger.getLevel();
    }

    @AfterEach
    void resetLogLevel() {
        Configurator.setLevel(TARGET_LOGGER, originalLevel);
    }

    @Test
    void testLogOutputByLevel(CapturedOutput output) {
        // 禁用DEBUG日志
        Configurator.setLevel(TARGET_LOGGER, Level.INFO);
        question(new Foo());
        assertFalse(output.getOut().contains("condition has been verified on Foo"));

        // 启用DEBUG日志
        Configurator.setLevel(TARGET_LOGGER, Level.DEBUG);
        question(new Foo());
        assertTrue(output.getOut().contains("condition has been verified on Foo"));
    }

    // 省略辅助方法和待测试方法实现
}

关键注意点 #

• 测试时必须保证someConditionVerified(foo)返回true，否则即使日志级别正确，日志也不会输出
• 必须在@AfterEach中恢复原日志级别，防止污染其他测试用例的日志环境
• 若使用Spring Boot，不建议用@TestPropertySource临时修改配置（无法在单个测试方法内动态切换级别），优先直接操作Logger对象

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