Java 中怎么在日志中打印用户的请求追踪 TraceId

胖芳同学_2519

胖芳同学_2519

2026-10-06

760人浏览

原创

java中实现日志自动打印traceid的核心是slf4j mdc结合sleuth(boot 3.x前)或micrometer tracing(boot 3.x+),二者均自动注入mdc并支持logback配置%x{traceid:-}输出,纯手工方式需filter+uuid+mdc.put/clear。

java 中怎么在日志中打印用户的请求追踪 traceid

在 Java 中实现日志中自动打印请求追踪 ID(TraceId),核心是利用 SLF4J MDC(Mapped Diagnostic Context) 结合分布式追踪框架(如 Spring Cloud Sleuth 或 Micrometer Tracing)来透传和注入 TraceId。

使用 Spring Cloud Sleuth(推荐,Spring Boot 3.x 前)

Sleuth 会自动为每个 HTTP 请求生成唯一 TraceId(和 SpanId),并将其注入 MDC,只要日志框架(如 Logback)配置了对应占位符,就能直接输出。

  • 添加依赖(Maven):

  org.springframework.cloud
  spring-cloud-starter-sleuth
  • 确保日志配置(如 logback-spring.xml)中包含 %X{traceId} 或 %X{traceId:-}(后者避免空值时报错):
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - [%X{traceId:-},%X{spanId:-}] - %msg%n
  • 无需手动设置 —— Sleuth 在 Filter 中自动完成 MDC 的 put 和 clear,线程结束后自动清理,防止日志污染。

使用 Micrometer Tracing(Spring Boot 3.x+ 官方推荐)

Spring Boot 3 起,Sleuth 已被 Micrometer Tracing 取代。它同样支持自动 MDC 注入,但需启用配置:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 添加依赖:

  io.micrometer
  micrometer-tracing-bridge-brave


  io.micrometer
  micrometer-tracing
  • 在 application.yml 中启用 MDC:
management:
  tracing:
    otel:
      propagation:
        type: b3
logging:
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - [%X{traceId:-},%X{spanId:-}] %msg%n"
  • Micrometer 默认开启 MDC 自动绑定(tracing.baggage.remote-fields=traceId,spanId 非必需,默认已支持)。

纯手工方式(无框架或需自定义场景)

若不使用 Sleuth/Micrometer,可基于 javax.servlet.Filter + MDC 手动注入 TraceId:

  • 生成 TraceId(例如用 UUID):
  • 在 Filter 中写入 MDC,并在 finally 中清除:
public class TraceIdFilter implements Filter {
  @Override
  public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
      throws IOException, ServletException {
    String traceId = UUID.randomUUID().toString().replace("-", "");
    MDC.put("traceId", traceId);
    try {
      chain.doFilter(req, res);
    } finally {
      MDC.clear();
    }
  }
}
  • 注意:跨线程时需手动传递(如用 ThreadLocal + Runnable 包装,或使用 MDC.getCopyOfContextMap() 透传)。

验证与调试技巧

快速确认 TraceId 是否生效:

  • 启动应用后发一个 HTTP 请求(如 curl http://localhost:8080/api/test);
  • 查看控制台日志,确认每行开头或指定位置出现类似 [a1b2c3d4e5f67890,1234567890abcdef] 的字段;
  • 在 Controller 中临时打印:log.info("TraceId in controller: {}", MDC.get("traceId"));
  • 若为空,检查 Filter 是否注册、MDC 是否被提前 clear、是否用了线程池未传递上下文(如 CompletableFuture 需配合 ThreadPoolTaskExecutor + new LoggingTaskDecorator())。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

全能打印神器
全能打印神器

全能打印神器是一款非常好用的打印软件,可以在电脑、手机、平板电脑等设备上使用。支持无线打印和云打印,操作非常简单,使用起来也非常方便,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

9817

6

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

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

2023.07.05

6942

9

java自学难吗
java自学难吗

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

2023.07.31

6132

8

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

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

2023.08.01

1064

3

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

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

2023.08.02

888

3

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

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

2023.08.02

1296

5

java有什么用
java有什么用

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

2023.08.02

2569

5

java在线网站
java在线网站

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

2023.08.03

19911

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1155

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习