Java应用日志追踪：最佳实践
高效追踪Java应用中不同请求的日志，关键在于为每个请求生成唯一的标识符。本文推荐使用Spring拦截器、日志格式化和Log4j的MDC(Mapped Diagnostic Context)机制来实现这一目标。
实现步骤：
-
日志格式配置： 修改日志配置文件，在日志输出格式中添加MDC变量占位符
%x{requestId}。 示例配置（基于logback）：
<code class="xml"><configuration>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %x{requestId} - %msg%n</pattern>
</encoder>
</appender>
<root level="info">
<appender-ref ref="CONSOLE" />
</root>
</configuration></code>
-
HTTP请求拦截器： 创建一个Spring拦截器，实现
HandlerInterceptor接口。在preHandle方法中，生成UUID作为请求ID，并使用MDC存储该ID。
<code class="java">@Component
public class RequestIdInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String requestId = UUID.randomUUID().toString();
MDC.put("requestId", requestId);
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
MDC.remove("requestId");
}
}</code>
- 拦截器注册： 在Spring的配置类中，注册自定义的拦截器。
<code class="java">@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private RequestIdInterceptor requestIdInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(requestIdInterceptor).addPathPatterns("/**").excludePathPatterns("/static/**");
}
}</code>
-
日志输出： 通过步骤1的配置，日志中将会包含
requestId字段，实现对不同请求日志的追踪。
通过以上步骤，每个HTTP请求都会拥有唯一的requestId，方便追踪和分析日志，提高问题排查效率。 请根据实际使用的日志框架（Log4j2, Logback等）调整相应的配置。
立即学习“Java免费学习笔记（深入）”；
