工作总结：日志打印的15个建议

前言

日志是快速定位问题的好帮手，是撕逼和甩锅的利器！打印好日志非常重要。今天我们来聊聊日志打印的15个好建议~

1. 选择恰当的日志级别

常见的日志级别有5种，分别是error、warn、info、debug、trace。日常开发中，我们需要选择恰当的日志级别，不要反手就是打印info哈~

6e2c23d8fc2fa64266ea2716f599f789.png

  • error：错误日志，指比较严重的错误，对正常业务有影响，需要运维配置监控的；

  • warn：警告日志，一般的错误，对业务影响不大，但是需要开发关注；

  • info：信息日志，记录排查问题的关键信息，如调用时间、出参入参等等；

  • debug：用于开发DEBUG的，关键逻辑里面的运行时数据；

  • trace：最详细的信息，一般这些信息只记录到日志文件中。

2.日志要打印出方法的入参/出参

我们并不需要打印很多很多日志，只需要打印可以快速定位问题的有效日志。有效的日志，是甩锅的利器！

18fc9868ebfb5ef2da2c7665ba8b4280.png

哪些算得的上有效关键的日志呢？比如说，方法进来的时候，打印入参。再然后呢，在方法返回的时候，就是打印出参，返回值。入参的话，一般就是userId或者bizSeq这些关键信息。正例如下：

public String testLogMethod(Document doc, Mode mode){log.debug(“method enter param：{}”,userId);String id = "666";log.debug(“method exit param：{}”,id);return id;
}

3. 选择合适的日志格式

理想的日志格式，应当包括这些最基本的信息：如当前时间戳（一般毫秒精确度）、日志级别，线程名字等等。在logback日志里可以这么配置：

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n</pattern></encoder>
</appender>

如果我们的日志格式，连当前时间都沒有记录，那连请求的时间点都不知道了？

67a6527ac0ac4c60d4ab4e83281fdf93.png

4. 遇到if...else...等条件时，每个分支首行都尽量打印日志

当你碰到if...else...或者switch这样的条件时，可以在分支的首行就打印日志，这样排查问题时，就可以通过日志，确定进入了哪个分支，代码逻辑更清晰，也更方便排查问题了。

d54f4522a5c717cb24f05a24c5d2c3b5.png

正例：

if(user.isVip()){log.info("该用户是会员,Id:{},开始处理会员逻辑",user,getUserId());//会员逻辑
}else{log.info("该用户是非会员,Id:{},开始处理非会员逻辑",user,getUserId())//非会员逻辑
}

5.日志级别比较低时，进行日志开关判断

对于trace/debug这些比较低的日志级别，必须进行日志级别的开关判断。

正例：

User user = new User(666L, "公众号", "捡田螺的小男孩");
if (log.isDebugEnabled()) {log.debug("userId is: {}", user.getId());
}

因为当前有如下的日志代码：

logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);

如果配置的日志级别是warn的话，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象， 还会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印，因此建议加日志开关判断。

6. 不能直接使用日志系统（Log4j、Logback）中的 API，而是使用日志框架SLF4J中的API。

SLF4J 是门面模式的日志框架，有利于维护和各个类的日志处理方式统一，并且可以在保证不修改代码的情况下，很方便的实现底层日志框架的更换。

c2457ae3bcf1693d66864037443611e9.png

正例：

import org.slf4j.Logger; 
import org.slf4j.LoggerFactory;private static final Logger logger = LoggerFactory.getLogger(TianLuoBoy.class);

7. 建议使用参数占位{}，而不是用+拼接。

反例：

logger.info("Processing trade with id: " + id + " and symbol: " + symbol);

上面的例子中，使用+操作符进行字符串的拼接，有一定的性能损耗。

正例如下：

logger.info("Processing trade with id: {} and symbol : {} ", id, symbol);

我们使用了大括号{}来作为日志中的占位符，比于使用+操作符，更加优雅简洁。并且，相对于反例，使用占位符仅是替换动作，可以有效提升性能。

8. 建议使用异步的方式来输出日志。

  • 日志最终会输出到文件或者其它输出流中的，IO性能会有要求的。如果异步，就可以显著提升IO性能。

  • 除非有特殊要求，要不然建议使用异步的方式来输出日志。以logback为例吧，要配置异步很简单，使用AsyncAppender就行

