Log4j2日志模式：如何转义日志消息中的双引号

背景与当前配置 #

我们在微服务中使用Log4j2，IT安全组强制要求日志生成的键值对必须用双引号包裹值，确保安全工具能自动解析。当前的Log4j2配置片段如下：

<property name="pattern">dateTime="%d{yyyy-MM-dd HH:mm:ss.SSS}" msg="%msg%throwable"%n</property>

代码中的日志调用方式：

log.info("Request started");
log.debug("Data received: {}", dataAsJsonObject);
log.error("Reading file failed", ex);

正常情况下生成的日志（无特殊字符）：

dateTime="2024-06-25 13:05:12.984" msg="Request started"

问题场景 #

当日志消息包含双引号（例如打印JSON内容）时，会破坏键值对的引号结构，导致msg字段被截断，示例错误输出：

dateTime="2024-06-25 13:05:12.984" msg="Data received: {"key": "value"}"

期望效果 #

希望Log4j2自动转义日志值中的双引号（"→\"）和反斜杠（\→\\），得到合法的键值对格式：

dateTime="2024-06-25 13:05:12.984" msg="Data received: {\"key\": \"value\"}"

注：此处需要转义的是传入格式化程序的日志值中的特殊字符，而非模式本身的双引号。

可行解决方案 #

方案1：使用Log4j2内置的%replace转换器 #

直接在日志pattern中通过%replace对%msg和%throwable的内容进行转义处理，修改后的pattern配置如下：

<property name="pattern">
dateTime="%d{yyyy-MM-dd HH:mm:ss.SSS}" msg="%replace{%replace{%msg%throwable}{\\}{\\\\}}{\"}{\\\"}"%n
</property>

• 第一层%replace把反斜杠\替换为\\\\（Log4j2 pattern中反斜杠需转义，最终输出为\\）
• 第二层%replace把双引号"替换为\\\"（最终输出为\"）

方案2：自定义Message转换器 #

如果需要更复杂的转义逻辑（比如处理更多特殊字符），可以自定义实现Log4j2的MessageConverter接口：

1. 编写自定义转换器类：

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.pattern.MessageConverter;
import org.apache.logging.log4j.core.pattern.PatternConverter;

@Plugin(name = "EscapedMessageConverter", category = PatternConverter.CATEGORY)
public class EscapedMessageConverter implements MessageConverter {
    @Override
    public String format(LogEvent event) {
        String originalMsg = event.getMessage().getFormattedMessage();
        // 转义反斜杠和双引号
        return originalMsg.replace("\\", "\\\\").replace("\"", "\\\"");
    }
}

2. 在pattern中使用自定义转换器：

<property name="pattern">dateTime="%d{yyyy-MM-dd HH:mm:ss.SSS}" msg="%msg{EscapedMessageConverter}%throwable"%n</property>

（如果需要同时转义throwable中的特殊字符，可对%throwable也应用类似逻辑，或在转换器中整合throwable内容）

方案3：切换为JSON格式输出（推荐） #

如果安全工具支持JSON格式，直接使用Log4j2的JsonLayout或JacksonJsonLayout，这类布局会自动处理所有特殊字符的转义，无需手动配置pattern：

<JsonLayout compact="true" eventEol="true" />

生成的日志会是标准JSON结构，天然满足安全工具的解析需求，同时避免手动转义的繁琐。

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