【java日志设计】使日志体现出处理流程（log classification）

  在我们编写程序的时候，日志是必不可少的，但是在并发较大或者涉及多线程的系统中，每个用户的请求所产生的日志交差打印，也会导致日志显示的混乱（如图1 普通日志），因此将每个日志标志为分类成一个用户访问所导致的日志是有一定合理性的（如图2 日志归类）。其实我们通过图一和图二就可以看出差别，我们可以通过错误打印的唯一标识符追踪之前的处理过程以及参数。怎么让每个请求的日志标志成一个呢？下文将围绕一个用户注册实例的web应用，说明如何便利生成唯一标识符并在每个日志中展现出来的样例。

图1 普通日志

图2 日志归类图

    在这里做一个场景，我们在用户进行注册帐号密码的时候，后台将这条记录插入到数据库中，并开启一个线程发送邮件给对方的邮箱处，发送的邮件中默认密码是大于8位的，前后两位不作处理，中间做去敏操作（打*号）。

一、方法一（不推荐）

    这是最为简单的方法，在一个请求产生的时候，我们生成一个唯一标识符作为loggerID，然后一传到底，并在打印的时候，将loggerID打印出来。具体的我们将以代码展现。

启动的main函数：

图3 方法一的Main函数

图4 方法一的dao

图5 方法一的controller

图6 方法一发邮件的线程

图7 方法一效果图

  总结：虽然可以满足需求，可以将所有日志归类为一个用户的请求产生的，但是过于耦合与繁杂，需要我们每次都将loggerID当作参数一传到底。这么繁琐的方法，而且还有一个问题，当exception打印出来的时候，并不会有loggerID出现。

  方法一有那么多的缺点，这当然不是我们这个博文所推荐了的，以下我们将介绍一个解耦并且不繁琐的方式解决这个问题。

二、方法二（推荐）

  在此方法中，我们仍然使用的是Spring Boot，logback与slf4j，之间我们会运用到filter与aop。具体的做法是，制作一个Filter，在每一个请求产生的时候，dispatcherServlet派发之前，生成一个唯一标识符作为loggerID，然后保存在MDC下和InheritableThreadLocal下，并在新产生的线程，在构造这个这个线程对象的时候从InheritableThreadLocal获取loggerID并将至保存在MDC下。在打印的框架下配置相应的打印格式，即可。no bb，let me show code。

图7 方法二的logback配置文件

图8 存loggerID的专属InheritableThreadLocal

图9 方法二的main函数

图10 方法二的filter（作用：生成loggerID，保存mdc与InheritableThreadLocal中）

图11 方法二的async

图12 方法二的controller

图13 方法二的aop代码

图14 方法二生成的日志

总结：首先，需要写个filter，生成loggerID，保存到mdc与InheritableThreadLocal中；第二，在新开启的线程写上aop（或者其他方式），从父线程中获取loggerID，并保存到MDC中；第三，在logback配置打印到mdc保存的loggerID。这个方法前期工作需要设计好，后续不用不断传输loggerID，成功解耦，也不需要打印的时候将loggerID显示写上去了。

说明：

1.代码将会放到github上，我将普通打印日志、方法一与方法二都放在了同一个项目，并将他们归类为不同的包，person.caspar.commonlogger是没有loggerID标志的普通项目的实现；person.caspar.mdclogger是方法二的实现；person.caspar.method1是方法一的实现。

2.在代码中我将发送邮件直接放到了dao中，由于时间关系我就懒得抽包，大家不要介意。

3.该博文的代码：https://github.com/casparhuan/generateloggerid