SpringBoot日志追踪：添加唯一ID

本文介绍如何在Spring Boot 2.3及Java 1.8环境下，利用SLF4j日志框架和MDC机制，为每条Java日志添加唯一ID，从而实现高效的日志追踪。通过自定义HTTP请求拦截器，在每次请求处理前生成UUID作为唯一ID并存储于MDC，然后在logback.xml中配置日志输出格式，即可在每条日志中包含该ID。文章详细讲解了拦截器的实现、MDC的使用以及logback配置，并提供内存泄漏预防和日志框架选择等建议，帮助开发者快速实现Spring Boot应用的日志追踪功能，提升问题排查效率。

Spring Boot下为每条Java日志添加唯一ID实现追踪

本文介绍在Spring Boot 2.3和Java 1.8环境下，使用SLF4j日志框架为每条Java日志添加唯一ID以方便追踪的方法。 主要方案是结合拦截器、MDC和日志格式配置实现。

一、日志格式配置

修改logback.xml (或其他日志配置文件) ，在日志输出格式中添加%x{request_id}占位符：

%d{${log_dateformat_pattern:yyyy-mm-dd HH:mm:ss.SSS}} ${log_level_pattern:%5p} ${pid: } --- [%t] %-40.40logger{39} :%x{request_id} %m%n${log_exception_conversion_word:%wex}

二、创建HTTP请求拦截器

实现Spring Boot的WebMvcConfigurer接口：

@Configuration
public class MvcLoggingConfigurer implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoggingHandlerInterceptor());
    }
}

三、自定义拦截器LoggingHandlerInterceptor

在preHandle方法中生成唯一ID并使用MDC存储：

public class LoggingHandlerInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        String requestId = UUID.randomUUID().toString(); // 生成唯一ID
        MDC.put("REQUEST_ID", requestId); // 使用MDC存储唯一ID
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        MDC.remove("REQUEST_ID"); // 清除MDC数据，避免内存泄漏
    }
}

四、其他建议

• 可以根据需要在MDC中存储其他上下文信息，例如用户ID、会话ID等，以便更全面地追踪日志。
• 务必在afterCompletion方法中移除MDC中的REQUEST_ID，防止内存泄漏。
• 考虑使用Log4j 2.x作为日志框架，它提供了更强大的功能和性能。

通过以上步骤，即可为每条日志添加唯一的请求ID，方便追踪和排查问题。

本篇关于《SpringBoot日志追踪：添加唯一ID》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于文章的相关知识，请关注golang学习网公众号！