### 配置
Log4j2 使用 YAML 格式并记录用户名
在
Spring Boot
2.6.6 中，虽然
Log4j2 的默认配置文件格式是 XML，但可以通过引入额外依赖支持 YAML 格式的
日志配置。同时，结合
MDC（Mapped Diagnostic Context）机制，可以在
日志中动态记录当前用户名信息。
#### 1. 添加依赖支持 YAML 配置
Log4j2 原生不支持 YAML 配置，因此需要引入额外的依赖来解析 YAML 格式的
日志配置文件。在 `pom.xml` 中添加以下依赖：
```xml
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson
-databind</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson
-dataformat
-yaml</artifactId>
</dependency>
```
这样可以确保
Spring Boot 能够正确加载 `
log4j2-spring.yml` 文件作为
日志配置来源 [^4]。
####
2. 创建 `
log4j2-spring.yml` 配置文件
在 `src/main/resources` 目录下创建 `
log4j2-spring.yml` 文件，内容如下：
```yaml
configuration:
status: warn
appenders:
Console:
name: Console
target: SYSTEM_OUT
PatternLayout:
pattern: "%d{yyyy
-MM
-dd HH:mm:ss} [%t] %
-5p %c{36}
- %X{username}
- %m%n"
loggers:
root:
level: info
appender
-ref:
- ref: Console
```
上述配置中，`%X{username}` 表示从
MDC 中提取 `username` 字段并写入
日志输出中 [^1]。
#### 3. 使用拦截器将用户名写入
MDC
为了在
日志中记录用户名，需要在请求处理过程中将用户名写入
MDC。可以通过实现 `HandlerInterceptor` 来完成：
```java
import org.slf4j.
MDC;
import org.
springframework.security.core.context.SecurityContextHolder;
import org.
springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class User
MdcInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
String username = "anonymous";
if (SecurityContextHolder.getContext().getAuthentication() != null &&
SecurityContextHolder.getContext().getAuthentication().isAuthenticated()) {
username = SecurityContextHolder.getContext().getAuthentication().getName();
}
MDC.put("username", username);
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
MDC.clear();
}
}
```
#### 4. 注册拦截器
通过配置类将拦截器注册到
Spring MVC 的请求处理链中：
```java
import org.
springframework.beans.factory.annotation.Autowired;
import org.
springframework.context.annotation.Configuration;
import org.
springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.
springframework.web.servlet.config.annotation.Web
MvcConfigurer;
@Configuration
public class WebConfig implements Web
MvcConfigurer {
@Autowired
private User
MdcInterceptor user
MdcInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(user
MdcInterceptor);
}
}
```
#### 5. 验证
日志输出
启动应用后，访问任意接口，
日志中将包含当前用户的用户名信息，例如：
```
20
23
-10
-01 1
2:34:56 [http
-nio
-8080
-exec
-1] INFO com.example.controller.HelloController
- admin
- helloworld, admin
```
上述输出中，`admin` 即为当前登录用户名称，通过
MDC 注入到
日志模板中 [^
2]。
### 注意事项
- 确保在请求结束时调用 `
MDC.clear()`，以避免线程复用导致的上下文污染。
- 若未使用
Spring Security，需根据实际认证机制获取用户名。
- YAML 格式配置
Log4j2 需要 Jackson 库支持，否则无法正确加载配置 [^4]。
---
这篇博客介绍了如何利用log4j的MDC（Mapped Diagnostic Context）配合Spring-mvc实现请求日志追踪。首先创建一个日志工具类设置和移除MDC的序列值，然后定义一个拦截器在请求开始时插入序列值，并在结束时移除。在spring-mvc.xml中配置拦截器，并在log4j配置文件中定制日志输出格式以显示序列值。
最低0.47元/天 解锁文章
扫一扫
705
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
