SpringBoot日志追踪：轻松搞定唯一ID追踪

Spring Boot日志追踪：轻松实现唯一ID方案，本文介绍两种在Spring Boot应用中为每条日志添加唯一标识符(UUID)的方法，方便追踪请求日志。方案一利用拦截器自动在MDC中添加和移除唯一ID，简化操作，适合大型项目；方案二则通过手动在代码中设置MDC，更灵活，但需在每个日志语句中添加，容易遗漏。两种方案都通过logback配置文件的`%X{tid}`占位符输出唯一ID，最终选择取决于项目需求和编码风格。 通过本文，您可以快速掌握Spring Boot日志追踪的技巧，提升应用的调试效率。

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

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

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

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

1. 拦截器注册:

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

@Configuration
public 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，容易遗漏。

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

理论要掌握，实操不能落！以上关于《SpringBoot日志追踪：轻松搞定唯一ID追踪》的详细介绍，大家都掌握了吧！如果想要继续提升自己的能力，那么就来关注golang学习网公众号吧！