使用log4j将明文日志转JSON格式配置失效，如何正确配置JSON模板

你当前配置未生效优先检查以下两项：

• 未在根日志器中绑定stdout输出器，需确保配置中存在log4j.rootLogger=你的日志级别, stdout配置项，没有指定输出器的情况下单独配置appender不会生效
• 直接用PatternLayout拼接JSON存在转义缺陷，当日志内容自带双引号、换行符时会直接破坏JSON结构，导致输出的格式不符合要求

如果使用的是Log4j 1.x版本，推荐引入专门的JSON布局组件避免自行拼接的转义问题：

1. 引入依赖（Maven示例）

<dependency>
    <groupId>net.logstash.log4j</groupId>
    <artifactId>jsonevent-layout</artifactId>
    <version>1.7</version>
</dependency>

2. 调整log4j.properties配置

# 绑定根日志器与stdout输出器，示例级别为INFO可自行修改
log4j.rootLogger=INFO, stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.encoding=UTF-8
log4j.appender.stdout.layout=net.logstash.log4j.JSONEventLayoutV1
# 自定义字段匹配你需要的JSON结构
log4j.appender.stdout.layout.CustomFields=debug_level:%p,debug_timestamp:%d{ISO8601},debug_thread:%t,debug_file:%F,debug_line:%L,debug_message:%m

如果不想引入额外依赖，可修改原有ConversionPattern增加转义逻辑：

log4j.appender.stdout.layout.ConversionPattern={"debug_level":"%p","debug_timestamp":"%d{ISO8601}","debug_thread":"%t","debug_file":"%F", "debug_line":"%L","debug_message":"%replace{%m}{\"}{\\\\\"}"}%n

Log4j2原生支持JSON模板布局，无需自行拼接字符串：

1. 引入JSON布局依赖

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-layout-template-json</artifactId>
    <version>2.20.0</version>
</dependency>

2. 新增自定义JSON模板文件，放到类路径下，命名为log-json-template.json，内容如下：

{
  "debug_level": "${level}",
  "debug_timestamp": "${timestamp:ISO8601}",
  "debug_thread": "${thread}",
  "debug_file": "${source:fileName}",
  "debug_line": "${source:lineNumber}",
  "debug_message": "${message}"
}

3. 调整log4j2.properties配置关联模板

appender.stdout.type = Console
appender.stdout.name = STDOUT
appender.stdout.layout.type = JsonTemplateLayout
appender.stdout.layout.eventTemplateUri = classpath:log-json-template.json

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