SLF4J MDC ☞ 将用户信息添加到日志信息中

zhaojun

2022 年 05 月 02 日

1833 次浏览

暂无评论

2552字数

默认分类

## 前言

你是否有过排查某个用户的操作出现 BUG 时, 从茫茫日志中寻找这个用户操作的痛苦经历, SLF4J 为我们提供了一种基于 `ThreadLocal` 来实现的 `MDC` 功能, 用来将自定义信息放入到日志中.

你可能没太明白啥意思, 那么先来看看效果把:

普通日志:
![](https://cdn.jun6.net/201902041823_308.png)

加上MDC的日志:
![](https://cdn.jun6.net/201902041825_734.png)

## 食用方式

可以使用过滤器, 拦截器或 AOP 等方式来实现, 即在用户请求时, 将用户信息写入到 `MDC` 中, 然后在请求完成后, 清空此 MDC.

我这里使用 SpringMVC 的拦截器 `HandlerInterceptor` 来演示下, (我这里使用了 Shiro, 所以会调用 Shiro 的代码来获取当前登录用户):

```java
@Component
public class LogInterceptor implements HandlerInterceptor {
 
    private final static String MDC_USERNAME = "username";
    private static final Logger LOGGER = LoggerFactory.getLogger(LogInterceptor.class);
 
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        // 如已进行登录, 则获取当前登录者的用户名放入 MDC 中.
        String username = "";
        if (SecurityUtils.getSubject().getPrincipal() != null) {
            username = ((User) SecurityUtils.getSubject().getPrincipal()).getUsername();
        }
        MDC.put(MDC_USERNAME, username);
        LOGGER.debug("MDC : PUT MDC_USERNAME ({}) in logger", username);
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        String username = MDC.get(MDC_USERNAME);
        LOGGER.debug("MDC : remove MDC_USERNAME ({}) from logger", username);
        MDC.remove(username);
    }
 
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
 
    }
}
```

再将其配置到 Spring 拦截器中:

```java
@Configuration
public class WebMvcConfigurer extends WebMvcConfigurerAdapter {

@Autowired
    private LogInterceptor logInterceptor;
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(logInterceptor);
        super.addInterceptors(registry);
    }
}
```

然后在日志格式中使用 `%X{username}` 将 MDC 添加进去即可, 由于我使用的是 SpringBoot 的 `logback`， 所以在保留原 SpringBoot 默认格式的同时, 加上了 MDC:

```properties
logging.pattern.console=%clr(%d{${LOG_DATEFORMAT_PATTERN:yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:%5p}) %clr(${PID}){magenta} %clr(---){faint} %clr([%15.15t]){faint} [%10.10X{username}] %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:%wEx}
```

最后修改：2022 年 05 月 02 日

如果觉得我的文章对你有用，请我喝杯咖啡吧。

SLF4J MDC ☞ 将用户信息添加到日志信息中

zhaojun • 2022 年 05 月 02 日

SLF4J MDC ☞ 将用户信息添加到日志信息中

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

谈裸辞和开源的体会

剑指 Offer 04. 二维数组中的查找

Shiro 学习 04 - 加密

通过 Github Actions 自动构建 ZFile 镜像并推送到 Docker Hub

优化 Java 项目 Docker 镜像内存占用从 500 M 到 100M

Shiro 学习 08 - 集成 Spring 之授权缓存

巧用 MyBatis 构建树形结构

RabbitMQ 笔记

Spring Boot 统一异常处理最佳实践 -- 拓展篇

从 JDK 源码中学习设计模式

SLF4J MDC ☞ 将用户信息添加到日志信息中

发表评论 取消回复 使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

SLF4J MDC ☞ 将用户信息添加到日志信息中

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款