讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 中日志记录怎么输出 JSON 格式日志

秋萱君_8969

秋萱君_8969

发布时间:2026-10-08 13:32:16

|

225人浏览过

|

来源于php中文网

原创

Java输出JSON日志需日志框架支持JSON编码器并正确配置:Logback配合logback-json-encoder,Log4j2使用JsonLayout;均支持MDC注入自定义字段,推荐配置方式而非手动拼接。

java 中日志记录怎么输出 json 格式日志

Java 中输出 JSON 格式日志,核心是让日志框架(如 Logback、Log4j2)将日志事件序列化为结构化 JSON,而非默认的文本格式。这需要两方面配合:日志框架支持 JSON 编码器 + 正确配置(或编程式设置)。

使用 Logback + logback-json-encoder

Logback 是最常用的日志框架之一,搭配 logback-json-encoder 可轻松输出 JSON 日志。

  • 添加 Maven 依赖:
<dependency>
  <groupId>net.logstash.logback</groupId>
  <artifactId>logstash-logback-encoder</artifactId>
  <version>7.4</version>
</dependency>
  • 在 logback-spring.xml 或 logback.xml 中配置 JSON encoder:
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
    <providers>
      <timestamp/>
      <version/>
      <message/>
      <loggerName/>
      <level/>
      <stackTrace/>
      <pattern>
        <pattern>"thread":"%thread","service":"myapp","env":"${spring.profiles.active:-dev}"</pattern>
      </pattern>
    </providers>
  </encoder>
</appender>
  • 支持自定义字段(如 traceId、userId),可通过 MDC(Mapped Diagnostic Context)注入后自动写入 JSON:

代码中:
MDC.put("traceId", "abc123");
MDC.put("userId", "u789");
log.info("User login succeeded");

→ 输出 JSON 中会自动包含 "traceId":"abc123","userId":"u789"

使用 Log4j2 + Jackson JSON Layout

Log4j2 原生支持 JSON 输出,通过 JsonLayout 即可实现。

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
  • Maven 依赖(确保有 Jackson 支持):
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-core</artifactId>
</dependency>
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
</dependency>
  • log4j2.xml 配置示例:
<Appenders>
  <Console name="Console" target="SYSTEM_OUT">
    <JsonLayout compact="true" eventEol="true" />
  </Console>
</Appenders>
  • 支持添加额外字段(如服务名、版本):
<JsonLayout compact="true">
  <KeyValuePair key="service" value="myapp" />
  <KeyValuePair key="version" value="1.2.0" />
</JsonLayout>

手动构造 JSON 日志(不推荐,仅作补充)

若因限制无法使用结构化日志框架,也可用 Jackson/Gson 手动拼装,但会丢失日志级别、时间戳、线程等上下文信息,且难以与 MDC 集成。

立即学习“Java免费学习笔记(深入)”;

  • 示例(Jackson):
ObjectMapper mapper = new ObjectMapper();
Map<String, Object> log = new HashMap<>();
log.put("level", "INFO");
log.put("message", "Order processed");
log.put("orderId", 1001);
log.put("timestamp", Instant.now());
log.info(mapper.writeValueAsString(log));
  • 缺点明显:绕过日志框架能力,无法统一管理格式、异步、过滤、滚动等;不建议生产使用。

关键注意事项

  • 避免日志内容含非法 JSON 字符:如未转义的双引号、换行符。Logback JSON encoder 和 Log4j2 JsonLayout 默认会处理,但手动拼接时需注意。
  • 性能影响:JSON 序列化比纯文本略重,但在现代 JVM 上通常可忽略;高吞吐场景可启用异步 Appender(如 AsyncAppender)缓解。
  • 与链路追踪集成:结合 Sleuth 或 Micrometer Tracing 时,traceId/spanId 会自动注入 MDC,JSON encoder 可直接捕获并输出。
  • 日志采集兼容性:确保 ELK、Loki、Datadog 等后端能正确解析 JSON 字段;建议用 compact="true" 减少空格提升解析效率。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

10617

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

7742

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6752

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1144

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

948

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1396

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2789

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20111

2023.08.03

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

0

2026.10.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn