### 创建自定义拦截器以添加 Trace Id
为了在
Spring Boot 应用程序中创建自定义拦截器并实现 `
traceId` 的功能，可以按照以下方式操作：
#### 添加依赖项
确保项目的 `pom.xml` 文件中有必要的依赖项。对于
日志记录和 Web 开发的基础需求，通常需要引入
Spring Boot Starter Web 和 Lombok（可选）。如果计划使用 AOP 来增强功能，则还需要加入相应的 starter。
```xml
<dependencies>
<!-- Other dependencies -->
<dependency>
<groupId>org.
springframework.
boot</groupId>
<artifactId>
spring-
boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId*lombok*</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
```
#### 实现自定义拦截器类
通过继承 `HandlerInterceptorAdapter` 或者实现 `HandlerInterceptor` 接口来自定义拦截器逻辑。这里采用后者的方式来进行更灵活的操作。
```
java
import org.slf4j.MDC;
import
javax.servlet.http.HttpServletRequest;
import
javax.servlet.http.HttpServletResponse;
public class
TraceIdLoggingInterceptor implements HandlerInterceptor {
private static final String TRACE_ID = "
traceId";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// Generate a unique trace ID for each incoming HTTP request.
String
traceId = UUID.randomUUID().toString();
// Put the generated trace ID into MDC so that it can be included in
log messages.
MDC.put(TRACE_ID,
traceId);
return true; // Continue with the execution of other interceptors and controllers.
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
// Remove the trace ID from MDC once processing is complete to avoid memory leaks.
MDC.remove(TRACE_ID);
}
}
```
此代码片段展示了如何为每个进入 `/users/*` 路径的请求生成唯一 `
traceId` 并将其放置于 MDC 中[^1]。
#### 注册拦截器至应用程序上下文中
为了让上述拦截器生效，还需注册它到
Spring MVC 配置里。可以通过重写 `addInterceptors()` 方法完成这一步骤。
```
java
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private
TraceIdLoggingInterceptor
traceIdLoggingInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(
traceIdLoggingInterceptor).addPathPatterns("/users/**");
}
}
```
以上设置使得每当有请求访问匹配模式下的 URL (`/users/**`) 时，都会触发 `
TraceIdLoggingInterceptor.preHandle()` 方法，在其中执行 `
traceId` 的分配工作。
#### 使用虚拟线程优化异步任务处理 (可选)
如果有意利用
Java 新特性——虚拟线程来改进性能表现的话，可以根据特定条件加载配置类 `ThreadVirtualConfig` ，从而让异步任务运行在线程池中的虚拟线程上[^3]。
```
java
@Configuration
@ConditionalOnProperty(prefix = "
spring.threads.virtual", name = "enabled", havingValue = "true")
public class ThreadVirtualConfig {
/**
* 自定义虚拟线程任务执行器 Bean 定义。
*
* @return 返回一个新的 {@link CustomVirtualThreadTaskExecutor} 实例。
*/
@Bean
public Executor taskExecutor() {
return new CustomVirtualThreadTaskExecutor();
}
}
```
注意：这部分属于高级主题，并不是构建基本 `
traceId` 功能所必需的部分；仅当确实考虑到了多线程环境下的跟踪问题才建议深入研究。
超级会员免费看
本文介绍了日志TraceId的使用场景，如便于请求日志排查和微服务链路跟踪。讲解了MDC（Mapped Diagnostic Context）的概念，并在SpringBoot中通过过滤器、拦截器和AOP设置日志TraceId。同时，还讨论了如何在异步方法中获取主线程的TraceId。
订阅专栏 解锁全文
扫一扫
7万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
