使用@Slf4j注释创建时如何模拟Logger？

Question

我有一个带有 @Slf4j 注释的类。

我尝试编写一个测试并模拟记录器，但它不起作用。

@RequiredArgsConstructor
@Slf4j
public abstract class ExampleClass {
    
    protected final PropsClass properties;
    
    protected void logInfo(..) {
        log.info(...);
        clearMappedDiagnosticContext();
    }
}

测试如下所示：

@RunWith(MockitoJUnitRunner.class)
public class ExampleClassTest {
    
    @Mock
    Logger logger;
    
    @Mock
    PropsClass properties;
    
    @InjectMocks
    ExampleClass exampleClass;
    
    @Test
    public void logSomethingtest() {
        ...
        exampleClass.logInfo(...);
        Mockito.verify(logger).info(marker, "foo bar {}", ...);
    }

这是我得到的错误：

Wanted but not invoked:
logger.info(
    MY_MARKER,
    "..........",
    "....",
    "....",
    0L
);

Actually, there were zero interactions with this mock.

问题是，如何模拟 Logger？

Answer 1

lombok注释在编译时@Slf4j将代码注入到您的类中。具体来说，它将添加以下代码到您的类中：

private static final org.slf4j.Logger log =
                        org.slf4j.LoggerFactory.getLogger(LogExample.class);

@InjectMocks告诉 Mockito 创建类的实例并在运行时注入模拟作为其依赖项。

记录器在编译时注入。依赖项是在运行时注入的。这就是为什么你的记录器没有被嘲笑，也不能像这样被嘲笑。如果您查看上面注入的记录器代码，您就会明白，模拟记录器的唯一方法是模拟 LoggerFactory（Mockito 从 3.4 版本开始可以模拟静态方法，IIRC）并使其返回记录器模拟。

注意：让模拟返回模拟通常是一个坏主意，应该避免。@Slf4j太方便了，不敢用。这是一个权衡。

注意：如果您希望它使记录器静音，那么您也可以将其配置为在测试中关闭。