程序员你为什么这么累【续】:编码习惯之日志建议
转自:https://mp.weixin.qq.com/s?__biz=MzAxODcyNjEzNQ==&mid=2247484164&idx=1&sn=8351e9fb42e6471e31d1c060d46bfafa&chksm=9bd0ae9caca7278a0941e8044a042775a707ec0dc8873f4da4bc1a7628f2462a10085a83206c&mpshare=1&scene=23&srcid=0924D5ojSzBQKv8V7EmXAqxs#rd
——请先阅读这3篇文章:
程序员你为什么这么累?
我的编码习惯 - 接口定义
我的编码习惯 - Controller规范
开发中日志这个问题,每个公司都强调,也制定了一大堆规范,但根据实际情况看,效果不是很明显,主要是这个东西不好测试和考核,没有日志功能一样跑啊。
但编程活久见,开发久了,总会遇到“这个问题生产环境上能重现,但是没有日志,业务很复杂,不知道哪一步出错了?” 这个时候,怎么办? 还能怎么办,发个版本,就是把所有地方加上日志,没有任何新功能,然后在让用户重现一遍,拿下日志来看,哦,原来是这个问题。
有没有很熟悉的感觉?
还有一种情况,我们系统有3*5=15个节点,出了问题找日志真是痛苦,一个一个机器翻,N分钟后终于找到了,找到了后发现好多相似日志,一个一个排查;日志有了,发现逻辑很复杂,不知道走到哪个分支,只能根据逻辑分析,半天过去了,终于找到了原因。。。一个问题定位就过去了2个小时,变更时间过去了一半。。。
所以我对日志的最少有以下2点要求:
能找到那个机器
能找到用户做了什么
针对第一点,我修改了一下nginx的配置文件,让返回头里面返回是哪个机器处理的。
nginx的基本配置,大家查阅一下资料就知道。简单配置如下(生产环境比这个完善)
效果如图,返回了处理的节点:
第二点,要知道用户做了什么。用户信息是很重要的一个信息,能帮助海量日志里面能快速找到目标日志。一开始要求开发人员打印的时候带上用户,但是发现这个落地不容易,开发人员打印日志都经常忘记,更加不用说日志上加上用户信息,我也不可能天天看代码。所以找了一下log4j的配置,果然log4j有个叫MDC(Mapped Diagnostic Context)的类(技术上使用了ThreadLocal实现,重点技术)。具体使用方法请自行查询。具体使用如下:
filter中得到用户信息,并放入MDC,记住filter后要清理掉(因为tomcat线程池线程重用的原因)。
用户信息放入MDC:
log4j配置,增加用户信息变量:
我做好上面2步后,对开发人员的日志只有3点要求:
1. 修改(包括新增)操作必须打印日志
大部分问题都是修改导致的。数据修改必须有据可查。
2. 条件分支必须打印条件值,重要参数必须打印
尤其是分支条件的参数,打印后就不用分析和猜测走哪个分支了,很重要!如下面代码里面的userType,一定要打印值,因为他决定了代码走哪个分支。
3. 数据量大的时候需要打印数据量
前后打印日志和最后的数据量,主要用于分析性能,能从日志中知道查询了多少数据用了多久。这点是建议。自己视情况而决定是否打印,我一般建议打印。
加上一篇AOP,最后的日志如下:
其实日志的级别我到不是很关注,还没有到关注这步到时候。开发组长需要做好后勤工作(前面2步),然后制定简单规则,规则太多太能落实了。
日志这个东西,更多是靠自觉,项目组这么多人,我也不可能一个一个给大家看代码,然后叫你加日志。我分析了一下,为什么有些人没有打印日志的习惯,说了多次都改不过来。我建议大家养成下面的习惯,这样你的日志就会改善多了!
1. 不要依赖debug,多依赖日志。
别人面对对象编程,你面对debug编程。有些人无论什么语言,最后都变成了面对debug编程。哈哈。这个习惯非常非常不好!debug会让你写代码的时候偷懒不打日志,而且很浪费时间。改掉这个恶习。
2. 代码开发测试完成之后不要急着提交,先跑一遍看看日志是否看得懂。
日志是给人看的,只要热爱编程的人才能成为合格程序员,不要匆匆忙忙写完功能测试ok就提交代码,日志也是功能的一部分。要有精益求精的工匠精神!
日志规范想不到写了这么多,不容易啊。觉得有帮助请点赞加关注,其他规范敬请期待!更多内容请持续关注!
推荐阅读
程序员你为什么这么累?
程序员你为什么这么累[续]:编码习惯之接口定义
Logback+ELK+SpringMVC搭建日志收集服务器
在Pivotal Web Service上发布Spring Boot应用
Spring Cloud构建微服务架构:服务网关(基础)【Dalston版】
转载于:https://www.cnblogs.com/leonxyzh/p/7586637.html
程序员你为什么这么累【续】:编码习惯之日志建议相关推荐
- 程序员你为什么这么累【续】:编码习惯之工具类规范
导读: 程序员你为什么这么累? 我的编码习惯 - 接口定义 我的编码习惯 - Controller规范 我的编码习惯 - 日志建议 我的编码习惯 - 异常处理 我的编码习惯 - 参数校验和国际化规范 ...
- 程序员你为什么这么累【续】:如何应对需求变更
作者:晓风轻原文:https://zhuanlan.zhihu.com/p/28719726 我之前的文章 程序员你为什么这么累? 中,我个人观点是加班原因是编码质量占了大部分因素,但是不少同学都不认 ...
- 读书笔记之《程序员你为什么这么累-晓风轻编码规范》
<程序员你为什么这么累-晓风轻编码规范> 讲述关于编码规范的示例,怎么样定义接口和代码模板,怎么样把业务代码写简单清晰. 使用场景:日常项目开发中可以时长查看,符合条件可以应用到. 一.目 ...
- java程序员到底有多累_程序员到底有多累、多辛苦?
原标题:程序员到底有多累.多辛苦? 至少在全中国的诸多职业中,比程序员更轻松的并不多,大多数职业都比程序员更累,更辛苦. IT行业这不算苦,不算累,只是有点智力门槛而已. (一)程序员跟医生比如何 你 ...
- [转]后端程序员必备:书写高质量SQL的30条建议
以下文章来源于捡田螺的小男孩 ,作者捡田螺的小男孩 转载:<后端程序员必备:书写高质量SQL的30条建议> 前言 本文将结合实例demo,阐述30条有关于优化SQL的建议,多数是实际开发中 ...
- 程序员你为什么这么累?
大家一提到程序员,首先想到的是以下标签:苦逼,加班,熬夜通宵.但是,但凡工作了的同学都知道,其实大部分程序员做的事情都很简单,代码CRUD可以说毫无技术含量,就算什么不懂依葫芦画瓢很多功能也能勉强做出 ...
- 程序员你为什么这么累?导读
大家一提到程序员,首先想到的是以下标签:苦逼,加班,熬夜通宵.但是,但凡工作了的同学都知道,其实大部分程序员做的事情都很简单,代码CRUD可以说毫无技术含量,就算什么不懂依葫芦画瓢很多功能也能勉强做出 ...
- 程序员为什么你那么累!!!
前言 一提到程序员,大家首先想到的是以下标签:苦逼.加班.通宵熬夜.但是,凡是工作了的人都知道,其实大部分程序员做的事情很简单,代码CRUD可以说毫无技术含量,就算什么不懂依葫芦画瓢很多功能也能勉强做 ...
- 程序员趣味读物:谈谈Unicode编码
2019独角兽企业重金招聘Python工程师标准>>> 这是一篇程序员写给程序员的趣味读物.所谓趣味是指可以比较轻松地了解一些原来不清楚的概念,增进知识,类似于打RPG游戏的升级.整 ...
最新文章
- laravel在wamp中输入地址后总是无法访问
- o型圈沟槽设计_液压密封件产品、沟槽设计、安装质量要求
- 细节满满!理解对比学习和SimCSE,就看这6个知识点
- java小编程---最长公共前缀
- 一个震撼的交互型3D可视化R包 - 可直接转ggplot2图为3D
- perl语言得到的txt文档只有表头_编程语言排行榜第一Python,为何频繁遭受开发者的嫌弃!...
- 52. N-Queens II (Array; Back-Track)
- 实际使用Windows 7中的Readyboost功能
- java:从淘宝获取优惠券的、带推广链接的、带淘口令的商品信息
- 项目管理的十个经典法则
- 写代码python用什么笔记本好_求推荐适合程序员用的笔记本电脑
- matlab画PV曲线程序,Matlab模拟包络线形成:Envolope程序
- 2022.6.20-6.26 AI行业周刊(第103期):新的小生命
- Java实现交叉表_Sql交叉表简单实现 | 学步园
- 数字调制BPSK/QPSK/QAM/ASK/FSK/PSK
- Fabric v2.3 下载二进制文件和镜像bootstrap.sh脚本解析
- 【论文学习】5、基于OFDM无线局域网的载波频偏估计
- ORA-12519,nbsp;TNS:nonbsp;appr…
- 大学计算机应用基础考试题库,大学计算机应用基础考试题库.doc
- 计算机组成原理-第一章(1)-概述