<appender name="FILE_ASYNC" class="ch.qos.logback.classic.AsyncAppender"><appender-ref ref="ASYNC"/>
</appender>

9. 不要使用e.printStackTrace()

23f96ca3ef8c3abb20cfa50a8ec2e66b.png

反例：

try{// 业务代码处理
}catch(Exception e){e.printStackTrace();
}

正例：

try{// 业务代码处理
}catch(Exception e){log.error("你的程序有异常啦",e);
}

理由：

  • e.printStackTrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的，通常排查异常日志不太方便。

  • e.printStackTrace()语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了,即内存满了，那么，用户的请求就卡住啦~

10. 异常日志不要只打一半，要输出全部错误信息

d42066760310f71010ea25301baf82ba.png

反例1：

try {//业务代码处理
} catch (Exception e) {// 错误LOG.error('你的程序有异常啦');
}

  • 异常e都没有打印出来，所以压根不知道出了什么类型的异常。

反例2：

try {//业务代码处理
} catch (Exception e) {// 错误LOG.error('你的程序有异常啦', e.getMessage());
}

  • e.getMessage()不会记录详细的堆栈异常信息，只会记录错误基本描述信息，不利于排查问题。

正例：

try {//业务代码处理
} catch (Exception e) {// 错误LOG.error('你的程序有异常啦', e);
}

11. 禁止在线上环境开启 debug

禁止在线上环境开启debug，这一点非常重要。

b63d3f5bebc275bdaeccbf6211d9b59a.png

因为一般系统的debug日志会很多，并且各种框架中也大量使用 debug的日志，线上开启debug不久可能会打满磁盘，影响业务系统的正常运行。

12.不要记录了异常，又抛出异常

7f20798290e1ec096e555cd88525c3e2.png

反例如下：

log.error("IO exception", e);
throw new MyException(e);

  • 这样实现的话，通常会把栈信息打印两次。这是因为捕获了MyException异常的地方，还会再打印一次。

  • 这样的日志记录，或者包装后再抛出去，不要同时使用！否则你的日志看起来会让人很迷惑。

13.避免重复打印日志

避免重复打印日志，酱紫会浪费磁盘空间。如果你已经有一行日志清楚表达了意思，避免再冗余打印，反例如下：

if(user.isVip()){log.info("该用户是会员,Id:{}",user,getUserId());//冗余，可以跟前面的日志合并一起log.info("开始处理会员逻辑,id:{}",user,getUserId());//会员逻辑
}else{//非会员逻辑
}

如果你是使用log4j日志框架，务必在log4j.xml中设置 additivity=false，因为可以避免重复打印日志

正例：

<logger name="com.taobao.dubbo.config" additivity="false">

14.日志文件分离

1d881e7f91add20da55028c25948843c.png

  • 我们可以把不同类型的日志分离出去，比如access.log，或者error级别error.log，都可以单独打印到一个文件里面。

  • 当然，也可以根据不同的业务模块，打印到不同的日志文件里，这样我们排查问题和做数据统计的时候，都会比较方便啦。

15. 核心功能模块，建议打印较完整的日志

c181dac93a49f40c6c5069c9bfc3a4fe.png

  • 我们日常开发中，如果核心或者逻辑复杂的代码，建议添加详细的注释，以及较详细的日志。

  • 日志要多详细呢？脑洞一下，如果你的核心程序哪一步出错了，通过日志可以定位到，那就可以啦。

-- end--

a061148d8129ffb1e2090256ade4d82f.gif

往期推荐

de31000adef64e86a86b8b6f5e36de74.png

40 个 SpringBoot 常用注解：让生产力爆表！


b0e7b86bf4f99434592a14574f7ba0ff.png

聊聊Spring事务失效的12种场景，太坑了


8323b6f93f416ac565494bd81ea0a68a.png

SpringBoot 中 4 大核心组件，你了解多少？


本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/544570.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

MFC属性页对话框

MFC属性页对话框

属性页对话框 分类 分页和引导 类 CPropertyPage-父亲CDialog类别&#xff0c;所谓的属性页或网页对话框。 CPropertySheet-父类是CWnd&#xff0c;称为属性表单。 一个完整的属性页对话框由一个属性表单多个属性页组成。属性页嵌套在属性表单内。 标签式属性页的创建步骤&…
阅读更多...
vector cbegin_vector :: cbegin（）函数以及C ++ STL中的示例

