原来这才是日志打印的正确姿势!
点击上方“朱小厮的博客”,选择“设为星标”
做积极的人,而不是积极废人
来源: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()); }}
想知道更多?扫描下面的二维码关注我
好文推荐:
基于数据库实现的分布式锁
基于Redis实现的分布式锁
为了追求极致的性能,Kafka掌控了这11项要领
>>>Learn More<<
喜欢就点个"在看"呗^_^
原来这才是日志打印的正确姿势!相关推荐
- 日志打印的正确姿势!
来源:http://t.cn/E9BkD7a 使用slf4j 使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一. 实现方式统一使用: Logback框架 打日志的正确方式 什么时候应该打日 ...
- “无门槛”短跑结束,专业度带来的长跑才是汽车服务的正确姿势?
文|曾响铃 来源|科技向令说(xiangling0815) 一边,是汽车保有量持续增加. 据公安部统计,2018年小型载客汽车保有量达2.01亿辆,首次突破2亿辆,私家车保有量达1.89亿辆,近五年年 ...
- 20G数据告诉你,这才是吃鸡的正确姿势
据某分析机构的研究表明,截止2018年4月,火爆全球的<绝地求生>收入已超10亿美元,其中有40%是中国的玩家.虽然国服还没遥遥无期,但作为游戏爱好者的小文也还是加入了吃鸡的大部队当中,作 ...
- 这才是互联网赚钱的正确姿势!你学会了吗?
2021 年已经过去了一半.你还不能感受到时间的急速流逝吗?有多少人还停留在2020年,依然活在过去.去年的疫情使全球经济陷入低迷,各行各业都不景气 时间不会等任何人,哪怕只有一秒.忙完忙后,闲暇之余 ...
- Linux中查看日志文件的正确姿势,求你别tail走天下了!
作为一个后端开发工程师,在Linux中查看查看文件内容是基本操作了.尤其是通常要分析日志文件排查问题,那么我们应该如何正确打开日志文件呢?对于我这种小菜鸡来说,第一反应就是 cat,tail,vi(或 ...
- sql 拼接int类型的字段_这才是SQL优化的正确姿势!
文末扫海报二维码领[30份Excel可视化数据看板] 磊哥 | 作者 Java中文社群 | 来源 全文内容预览: 当然,本篇是关于性能优化的,那性能优化就应该一把梭子吗?还是要符合一些规范和原则呢? ...
- 不要一把梭了,这才是SQL优化的正确姿势
全文内容预览: 性能优化原则和分类 性能优化一般可以分为: 主动优化 被动优化 所谓的主动优化是指不需要外力的推动而自发进行的一种行为,比如当服务没有明显的卡顿.宕机或者硬件指标异常的情况下,自我出发 ...
- mysql sql语句优化面试_面试不要一把梭了,这才是SQL优化的正确姿势
全文内容预览: 所以,在开始之前(MySQL 优化),咱们先来聊聊性能优化的一些原则. 性能优化原则和分类 性能优化一般可以分为:主动优化 被动优化 所谓的主动优化是指不需要外力的推动而自发进行的一种 ...
- 不要一把梭了,这才是SQL优化的正确姿势!
问题 1:单条 SQL 运行慢 问题分析 造成单条 SQL 运行比较慢的常见原因有以下两个: 未正常创建或使用索引: 表中数据量太大. 解决方案 1:创建并正确使用索引 索引是一种能帮助 MySQL ...
最新文章
- React 项目--设置根目录(8)
- linux安装google chrome
- 【Socket】linux广播技术
- python做好的程序如何变成小程序-使用python编写简单的小程序编译成exe跑在win10上...
- GTID的常见错误和处理方法
- 【Verilog HDL】深入理解部分语法规则的本质
- Spring基础——AOP
- NI myRIO-1900(ARM9)嵌入式小车2015.8-9
- TensorFlow 学习指南 二、线性模型
- 小米捐赠5亿启动“小米青年学者”项目 5年支持100所高校
- Kubernetes持久化存储2——探究实验
- 小学计算机第一册下教案,广东省小学信息技术第一册(下)全册教案
- Visual Studio调用约定 __cdecl、__stdcall和__fastcall
- html中绑定点击事件的三种方法
- python——月供计算器
- 计算机管理中其它设备问号,Win10设备管理器中设备上有白色问号如何解决
- 微信开发获取access_token(凭证)接口的详解
- 坑!U+03bf和U+006f
- 网络安全笔记-Web架构
- 无法获取'https://jcenter.bintray.com/com/网站的资源