不能精准定位bug?可能是你没get到这几个打印日志的诀窍!
作者:lrwinx
来源:http://t.cn/E9BkD7a
使用slf4j
使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。
实现方式统一使用: Logback框架
打日志的正确方式
什么时候应该打日志
当你遇到问题的时候,只能通过debug功能来确定问题,你应该考虑打日志,良好的系统,是可以通过日志进行问题定位的。
当你碰到if…else 或者 switch这样的分支时,要在分支的首行打印日志,用来确定进入了哪个分支
经常以功能为核心进行开发,你应该在提交代码前,可以确定通过日志可以看到整个流程
基本格式
必须使用参数化信息的方式:
logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);
对于debug日志,必须判断是否为debug级别后,才进行使用:
if (logger.isDebugEnabled()) { logger.debug("Processing trade with id: " +id + " symbol: " + symbol);}
不要进行字符串拼接,那样会产生很多String对象,占用空间,影响性能。
反例(不要这么做):
logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
使用[]进行参数变量隔离
如有参数变量,应该写成如下写法:
logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);
这样的格式写法,可读性更好,对于排查问题更有帮助。
不同级别的使用
ERROR:
基本概念
影响到程序正常运行、当前请求正常运行的异常情况:
打开配置文件失败
所有第三方对接的异常(包括第三方返回错误码)
所有影响功能使用的异常,包括:SQLException和除了业务异常之外的所有异常(RuntimeException和Exception)
不应该出现的情况:
比如要使用Azure传图片,但是Azure未响应
如果有Throwable信息,需要记录完成的堆栈信息:
log.error("获取用户[{}]的用户信息时出错",userName,e);
说明
如果进行了抛出异常操作,请不要记录error日志,由最终处理方进行处理:
反例(不要这么做):
try{ ....}catch(Exception ex){ String errorMessage=String.format("Error while reading information of user [%s]",userName); logger.error(errorMessage,ex); throw new UserServiceException(errorMessage,ex);}
WARN
基本概念
不应该出现但是不影响程序、当前请求正常运行的异常情况:
有容错机制的时候出现的错误情况
找不到配置文件,但是系统能自动创建配置文件
即将接近临界值的时候,例如:
缓存池占用达到警告线
业务异常的记录,比如:
当接口抛出业务异常时,应该记录此异常
INFO:
基本概念
系统运行信息
Service方法中对于系统/业务状态的变更
主要逻辑中的分步骤
外部接口部分
客户端请求参数(REST/WS)
调用第三方时的调用参数和调用结果
说明
并不是所有的service都进行出入口打点记录,单一、简单service是没有意义的(job除外,job需要记录开始和结束,)。
反例(不要这么做):public List listByBaseType(Integer baseTypeId) { log.info("开始查询基地");BaseExample ex=new BaseExample();BaseExample.Criteria ctr = ex.createCriteria();ctr.andIsDeleteEqualTo(IsDelete.USE.getValue());Optionals.doIfPresent(baseTypeId, ctr::andBaseTypeIdEqualTo); log.info("查询基地结束");return baseRepository.selectByExample(ex); }
对于复杂的业务逻辑,需要进行日志打点,以及埋点记录,比如电商系统中的下订单逻辑,以及OrderAction操作(业务状态变更)。
对于整个系统的提供出的接口(REST/WS),使用info记录入参
如果所有的service为SOA架构,那么可以看成是一个外部接口提供方,那么必须记录入参。
调用其他第三方服务时,所有的出参和入参是必须要记录的(因为你很难追溯第三方模块发生的问题)
DEBUG
基本概念
可以填写所有的想知道的相关信息(但不代表可以随便写,debug信息要有意义,最好有相关参数)
生产环境需要关闭DEBUG信息
如果在生产情况下需要开启DEBUG,需要使用开关进行管理,不能一直开启。
说明
如果代码中出现以下代码,可以进行优化:
//1. 获取用户基本薪资
//2. 获取用户休假情况
//3. 计算用户应得薪资
优化后的代码:
logger.debug("开始获取员工[{}] [{}]年基本薪资",employee,year);
logger.debug("获取员工[{}] [{}]年的基本薪资为[{}]",employee,year,basicSalary);logger.debug("开始获取员工[{}] [{}]年[{}]月休假情况",employee,year,month);
logger.debug("员工[{}][{}]年[{}]月年假/病假/事假为[{}]/[{}]/[{}]",employee,year,month,annualLeaveDays,sickLeaveDays,noPayLeaveDays);logger.debug("开始计算员工[{}][{}]年[{}]月应得薪资",employee,year,month);
logger.debug("员工[{}] [{}]年[{}]月应得薪资为[{}]",employee,year,month,actualSalary);
TRACE
基本概念
特别详细的系统运行完成信息,业务代码中,不要使用.(除非有特殊用意,否则请使用DEBUG级别替代)
规范示例说明
@Override@Transactionalpublic void createUserAndBindMobile(@NotBlank String mobile, @NotNull User user) throws CreateConflictException{ boolean debug = log.isDebugEnabled(); if(debug){ log.debug("开始创建用户并绑定手机号. args[mobile=[{}],user=[{}]]", mobile, LogObjects.toString(user)); } try { user.setCreateTime(new Date()); user.setUpdateTime(new Date()); userRepository.insertSelective(user); if(debug){ log.debug("创建用户信息成功. insertedUser=[{}]",LogObjects.toString(user)); } UserMobileRelationship relationship = new UserMobileRelationship(); relationship.setMobile(mobile); relationship.setOpenId(user.getOpenId()); relationship.setCreateTime(new Date()); relationship.setUpdateTime(new Date()); userMobileRelationshipRepository.insertOnDuplicateKey(relationship); if(debug){ log.debug("绑定手机成功. relationship=[{}]",LogObjects.toString(relationship)); } log.info("创建用户并绑定手机号. userId=[{}],openId=[{}],mobile=[{}]",user.getId(),user.getOpenId(),mobile); // 如果考虑安全,手机号记得脱敏 }catch(DuplicateKeyException e){ log.info("创建用户并绑定手机号失败,已存在相同的用户. openId=[{}],mobile=[{}]",user.getOpenId(),mobile); throw new CreateConflictException("创建用户发生冲突, openid=[%s]",user.getOpenId()); }}
长按订阅更多精彩▼
如有收获,点个在看,诚挚感谢
不能精准定位bug?可能是你没get到这几个打印日志的诀窍!相关推荐
- Bug整理——阿里Ons高版本引入后Spring项目不打印日志问题
报错信息 2018-07-06 18:48:44,346 main INFO Log4j appears to be running in a Servlet environment, but the ...
- 测试工程师用 Shell 定位 Bug 的正确姿势 | 福利
Shell 作为一门最常见的脚本语言,是测试工程师日常工作的重度依赖工具.相对 Python.Ruby 等其他脚本语言,Shell 就像一把趁手的军用匕首,轻量敏捷,是深入分析待测系统的利器,也是自动 ...
- 软件测试-工作流程(需求分析评审、测试计划、测试用例、用例评审、执行测试、跟踪定位bug、测试报告、缺陷报告)
一.需求分析.评审 (1)需求分析 对要解决的问题进行详细的分析,弄清楚问题的要求,包括需要输入什么数据,要得到什么结果,最后应输出什么. ①如何做需求分析? 通读需求,对需求有个大致的了解,比如: ...
- 【数字信号处理】相关函数应用 ( TDOA 时差估计 | 时间差与距离差 | 方向定位与精准定位 | 信号描述 | 通过相关函数求时间差 )
文章目录 一.TDOA 时差估计 1.信号相关函数 2.时间差与距离差 3.方向定位与精准定位 4.2 个信号的函数描述 5.通过相关函数求时间差 一.TDOA 时差估计 假设有一个 " 信 ...
- 缺陷定位 | 分析推理定位BUG案例(三)
往期关联文章: 缺陷定位 | 测试发现了Bug,还要分析定位Bug?(一) 缺陷定位 | 如何精准效率分析推测BUG定位(二) 运营反馈,生产环境,WEB端管理后台,岗位审核详情,视频无法正常播放 表 ...
- 自学前端第十八天:CSS精准定位position
超级重点:CSS精准定位(position) 一. ①CSS定位基本概念:如果说, float浮动关键在一个 "浮起来" 字上面, 那么 我们的position定位关键在于一个 & ...
- HaaS100开发调试系列 之 使用AliOS Things诊断调试组件定位Bug
1.背景 在嵌入式开发中,我们经常遇到的一个问题是:写代码一个不小心,就制造了一个bug,C语言中bug的威力大家也心知肚明--可以直接把系统搞挂! 即大家常见的系统死机.系统重启等等:而问题的来源或 ...
- 弘辽科技:做电商开网店流量不精准?你的人群标签没做好
原标题<弘辽科技:做电商开网店流量不精准?你的人群标签没做好> 很多做电商开网店的商家都说店铺的流量不够精准,其实是店铺没有标签的原因. 弘辽科技给大家举个例子:一个一米七的小胖子天天来你 ...
- 如何实现室内Wi-Fi无线终端的精准定位
如何实现室内Wi-Fi无线终端的精准定位 如何实现室内Wi-Fi无线终端的精准定位 随着商圈020的兴起,室内定位技术的也如百花争艳般不断涌现.但随着室内Wi-Fi网的架设普及,基于Wi-Fi定位技术 ...
最新文章
- 优先队列如何按照pair 的第二关键字排序(对比vector按照pair第二关键字排序)
- java 短信猫发送短信的方法
- 智慧交通day02-车流量检测实现06:目标估计模型-卡尔曼滤波(汇总)
- Python——PyCharm常用快捷键
- Spark Job Scheduling
- Jenkins小坑之执行Shell
- 奇安信代码安全实验室帮助Red Hat修复多个QEMU高危漏洞,获官方致谢
- 解决:WebDriverException: 'chromedriver' executable needs to be in PATH
- 网页版电脑桌面远程操控_我真的再也不买电暖器了 - 电暖器智能版
- 笔记系列------sqlloader的使用
- i3wm学习笔记-基础快捷键
- Java-UML类图
- windows系统上删除顽固文件
- Python批量复制文件夹(以及所有子文件夹)下的某类型文件
- STM32控制启动步进电机
- Axure教程 原型设计工具Axure RP新手入门教程(一):基础
- 大厂Offer拿到手软啊!隔壁都馋哭了
- 算法 - 递归实现汉诺塔(The Tower of Hanoi)
- python:pandas全DataFrame查询定位赋值数值所在行列
- Java对接地磅串口工作日志