vector cbegin_vector :: cbegin（）函数以及C ++ STL中的示例

vector cbeginC vector :: cbegin()函数 (C vector::cbegin() function) vector::cbegin() is a library function of "vector" header, it is used to get the const iterator pointing to the first element of the vector. vector :: cbegin()是“ vector”头文件…
阅读更多...
面试官：ConcurrentHashMap为什么放弃了分段锁？

面试官：ConcurrentHashMap为什么放弃了分段锁？

今天我们来讨论一下一个比较经典的面试题就是 ConcurrentHashMap 为什么放弃使用了分段锁&#xff0c;这个面试题阿粉相信很多人肯定觉得有点头疼&#xff0c;因为很少有人在开发中去研究这块的内容&#xff0c;今天阿粉就来给大家讲一下这个 ConcurrentHashMap 为什么在 JDK8 …
阅读更多...
C语言函数指针的应用——自制谐波分析软件

C语言函数指针的应用——自制谐波分析软件

文章目录函数指针简介格式介绍颜色头文件计算机仿真使用说明完整代码部分效果图函数指针简介 如果在一个大型C语言程序中要反复调用函数&#xff0c;而调用的函数又不明确时&#xff0c;函数指针就是一个非常有用的东西。如果你的函数体内可以传递不同的函数&#xff0c;那就非…
阅读更多...
PHP5.5四种序列化性能对比

PHP5.5四种序列化性能对比

2019独角兽企业重金招聘Python工程师标准>>> 结论&#xff1a; 1、小数组用msgpack,无论空间和性能都最好 2、大数组&#xff0c;考虑空间用igbinary,考虑性能用msgpack json_encode&#xff0c;serialize&#xff0c;igbinary&#xff0c;msgpack四种序列化方式&am…
阅读更多...
多线程循环输出abcc++_C ++循环| 查找输出程序| 套装2

多线程循环输出abcc++_C ++循环| 查找输出程序| 套装2

多线程循环输出abccProgram 1: 程序1&#xff1a; #include<iostream>using namespace std;int main(){ for(;;){cout<<"Hello ";}return 0;}Output: 输出&#xff1a; Hello Hello .... Infinite loopExplanation: 说明&#xff1a; In the above co…
阅读更多...
MyBatis Plus 批量数据插入功能，yyds！

MyBatis Plus 批量数据插入功能，yyds！

作者 | 王磊来源 | Java中文社群&#xff08;ID&#xff1a;javacn666&#xff09;转载请联系授权&#xff08;微信ID&#xff1a;GG_Stone最近 Review 小伙伴代码的时候&#xff0c;发现了一个小小的问题&#xff0c;小伙伴竟然在 for 循环中进行了 insert &#xff08;插入&a…
阅读更多...
C语言打印彩色字符——以（枚举法+字符串查找）为例展示

C语言打印彩色字符——以（枚举法+字符串查找）为例展示

文章目录C语言颜色头文件——自制非常简单的调用函数实战演练——一个基础的枚举变量小程序牛刀小试——查找字符小程序C语言颜色头文件——自制非常简单的调用函数 显然&#xff0c;C语言是不会提供打印彩色字符的标准函数&#xff0c;而我们有时候为了强调C语言打印的部分字…
阅读更多...
人工智能ai 学习_学习代理| 人工智能

人工智能ai 学习_学习代理| 人工智能

人工智能ai 学习Learning is an important part of human behavior. It is the first step in the development phase of any human. When the concept of Artificial Intelligence was proposed, the main approach of the developers was to build a system which could reac…
阅读更多...
sql server中同时执行select和update语句死锁问题

sql server中同时执行select和update语句死锁问题

原始出处 http://oecpby.blog.51cto.com/2203338/457054 最近在项目中使用SqlServer的时候发现在高并发情况下&#xff0c;频繁更新和频繁查询引发死锁。通常我们知道如果两个事务同时对一个表进行插入或修改数据&#xff0c;会发生在请求对表的X锁时&#xff0c;已经被对方持有…
阅读更多...
再见 Spring Task，这个定时任务框架真香！

