如何在 log4j2 中为自定义记录器编写单元测试

Question

我创建了几个自定义记录器，其中某些级别覆盖了 Log4J2 中的自定义记录器。我已按照 http://logging.apache.org/log4j/2.x/manual/customloglevels.html.

上的指南进行操作

我需要创建一些单元测试来验证事件是否在其正确的自定义级别和配置上注册。

感谢任何关于如何开始的提示。非常感谢。

Answer 1

我建议看一下 log4j2 中的 JUnit 测试。

许多 log4j2 单元测试使用带有 immediateFlush=true 的 FileAppender，然后读入文件并检查输出中是否存在一些预期的字符串。其他人配置一个 (org.apache.logging.log4j.test.appender.) ListAppender（这个 class 位于核心测试 jar 中）并直接从列表中获取 LogEvent 对象。

您可能需要为 log4j2 JUnit 测试创建一个新进程，以确保之前的某个进程尚未加载不同的配置。

Answer 2

一个选项是使用自定义的 OutputStreamAppender 子类将记录器配置为写入内存中的字符串（字节数组）流，您必须对其进行编码。

然后您可以在测试中对生成的字符串使用断言。

我最近发表了一篇关于如何做到这一点的博文 here。也许它会帮助你。

Answer 3

这里是我在 JUnit 测试中所做的。

1- 创建一个自定义附加程序，在内存中保存消息列表。

package com.example.appender;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import lombok.Getter;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.appender.AbstractAppender;
import org.apache.logging.log4j.core.config.Property;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.layout.PatternLayout;

/**
 * @author carrad
 * 
 */
@Plugin(name = "TestAppender", category = "Core", elementType = "appender", printObject = true)
public class TestAppender extends AbstractAppender {

    @Getter
    private final List<LogEvent> messages = new ArrayList<>();

    protected TestAppender(String name, Filter filter, Layout<? extends Serializable> layout) {
        super(name, filter, layout, true, Property.EMPTY_ARRAY);
    }

    @Override
    public void append(LogEvent event) {
        messages.add(event);
    }

    @PluginFactory
    public static TestAppender createAppender(
            @PluginAttribute("name") String name,
            @PluginElement("Layout") Layout<? extends Serializable> layout,
            @PluginElement("Filter") final Filter filter,
            @PluginAttribute("otherAttribute") String otherAttribute
    ) {
        if (name == null) {
            LOGGER.error("No name provided for TestAppender");
            return null;
        }
        if (layout == null) {
            layout = PatternLayout.createDefaultLayout();
        }
        return new TestAppender(name, filter, layout);
    }
}

2- 将 appender 添加到 log4j2-test.xml

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" packages="com.example.appender">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>
        <TestAppender name="TestAppender" >
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </TestAppender> 
    </Appenders>
    <Loggers>
        <Logger name="com.example" level="All" />
        <Root>
            <AppenderRef ref="Console" level="All" />
            <AppenderRef ref="TestAppender" level="All" /> 
        </Root>
    </Loggers>
</Configuration>

3- 在 Junit 测试中获取对 appender 的引用。

public class LoggingInterceptorTest {

    @Autowired  // Whatever component you want to test
    private InterceptedComponent helperComponent;

    private TestAppender appender;

    @Before
    public void setUp() {
        final LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
        final Configuration config = ctx.getConfiguration();
        appender = (TestAppender) config.getAppenders().get("TestAppender");
    }

    @Test
    public void test_wrapping() {
        helperComponent.doStuff("437");
        Assert.assertEquals(appender.getMessages().size(), 2);
    }
}

在您的测试用例中，您可以检查写入的消息数或包含您想要的消息的列表，包括级别等元信息。

如何在 log4j2 中为自定义记录器编写单元测试

How to write a unit test for a custom logger in log4j2

java

logging

unit-testing

log4j

log4j2