在Spring Boot中
实现**多租户的日志上下文自动注入**，主要是为了在日志中自动带上当前请求所属的**租户信息（tenant_id）**，便于后续日志分析、告警、追踪等操作。
实现的关键技术是使用 **MDC（Mapped Diagnostic Context）**，它是Logback/Log4j2等日志框架提供的一个线程上下文映射功能，可以将上下文信息（如租户ID、用户ID、trace_id等）自动注入到每条日志中。
---
## ✅ 一、
实现目标
- 在每个请求中自动识别当前租户（tenant_id）。
- 将租户信息写入MDC上下文。
- 日志输出时自动包含租户信息。
- 支持异步线程上下文传递（如CompletableFuture、@Async等）。
---
## ✅ 二、
实现步骤
### 1. 添加依赖（以Logback为例）
```xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
```
默认使用Logback作为日志框架。
---
### 2. 自定义拦截器（识别租户并注入MDC）
```
java
@Component
public class TenantContextInterceptor implements
HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object
handler) throws Exception {
// 从Header、参数、Token中获取租户ID
String tenantId = request.getHeader("X-Tenant-ID"
);
if (tenantId == null || tenantId.isEmpty(
)) {
tenantId = "default";
}
// 设置到MDC
MDC.put("tenant_id", tenantId
);
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object
handler, Exception ex
) throws Exception {
// 清除MDC，防止线程复用问题
MDC.clear(
);
}
}
```
### 3. 注册拦截器
```
java
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private TenantContextInterceptor tenantContextInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry
) {
registry.addInterceptor(tenantContextInterceptor
);
}
}
```
---
### 4. 配置日志格式（logback-spring.xml）
```xml
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg [tenant_id=%X{tenant_id}]%n</pattern>
</encoder>
</appender>
<root level="info">
<appender-ref ref="STDOUT"/>
</root>
</configuration>
```
输出示例：
```
2025-04-05 10:00:00.000 [http-nio-8080-exec-1] INFO com.example.demo.MyController - Hello World [tenant_id=tenantA]
```
---
## ✅ 三、支持异步线程上下文传递（关键）
MDC是基于
ThreadLocal的，无法自动传递到子线程。要支持异步线程中也携带租户信息，可以使用以下方法：
### 方法1：使用 `@Async` + `AsyncConfigurerSupport`
```
java
@Configuration
@EnableAsync
public class AsyncConfig extends AsyncConfigurerSupport {
@Override
public Executor getAsyncExecutor(
) {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(
);
executor.setCorePoolSize(5
);
executor.setMaxPoolSize(10
);
executor.setThreadNamePrefix("async-"
);
executor.setTaskDecorator(runnable -> {
// 保存当前MDC上下文
Map<String, String> contextMap = MDC.getCopyOfContextMap(
);
return (
) -> {
try {
// 恢复上下文
if (contextMap != null
) {
MDC.setContextMap(contextMap
);
}
runnable.run(
);
} finally {
MDC.clear(
);
}
};
}
);
executor.initialize(
);
return executor;
}
}
```
### 方法2：使用 Transmittable
ThreadLocal（推荐）
使用 Alibaba 的 [Transmittable
ThreadLocal](https://github.com/alibaba/transmittable-thread-
local) 可以自动支持线程池、CompletableFuture、ForkJoinPool 等场景。
```xml
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>transmittable-thread-
local</artifactId>
<version>2.12.1</version>
</dependency>
```
---
## ✅ 四、完整流程图
```
[HTTP请求]
↓
[TenantContextInterceptor 设置MDC]
↓
[Controller/Service 输出日志]
↓
[日志格式自动包含tenant_id]
↓
[异步线程中通过TaskDecorator或TTL保持上下文]
```
---
## ✅ 五、总结
| 模块 | 技术点 | 说明 |
|------|--------|------|
| 租户识别 | Interceptor | 从Header/Token中提取tenant_id |
| 上下文注入 | MDC | 使用Logback的Mapped Diagnostic Context |
| 日志格式 | logback-spring.xml | 在pattern中加入 `%X{tenant_id}` |
| 异步支持 | TaskDecorator / TTL |
保证线程池中也能传递上下文 |
| 日志分析 | Elasticsearch/Kibana | 可按tenant_id字段做日志隔离与查询 |
---
## ✅ 示例项目结构
```
src/
├── main/
│ ├──
java/
│ │ └── com.example.demo/
│ │ ├── config/
│ │ │ ├── WebConfig.
java
│ │ │ └── AsyncConfig.
java
│ │ ├── interceptor/
│ │ │ └── TenantContextInterceptor.
java
│ │ └── controller/
│ │ └── DemoController.
java
│ └── resources/
│ ├── logback-spring.xml
│ └── application.yml
```
---
ThreadLocal在Java中用于创建线程局部变量，确保不同线程拥有独立的数据副本，避免相互干扰。它在Looper、ActivityThread和AMS等组件中得到应用，解决了线程间数据隔离的问题。ThreadLocal的get和set方法操作的是每个线程内部的数组，确保了多线程环境下数据的安全性和独立性。
扫一扫
8780
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