再见 Spring Task，这个定时任务框架真香！

最近有朋友问到定时任务相关的问题。于是&#xff0c;我简单写了一篇文章总结一下定时任务的一些概念以及一些常见的定时任务技术选型。希望能对小伙伴们有帮助&#xff01;个人能力有限。如果文章有任何需要补充/完善/修改的地方&#xff0c;欢迎在评论区指出&#xff0c;共同…
阅读更多...
C语言实现动画控制

C语言实现动画控制

文章目录原材料说明一场革命原材料 下载原材料网址: https://www.easyx.cn/downloads/ 下载easyx2014冬至版&#xff0c;将lib文件放在编译器默认的lib文件夹&#xff0c;h头文件放在编译器默认的include文件夹即可 说明 C语言可以用系统内部的定时函数sleep和usleep定时(需…
阅读更多...
mcq 队列_MCQ | 8086微处理器中的寻址模式

mcq 队列_MCQ | 8086微处理器中的寻址模式

mcq 队列Question 1: 问题1&#xff1a; You are given the following instruction: ADD AX , [1024] You are provided the following data: DS 3423H ; SS 1234H ; CS 4567H Find the effective address location for the given instruction. 您得到以下指示&#xff1a;…
阅读更多...
聊聊redis分布式锁的8大坑

聊聊redis分布式锁的8大坑

前言在分布式系统中&#xff0c;由于redis分布式锁相对于更简单和高效&#xff0c;成为了分布式锁的首先&#xff0c;被我们用到了很多实际业务场景当中。但不是说用了redis分布式锁&#xff0c;就可以高枕无忧了&#xff0c;如果没有用好或者用对&#xff0c;也会引来一些意想…
阅读更多...
python 唯一元素_检查所有元素在Python中是否唯一

python 唯一元素_检查所有元素在Python中是否唯一

python 唯一元素Here, we are implementing a python program to check whether all elements of a list are unique or not? 在这里&#xff0c;我们正在实现一个python程序来检查列表的所有元素是否唯一&#xff1f; Its very simple to check, by following two steps 按…
阅读更多...
MyBatis 批量插入数据的 3 种方法！

MyBatis 批量插入数据的 3 种方法！

作者 | 王磊来源 | Java中文社群&#xff08;ID&#xff1a;javacn666&#xff09;转载请联系授权&#xff08;微信ID&#xff1a;GG_Stone批量插入功能是我们日常工作中比较常见的业务功能之一&#xff0c;之前我也写过一篇关于《MyBatis Plus 批量数据插入功能&#xff0c;yy…
阅读更多...
MongoDB: The Definitive Guide

MongoDB: The Definitive Guide

第一章 简介 MongoDB是面向文档的数据库&#xff0c;不是关系型数据库。内置对MapReduce的支持&#xff0c;以及对地理空间索引的支持。 丰富的数据模型容易扩展&#xff0c;它所采用的面向文档的数据模型可以使其在多台服务器之间分割数据丰富的功能&#xff0c;索引、存储Jav…
阅读更多...
Python联网下载文件

Python联网下载文件

声明 Python版本2.7.3所需Py文件——urllib22.7.3版本的Python Shell即可直接执行&#xff0c;但需要联网若程序执行成功&#xff0c;则会下载以下网址的txt文本并打印在shell中 http://helloworldbook2.com/data/message.txt 本代码来源于《父与子的编程之旅——与小卡特一起…
阅读更多...
java 生产者消费者代码_Java生产者和消费者代码

java 生产者消费者代码_Java生产者和消费者代码

java 生产者消费者代码This also helps us to understand the concept of synchronised multi-threading in java, the basic work of our code is that the producer will produce a thread and load it into the memory and after producing the producer thread we would be…
阅读更多...
如何给SpringBoot配置轻松加密？

如何给SpringBoot配置轻松加密？

在实践中&#xff0c;项目的某些配置信息是需要进行加密处理的&#xff0c;以减少敏感信息泄露的风险。比如&#xff0c;在使用Druid时&#xff0c;就可以基于它提供的公私钥加密方式对数据库的密码进行加密。但更多时候&#xff0c;比如Redis密码、MQ密码等敏感信息&#xff0…
阅读更多...
最新文章

Copyright @ 2022~2023