Mockito捕获日志信息：Java8遗留代码无构造函数场景测试问询

针对你的遗留代码场景（Logger为静态final类字段，无法通过构造注入），有两种可行方案来捕获并验证日志消息：

方案一：使用PowerMock mock静态日志工厂 #

由于Logger是静态final字段，常规Mockito无法直接拦截其初始化，需要借助PowerMock来mock静态方法调用，具体步骤如下：

1. 添加依赖 #

确保项目中引入PowerMock适配TestNG和Mockito的依赖（以Maven为例）：

<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-module-testng</artifactId>
    <version>2.0.9</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-api-mockito2</artifactId>
    <version>2.0.9</version>
    <scope>test</scope>
</dependency>

2. 编写测试类 #

import org.mockito.Mockito;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PowerMockIgnore;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.testng.PowerMockTestCase;
import org.testng.annotations.Test;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

@PrepareForTest({LogManager.class, MyTestClass.class})
@PowerMockIgnore({"javax.management.*", "javax.net.ssl.*"}) // 避免类加载冲突
public class MyTestClassTest extends PowerMockTestCase {

    @Test
    public void testSomeMethodLogsCorrectMessage() {
        // 创建Logger的mock对象
        Logger mockLogger = Mockito.mock(Logger.class);
        
        // mock LogManager.getLogger静态方法，返回自定义mockLogger
        PowerMockito.mockStatic(LogManager.class);
        PowerMockito.when(LogManager.getLogger("MYLOGGER")).thenReturn(mockLogger);
        
        // 实例化待测试类
        MyTestClass testInstance = new MyTestClass();
        
        // 调用目标方法
        testInstance.someMethod();
        
        // 验证日志消息是否匹配
        Mockito.verify(mockLogger).info("This should be logged");
    }
}

注意：@PrepareForTest需要包含LogManager和MyTestClass，PowerMock会修改类字节码以拦截静态字段的初始化和静态方法调用。

方案二：利用日志框架的测试Appender捕获日志 #

如果不想使用PowerMock，可以通过配置日志框架的内存Appender来捕获日志事件，以Log4j2为例：

1. 配置测试日志文件 #

在src/test/resources下创建log4j2-test.xml：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="OFF">
    <Appenders>
        <Memory name="MemoryAppender">
            <PatternLayout pattern="%msg"/>
        </Memory>
    </Appenders>
    <Loggers>
        <Logger name="MYLOGGER" level="info" additivity="false">
            <AppenderRef ref="MemoryAppender"/>
        </Logger>
    </Loggers>
</Configuration>

2. 编写测试类 #

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.Logger;
import org.apache.logging.log4j.core.appender.MemoryAppender;
import org.testng.Assert;
import org.testng.annotations.Test;

import java.util.List;

public class MyTestClassTest {

    @Test
    public void testSomeMethodLogsCorrectMessage() {
        // 获取配置的MemoryAppender
        Logger logger = (Logger) LogManager.getLogger("MYLOGGER");
        MemoryAppender appender = (MemoryAppender) logger.getAppenders().get("MemoryAppender");
        
        // 清空历史日志
        appender.clear();
        
        // 执行测试方法
        MyTestClass testInstance = new MyTestClass();
        testInstance.someMethod();
        
        // 验证日志内容
        List<org.apache.logging.log4j.core.LogEvent> events = appender.getEvents();
        Assert.assertEquals(events.size(), 1);
        Assert.assertEquals(events.get(0).getMessage().getFormattedMessage(), "This should be logged");
    }
}

优缺点对比：

• PowerMock方案：无需修改日志配置，直接mock静态依赖，但会修改类字节码，可能引发类加载冲突。
• 测试Appender方案：更贴近真实日志流程，无字节码修改，但依赖具体日志框架的API，需要额外配置。

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