【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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,830评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,992评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,875评论 0 331
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,837评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,734评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,091评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,550评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,217评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,368评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,298评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,350评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,027评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,623评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,706评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,940评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,349评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,936评论 2 341

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,566评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,275评论 25 707
  • 从三月份找实习到现在,面了一些公司,挂了不少,但最终还是拿到小米、百度、阿里、京东、新浪、CVTE、乐视家的研发岗...
    时芥蓝阅读 42,160评论 11 349
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,533评论 18 399
  • 一 理想,你若是蝴蝶, 年少的我便会义无反顾的去追逐, 在那青草茫茫的废弃的田地上, 理想,你若是蝴蝶, 现在的我...
    顾子茕阅读 107评论 0 1