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

时间:2021-03-26 11:58:40

标签: java unit-testing mockito slf4j

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

我尝试编写一个测试并模拟 Logger,但它不起作用。

@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?

2 个答案:

答案 0 :(得分:1)

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

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

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

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

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

注意:如果您只想让记录器静音,那么您也可以将其配置为在测试中关闭。

答案 1 :(得分:0)

您可以使用 https://www.simplify4u.org/slf4j-mock/ 库。

您的示例代码将起作用 - 您只需要对依赖项使用 slf4j-mock 而不是其他 slf4j 绑定。