Spring Boot应用如何实现日志追踪的唯一ID?

spring boot应用如何实现日志追踪的唯一id?

Spring Boot应用日志追踪:实现唯一ID

本文探讨如何在Spring Boot 2.3应用中为每条日志记录分配唯一标识符,方便追踪特定请求的日志信息。我们将介绍两种方案:基于拦截器的自动分配和基于MDC的手动设置。

方案一:使用拦截器自动分配唯一ID

此方案通过实现HandlerInterceptor,在请求处理前使用UUID生成唯一ID并存储于MDC(Mapped Diagnostic Context)。请求结束后清除MDC,避免干扰后续请求。

1. 拦截器注册:

在Spring配置中注册拦截器,拦截所有请求,并排除静态资源:

@Configurationpublic class MvcConfigurer implements WebMvcConfigurer {    @Override    public void addInterceptors(InterceptorRegistry registry) {        registry.addInterceptor(new TraceInterceptor());    }}public class TraceInterceptor implements HandlerInterceptor {    @Override    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {        MDC.put("tid", UUID.randomUUID().toString());        return true;    }    @Override    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {        MDC.remove("tid");    }}

登录后复制

2. 日志配置:

在logback-spring.xml (或其他日志配置文件) 中,添加自定义PatternLayout,包含%X{tid}占位符:

                        %d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] %X{tid} %logger{36} - %msg%n                            

登录后复制

方案二:直接使用MDC手动设置唯一ID

此方案无需额外拦截器或配置修改,但需要在每个日志记录处手动设置ID。

示例:

public class MyService {    public void myMethod() {        String tid = UUID.randomUUID().toString();        MDC.put("tid", tid);        log.info("This is a log message."); // tid will be included in this log message        MDC.remove("tid");    }}

登录后复制

方案对比:

方案一: 更便捷,自动处理,无需在每个日志语句中手动添加ID。方案二: 更灵活,对日志记录有更精细的控制,但需要在每个日志语句中手动设置ID,容易遗漏。

选择哪种方案取决于项目需求和编码风格偏好。 对于大型项目,推荐使用方案一,以保证一致性和减少出错可能性。

以上就是Spring Boot应用如何实现日志追踪的唯一ID?的详细内容,更多请关注【创想鸟】其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至253000106@qq.com举报,一经查实,本站将立刻删除。

发布者:PHP中文网,转转请注明出处:https://www.chuangxiangniao.com/p/2606808.html

(0)
上一篇 2025年3月6日 20:19:46
下一篇 2025年3月6日 20:19:53

AD推荐 黄金广告位招租... 更多推荐

相关推荐

发表回复

登录后才能评论