在多个单体
Spring Boot 项目中实现 `
traceId` 并将其输出到
日志中，可以通过以下方式完成：
### 3.1 集成
日志框架
Spring Boot 支持多种
日志框架，如 Logback、Log4j2 等。推荐
使用 Logback，它是
Spring Boot 默认的
日志实现。为了支持 `
traceId`，需要在
日志配置中
使用 MDC（Mapped Diagnostic Context），它允许在每个
日志行中附加上下文信息[^1]。
### 3.15 集成
日志框架 [^1]
在 `application.yml` 或 `application.properties` 中配置
日志格式，确保 `
traceId` 被包含在
日志输出中。例如，在 `logback-
spring.xml` 中定义
日志模式：
```xml
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %X{
traceId} - %msg%n</pattern>
</encoder>
</appender>
<root level="info">
<appender-ref ref="STDOUT" />
</root>
</configuration>
```
在这个配置中，`%X{
traceId}` 用于从 MDC 中提取 `
traceId` 并将其写入
日志。
### 3.11 集成定时任务
为了确保每个请求都有唯一的 `
traceId`，可以在请求进入应用时生成一个唯一的 ID，并将其存储在 MDC 中。这通常通过拦截器或过滤器实现：
```java
import org.slf4j.MDC;
import org.
springframework.stereotype.Component;
import org.
springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;
@Component
public class TraceInterceptor implements HandlerInterceptor {
private static final String TRACE_ID = "
traceId";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String
traceId = UUID.randomUUID().toString();
MDC.put(TRACE_ID,
traceId);
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
MDC.clear();
}
}
```
通过 `HandlerInterceptor`，在请求开始时生成 `
traceId` 并放入 MDC，在请求结束时清除 MDC，防止线程复用导致的数据污染。
### 3.18 单元测试
为了验证 `
traceId` 是否正确注入到
日志中，可以编写单元测试来模拟请求并检查
日志输出：
```java
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.
springframework.beans.factory.annotation.Autowired;
import org.
springframework.
boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.
springframework.
boot.test.context.
SpringBootTest;
import org.
springframework.test.web.servlet.MockMvc;
@
SpringBootTest
@AutoConfigureMockMvc
public class
TraceIdTest {
private static final Logger logger = LoggerFactory.getLogger(
TraceIdTest.class);
@Autowired
private MockMvc mockMvc;
@Test
public void test
TraceIdInLogs() throws Exception {
logger.info("This log should contain a
traceId");
// 可以结合
日志捕获工具（如 LogCaptor）验证
traceId 是否存在
}
}
```
### 3.19 集成监控中心
若多个
Spring Boot 项目部署在不同的服务中，可以结合分布式
追踪工具（如 Zipkin、Sleuth）来实现跨服务的 `
traceId` 传播。
Spring Cloud Sleuth 可以自动为每个请求生成 `
traceId` 并将其传播到下游服务，便于集中
日志分析和分布式
追踪。
添加 Sleuth 依赖后，`
traceId` 将自动注入到
日志中：
```xml
<dependency>
<groupId>org.
springframework.cloud</groupId>
<artifactId>
spring-cloud-starter-sleuth</artifactId>
</dependency>
```
### 3.20 集成单元测试框架
若
使用日志捕获工具（如 LogCaptor），可在单元测试中验证
日志中是否包含 `
traceId`：
```java
import com.github.valfirst.slf4j.test.LoggingEvent;
import com.github.valfirst.slf4j.test.TestLoggerFactory;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.
springframework.beans.factory.annotation.Autowired;
import org.
springframework.
boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.
springframework.
boot.test.context.
SpringBootTest;
import org.
springframework.test.web.servlet.MockMvc;
import java.util.List;
import static org.
springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.
springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@
SpringBootTest
@AutoConfigureMockMvc
public class
TraceIdLoggingTest {
@Autowired
private MockMvc mockMvc;
@Test
public void test
TraceIdInLogs() throws Exception {
Logger logger = TestLoggerFactory.getTestLogger(YourController.class);
mockMvc.perform(get("/api/test")).andExpect(status().isOk());
List<LoggingEvent> events = TestLoggerFactory.getLoggingEvents(YourController.class);
for (LoggingEvent event : events) {
// 验证
日志中是否包含
traceId
assert event.getMessage().contains("
traceId=");
}
}
}
```
SpringBoot中TraceId实现日志追踪
最低0.47元/天 解锁文章
扫一扫
4267
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
