利用拦截器、MDC和Logback实现Java Web应用请求追踪
本文介绍如何使用拦截器、MDC（Mapped Diagnostic Context）和Logback实现Java Web应用的请求追踪，从而方便地追踪和分析每个请求的处理过程。
核心技术：拦截器、MDC和Logback日志格式化
实现步骤如下：
立即学习“Java免费学习笔记（深入）”；
-
配置Logback日志格式： 修改Logback配置文件（例如
logback-spring.xml），在日志输出格式中添加%X{tid}占位符，用于显示追踪ID。 -
创建拦截器： 创建一个实现
HandlerInterceptor接口的拦截器。在preHandle方法中，使用UUID.randomUUID().toString()生成一个唯一的追踪ID，并使用MDC的put方法将其存储到线程上下文中，键名为"tid"。在afterCompletion方法中，使用MDC的clear方法清除线程上下文中的追踪ID，避免线程间干扰。 -
在日志中使用MDC： 在需要追踪的日志语句中，使用
%X{tid}占位符来输出追踪ID。Logback会自动从MDC中获取该ID并将其添加到日志信息中。
代码示例 (Java):
拦截器 (TraceInterceptor.java):
<code class="java">@Component
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, @Nullable Exception ex) throws Exception {
MDC.clear();
}
}</code>
配置类 (TraceConfig.java):
<code class="java">@Configuration
public class TraceConfig implements WebMvcConfigurer {
@Autowired
private TraceInterceptor traceInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(traceInterceptor)
.addPathPatterns("/**")
.excludePathPatterns("/static/**"); // 排除静态资源
}
// ...
}</code>
Logback配置 (logback-spring.xml):
<code class="xml"><configuration scan="true" scanPeriod="10 seconds">
<property name="CONSOLE_LOG_PATTERN" value="%X{tid}|--%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"/>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
</encoder>
</appender>
<root level="INFO">
<appender-ref ref="CONSOLE"/>
</root>
</configuration></code>
使用方法：
在你的业务逻辑代码中，正常使用Logback记录日志，%X{tid} 占位符会自动包含追踪ID。
通过以上步骤，即可在你的Java Web应用中实现高效的请求追踪功能，方便调试和问题排查。 记住根据你的项目结构调整相关类名和路径。
