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

栏目: Java · 发布时间: 6年前

内容简介:你是否有过排查某个用户的操作出现 BUG 时, 从茫茫日志中寻找这个用户操作的痛苦经历, SLF4J 为我们提供了一种基于你可能没太明白啥意思, 那么先来看看效果把:可以使用过滤器, 拦截器或 AOP 等方式来实现, 即在用户请求时, 将用户信息写入到

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

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

普通日志:

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

加上MDC的日志:

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

食用方式

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

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

@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 拦截器中:

@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:

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}

以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

系统程序员成长计划

系统程序员成长计划

李先静 / 人民邮电出版社 / 2010-04 / 45.00

在学习程序开发的过程中,你是否总是为自己遇到的一些问题头疼不已,你是否还在为写不出代码而心急如焚?作为软件开发人员,你是否时时为自己如何成为一名合格的程序员而困惑不已?没关系,本书将为你排忧解难。 这是一本介绍系统程序开发方法的书。书中结合内容详尽的代码细致讲述了不少底层程序开发基础知识,并在逐步深入的过程中介绍了一些简单实用的应用程序,最后还讲述了一些软件工程方面的内容,内容全面,语言生动......一起来看看 《系统程序员成长计划》 这本书的介绍吧!

JSON 在线解析
JSON 在线解析

在线 JSON 格式化工具

XML 在线格式化
XML 在线格式化

在线 XML 格式化压缩工具

RGB CMYK 转换工具
RGB CMYK 转换工具

RGB CMYK 互转工具