别在 Java 代码里乱打日志了,这才是正确的打日志姿势!
点击上方“方志朋”,选择“置顶公众号”
技术文章第一时间送达!
来源: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
@Transactional
public 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());}
}
热门内容:
技术经理:求求你,别再乱改数据库连接池的大小了!
Sharding-JDBC教程:Spring Boot整合Sharding-JDBC实现分库分表+读写分离
Sharding-JDBC教程:Spring Boot整合Sharding-JDBC实现数据分表+读写分离
我的天!e.printStackTrace() 导致内存锁死,你敢信?
Sharding-jdbc教程:Springboot整合sharding-jdbc实现读写分离
感谢搓一下“在看
别在 Java 代码里乱打日志了,这才是正确的打日志姿势!相关推荐
- 别在 Java 代码里乱打日志了,这才是正确的日志打印姿势!
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 转自:公众号 石杉的架构笔记 作者:Lrwin 打日志的正确 ...
- 别在 Java 代码里乱打日志了,这才是正确的打日志姿势
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试资料 作者:lrwin 使用slf4j 使用门面模式的日志框架,有利于维 ...
- 别在 Java 代码里乱打日志了,这才是打印日志的正确姿势!
本文来源:http://t.cn/E9BkD7a 使用slf4j 使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一 实现方式统一使用: Logback框架 打日志的正确方式 什么时候应该打 ...
- 别在Java代码里乱打日志了,这才是正确的打日志姿势!
原文链接:http://t.cn/E9BkD7a 使用slf4j 使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一. 实现方式统一使用: Logback框架 打日志的正确方式 什么时候应该 ...
- java执行sql列名无效_列名无效!java代码里的SQL语句!数据库里可以得到正确为什么放java里出错了?...
在数据库里执行下面的SQL语句可得到正确结果,放在java代码里错误了!Stringsql="SELECTtradeId,t.cardNo,tradeType,tradeAmount,tar ...
- JAVA 代码里中文乱码问题
为什么80%的码农都做不了架构师?>>> 1.中文在代码里, 输出到控制台出现了乱码 解决方法:右键项目属性,修改编码格式为UTF-8,重新打包,部署启动.即可. 转载于:ht ...
- 代码命名,代码里的命名规则:错误的和正确的对比 命名方法总结 “自我描述的源代码”用代码表达出你的思想,让其他人通过代码能明白你的意图。...
http://www.aqee.net/express-names-in-code-bad-vs-clean/ 编程初学者总是把大量的时间用在学习编程语言,语法,技巧和编程工具的使用上.他们认为,如果 ...
- 【转】代码里的命名规则:错误的和正确的对比
原文出处: goyello 译文出处: 外刊IT评论 编程初学者总是把大量的时间用在学习编程语言,语法,技巧和编程工具的使用上.他们认为,如果掌握了这些技术技巧,他们就能成为不错的程序员.然而,计 ...
- java代码里的JSON格式怎么写好看_谁会不爱让代码骚里骚气的VSCode扩展插件呢?...
点击上方 "Python人工智能技术" 关注,星标或者置顶22点24分准时推送,第一时间送达 来自:公众号 读芯术 | 编辑:真经君 码农真经(ID:coder_experienc ...
最新文章
- 吐槽C++:C++ 类成员变量初始化 之 初始化带有参数的构造函数 的类成员变量。...
- Java的自动装箱与拆箱
- 电脑技巧:Win10系统中的这六种模式介绍
- Android之提示Caused by: java.lang.UnsupportedOperationException: Binary XML file line #67: You must sup
- 有哪些经济学理论可以用在谈恋爱上?
- 数字化转型之道:如何减少BI建设资源的浪费,缩短项目实施周期
- qwebkit 网页无法加载图片_网页图片无法显示了?这样就能解决
- 深入理解Java8 Lambda表达式
- corosycnpacemaker的高可用web集群
- 细数那些不能直视的IE6BUG
- 电力技术监督导则_会议报道:2019年电力行业燃煤发电企业节能监督管理专业技术人员及燃煤发电机组能效水平对标管理办法培训班...
- oppo服务器修改密码,修改锁屏密码(oppo锁屏密码更改)
- Mac下禁用开机自启软件
- php图片素描化,ps怎么把图片变成素描图片
- 计算机基础与应用说课ppt课件,广东省“XX杯”说课大赛计算机应用基础类一等奖作品:PPT写字动画的制作现场说课课件.ppt...
- 说一说我在创建星球这10多天,在星球里干了啥?
- ImageMagick将多张图片拼接成一张图片_介绍一款全功能的图片查看编辑软件
- php friend_Model/Friend.php · 跳跳虎1986/cwj - Gitee.com
- 35美金可以在Fiverr上让人帮你设计1个NFT卡通头像
- 使用canvas完成帧动画(方向键控制行走的小人)
热门文章
- 30分钟内让你明白正则表达式是什么,并对它有一些基本的了解(二)
- 第三章:创建用户界面组件--可视化组件(一)
- Datawhale组队学习 Task04:队列(2天)
- LeetCode实战:整数反转
- Java内部类手机专卖店_JAVA——内部类的那些事儿
- Imagination推出全新多核GPU IP系列:提供33种不同配置,AI算力达24 TOPS
- 一文看懂机器学习中的常用损失函数
- 恶犬秒变萌汪:东京大学开源“治愈系”GAN图片拼贴工具 | 技术头条
- 超过C++、压制Java与C,Python拔得TIOBE年度编程语言!
- 帮AI摆脱“智障”之名,NLP这条路还有多远?