这才是JAVA中打印日志的正确姿势
作者:lrwin
原文链接:http://t.cn/E9BkD7a
使用slf4j
1. 使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一
2. 实现方式统一使用: Logback框架
打日志的正确方式
什么时候应该打日志
1. 当你遇到问题的时候,只能通过debug功能来确定问题,你应该考虑打日志,良好的系统,是可以通过日志进行问题定位的。
2. 当你碰到if…else 或者 switch这样的分支时,要在分支的首行打印日志,用来确定进入了哪个分支
3. 经常以功能为核心进行开发,你应该在提交代码前,可以确定通过日志可以看到整个流程
基本格式
必须使用参数化信息的方式:
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:
基本概念
影响到程序正常运行、当前请求正常运行的异常情况:
1. 打开配置文件失败
2. 所有第三方对接的异常(包括第三方返回错误码)
3. 所有影响功能使用的异常,包括: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
基本概念
不应该出现但是不影响程序、当前请求正常运行的异常情况:
1. 有容错机制的时候出现的错误情况
2. 找不到配置文件,但是系统能自动创建配置文件
即将接近临界值的时候,例如:
缓存池占用达到警告线
业务异常的记录,比如:
当接口抛出业务异常时,应该记录此异常
INFO:
基本概念
系统运行信息
1. Service方法中对于系统/业务状态的变更
2. 主要逻辑中的分步骤
外部接口部分
1. 客户端请求参数(REST/WS)
2. 调用第三方时的调用参数和调用结果
说明
1. 并不是所有的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);}
2. 对于复杂的业务逻辑,需要进行日志打点,以及埋点记录,比如电商系统中的下订单逻辑,以及OrderAction操作(业务状态变更)。
3. 对于整个系统的提供出的接口(REST/WS),使用info记录入参
4. 如果所有的service为SOA架构,那么可以看成是一个外部接口提供方,那么必须记录入参。
5. 调用其他第三方服务时,所有的出参和入参是必须要记录的(因为你很难追溯第三方模块发生的问题)
DEBUG
基本概念
1. 可以填写所有的想知道的相关信息(但不代表可以随便写,debug信息要有意义,最好有相关参数)
2. 生产环境需要关闭DEBUG信息
3. 如果在生产情况下需要开启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()); }}
END
有道无术,术可成;有术无道,止于术
欢迎大家关注Java之道公众号
好文章,我在看❤️
这才是JAVA中打印日志的正确姿势相关推荐
- java logger使用_这才是JAVA中打印日志的正确姿势
作者:lrwin 原文链接:http://t.cn/E9BkD7a 使用slf4j 1. 使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一 2. 实现方式统一使用: Logback框架 打 ...
- 别在 Java 代码里乱打日志了,这才是打印日志的正确姿势!
本文来源:http://t.cn/E9BkD7a 使用slf4j 使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一 实现方式统一使用: Logback框架 打日志的正确方式 什么时候应该打 ...
- java打印图片到页面_在Java中打印BufferedImage的正确方法
这是我的一个Java项目中的一个.此代码将在打印机页面上缩放和打印一个图像. 你这样称呼它: printButton.addActionListener(new ActionListener() { ...
- 如何从Java中打印XML?
本文翻译自:How to pretty print XML from Java? I have a Java String that contains XML, with no line feeds ...
- Android:Android NDK项目中C++文件中打印日志
Android NDK项目中C++文件中打印日志 工作需要,在NDK项目中的C++文件中打印日志,还是费了点劲查找 才达到自己 想要的效果了. 步骤 添加头文件 添加头文件 定义宏函数 #includ ...
- java中的日志处理
java中的日志处理简介 在Java中我们可以使用自定义的.可扩展的日志处理方式.我们不仅可以使用Java中java.util.logging包提供的基本的日志相关的API来进行日志的处理,也可以使用 ...
- Java中的日志级别
昨天校招面试被问到了Java中的日志等级,当时也慌的一批,只说出了其中的三个,在这里细心为大家总结一下. java中⽇志级别有7 个级别: severe.Warning.info.config.fi ...
- java中log日志的使用(完全版)
Commons_logging包 Apache通用日志包 他为Log4JLogger:NoOpLog:LogKitLogger:Jdk14Logger:AvalonLogger提供了一共通用的接口进行 ...
- java中logger_Java日志系统---Logger之简单入门
Java 中自带的日志系统,今天抽空了解了一点,算是入了门,所以将自己的一些心得记录下来,以备日后查看,有兴趣的朋友,看到此文章,觉得有错误或需要添加的地方,请在下方评论留言,大家可以共同进步,谢谢: ...
最新文章
- 不同函数之间的跳转setjmp和longjmp
- 服务器和客户端之间的变量交互
- Linux 服务器如何修改主机名
- Semaphore 类
- SharePoint技术峰会2009视频(6)
- python扫雷游戏课程设计小组任务计划与分配表_python实现扫雷游戏
- Visual C# 诠释常用排序算法
- JAVA中的反射机制和模块化
- java八大基本类型介绍
- 韩国两名男子因偷拍汽车旅馆视频被捕 1600名房客受害
- amos看拟合度在哪里看_360度看佛山战“疫”
- appium+python自动化51-adb文件导入和导出(pull push)
- MVC进阶学习--HtmlHelper控件解析(五)
- 三菱PlC程序大型项目QCPU+QD77MS16 包含一套完整的电气开发系统资料
- 图片中加入超链接html代码,html网页超链接代码 怎样用HTML代码在图片插入超链接...
- 优化家庭广电宽带网络设置
- 明翰英语教学系列之形容词与副词篇V0.1(持续更新)
- scrapy简单示例
- 资深老狐一句感叹:白学了,猫猫究竟有什么魔力,一小时等于十年功?
- 金蝶K3 库存收发汇总
热门文章
- python如何输入多个数据并增加到一个列表里_python 将表格多个列数据放到同一个单元格中...
- Wi-Fi 6连续两年出货量国内登顶,锐捷无线靠什么这么6?
- AVB Digest转换成ASCII码
- mysql的引双向链表_一分钟掌握MySQL的InnoDB引擎B+树索引
- (操作系统题目题型总结)第二章:处理器管理
- (王道408考研数据结构)第一章绪论-第二节2:算法的时间复杂度和空间复杂度
- Linux查看所有用户及用户管理命令
- windows10环境下载labelImg及使用方法
- 使用证书登陆Linux服务器
- C# Task 用法