Log4j2 编程消息替换（从 log4j 替换 PatternLayout）

Question

我们正在将日志从 log4j 迁移到 log4j2。 但是，我在迁移扩展PatternLayout的 class 时遇到问题，因为它现在是final 。

旧的模式布局代码将所有出现的\r和\n替换为| 除非它是堆栈跟踪。

我查看了 log4j2 的文档，但还没有找到适合这种问题的方法。 到目前为止，我不相信 XML 配置是可能的，而只是 java 代码。

如果满足条件，我们如何替换日志字符串中的某些字符有什么想法吗？

Answer 1

您可以使用正则表达式来替换这些字符。

https://logging.apache.org/log4j/2.x/manual/layouts.html

%replace{%msg}{[\r\n]+}{}

这似乎是一个重复的问题： How to remove or replace newline from log messages log4j

另一方面， PatternLayout扩展AbstractStringLayout ，因此您可以制作“自定义 PatternLayout ”。

https://github.com/apache/logging-log4j2/blob/master/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java

Answer 2

您可以尝试一种类似于我建议的方法，作为另一个关于将异常日志路由到单独的附加程序的问题的答案。 你可以有一个 appender 拒绝带有异常的消息（通过设置ExceptionFilter属性 onMatch="DENY"），同时使用类似于 devwebcl 建议的替换模式

%replace{%msg}{[\r\n]+}{|}

然后有第二个附加程序，它将处理带有异常的消息。 此附加程序不会使用替换模式。

所以这里有一个 java 文件来生成一些日志：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class SomeClass {

    private static final Logger log = LogManager.getLogger();   

    public static void main(String[] args){

        if(log.isDebugEnabled())
            log.debug("This is some debug!\r\nThis is the second line of debug.");
        log.info("Here's some info!\r\nMore info on another line.");
        log.error("Some error happened!");

        try{
            specialLogic();
        }catch(RuntimeException e){
            log.error("Woops, an exception was detected.", e);
        }
    }

    public static void specialLogic(){
        throw new RuntimeException("Hey an exception happened! Oh no!");
    }
}

这是 log4j2.xml 文件：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">

    <Appenders>

        <File name="ExceptionFile" fileName="logs/app.log" immediateFlush="true"
            append="true">
            <ThrowableFilter onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout
                pattern="%d{yyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </File>
        <File name="logFile" fileName="logs/app.log" immediateFlush="true"
            append="true">
            <ThrowableFilter onMatch="DENY" onMismatch="NEUTRAL"/>
            <PatternLayout
                pattern="%d{yyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %replace{%msg}{[\r\n]+}{|}%n" />
        </File>
    </Appenders>

    <Loggers>
        <Root level="debug">
            <AppenderRef ref="logFile" />
            <AppenderRef ref="ExceptionFile" />
        </Root>
    </Loggers>
</Configuration>

这是一些示例 output：

2019-11-15 19:39:25.453 [main] DEBUG example.SomeClass - This is some debug!|This is the second line of debug.
2019-11-15 19:39:25.456 [main] INFO  example.SomeClass - Here's some info!|More info on another line.
2019-11-15 19:39:25.456 [main] ERROR example.SomeClass - Some error happened!
2019-11-15 19:39:25.456 [main] ERROR example.SomeClass - Woops, an exception was detected.
java.lang.RuntimeException: Hey an exception happened! Oh no!
    at example.SomeClass.specialLogic(SomeClass.java:25) ~[classes/:?]
    at example.SomeClass.main(SomeClass.java:18) [classes/:?]

请注意，过滤器 class 与我的其他答案中的过滤器相同。

另请注意，如果与异步日志记录一起使用，我并不完全确定这将如何工作。 在异步场景中使用指向同一文件的 2 个附加程序可能会出现一些问题。