在Java代码中打日志需要注意什么?
云栖号资讯:【点击查看更多行业资讯】
在这里您可以找到不同行业的第一手的上云资讯,还在等什么,快来!
为什么要打日志?
日志是什么?日志是你在代码运行时打印出来的一些数据和记录,是快速排查问题的好帮手!
做一件事情之前,先思考为什么。为什么我们在开发中,需要打日志?原因很简单,没人能保证自己写的程序没有BUG,即使你做了足够的测试,也只是能降低产生BUG的概率而已。
尤其是当今分布式环境,定位问题变得越来越复杂。所以我们想要获取一些程序“运行时”的信息,日志就是最方便的。
所以,这种福泽后来人的好东西,当然要用起来了~
Java日志框架
要说Java日志框架啊,要从远古时代的JDK 1.3之前说起。那时候大家打印日志就是直接输出到STDOUT或者STDERR流。
System.out.println()
System.err.println()
e.printStackTrace()
于是log4j在大牛Ceki中应运而生,后面经过一系列的发展,以及Ceki与Apache的吃瓜事件,逐渐发展为slf4j、logback、log4j2三种最主流的日志框架。
- slf4j: 日志的“门面”框架,对于用户来说只要使用SLF4J提供的接口,即可隐藏日志的具体实现。
- logback: 与slf4j一样,为Ceki大神创建,所以原生实现slf4j,Spring Boot钦点的默认日志框架。
- log4j2: Apache顶级项目,性能优于logback,尤其是异步输出,表现比较好。
所以现在主流的框架一般是slf4j + logback或者slf4j + log4j2。
如何选择日志级别?
关于日志级别,不同的标准有不同的定义。鉴于slf4j差不多已经一统天下,所以我们主要介绍slf4j定义的5种日志级别。
5种日志级别
ERROR、WARN、INFO、DEBUG、TRACE这五个级别从高到低,「配置级别越高日志输出就越少」。
我们在配置输出某个级别的日志的时候,它也会输出比它高级别的日志。比如我们配置日志在INFO这一级别,它会输出ERROR、WARN、INFO三种级别的日志。
顾名思义,这几种级别的日志分别会输出不同程度信息:
- ERROR:错误日志,比较严重的错误,对正常业务有影响;
- WARN:警告日志,一般的错误,对业务影响不大;
- INFO:信息日志,记录一些日常的东西,比如调用时间、出参入参、业务信息等;
- DEBUG:用于DEBUG的,关键逻辑里面的运行时数据;
- TRACE:最详细的信息,一般这些信息只记录到日志文件中。
级别继承
有时候,我们可能根据不同的业务输出不同级别的日志。比如某些重要业务输出INFO级别,其他业务输出WARN级别的日志,同时关闭所有库、框架的日志,比如Spring等。
日志级别继承
一般情况,我们设置root级别了就行了,对于某些业务有特殊要求的话,对特定的包配置就行了。这里值得一提的是,谨慎开启低级别的日志,尤其是对root级别。之前听说过一个故障,就是为了Debug一个问题,在生产环境开启了DEBUG日志,并且是root级别,导致瞬间打印出巨量的日志,磁盘撑不住,造成了生产事故。
注意事项
开关判断
在阿里的Java开发手册中,有这么一条规约:
也就是说,在日志级别比较低的时候,应该在打日志前增加一个判断,「减少不必要的方法调用开销」。举个例子:
上面这段代码,我在打debug日志的时候,调用了user.getId()方法,这个时候,即使我们配置只打INFO级别的日志,运行到这段代码的时候,仍然会调用user.getId()方法,造成不必要的开销。
如果我们在前面添加一个判断就可以解决这个问题:
当然,这个根据自己的项目来。「如果你的项目部署肯定会开启INFO级别的日志,那INFO级别的日志,可以不加条件判断」。
使用参数占位
在上面的例子中,我们使用了大括号{}来作为日志中的占位符。相比于使用+操作符进行字符串的拼接,使用占位符可以让我们的代码更加优雅简洁。
除此以外,String字符串的拼接会使用StringBuilder的append()方式,有一定的性能损耗。使用占位符仅是替换动作,可以有效提升性能。
日志越多越好?
日志其实也是代码中的一部分。我们都知道,代码的可读性有多重要。其实并不需要每个地方都打上日志,这样我们在分析日志的时候也比较难快速定位关键信息。
我们要明白的一点是,「我们需要的不是日志,而是有效日志」。更何况,无效日志打多了,费磁盘~
只需要在我们关注的地方,打印关键的信息就可以了。比较常用的是我们通常能够快速定位数据的唯一id,比如gid等。
同步 vs 异步
我们知道,日志最终会输出到文件或者其它输出流,会重度使用IO。而异步可以显著提升IO性能,所以如果不是有特殊的需求,通常的建议使用异步的方式来输出日志。
以logback为例,要配置异步很简单,使用AsyncAppender就行:
trace Id
如今的系统做得越来越大,越来越复杂。前后端分离、分布式架构使得排查问题、追踪调用链路也变得越来越复杂。为了解决这个问题,我们可以使用一个trace Id来标识一次完整的调用链路。
目前主流的日志框架已经有这方面的支持了。拿logback为例,它提供了一种MDC机制,MDC为“Mapped Diagnostic Context”(映射诊断上下文),具体实现就是org.sl4j.MDC这个类。本文就不详细介绍如何使用它的了,感兴趣的同学可以去参考官方文档。
日志文件分离
我们打印日志是为了获取一些我们需要的信息。所以我们可以把不同类型的日志分离出去,比如access_log,或者ERROR级别的log,都可以单独打印到一个文件里。
也可以根据不同的业务模块,打印到不同的日志文件里,这样我们排查问题和做数据统计的时候就会比较方便。
获取日志实例
使用过日志框架的同学,对或多或少在类里定义过日志实例吧。但根据笔者的观察,大家定义日志的姿势各有千秋。有叫log的,有叫logger的,也有叫LOGGER的。定义的时候也都比较随意,比如不加static,不加final,获取实例的时候有传入this的,也有传入.class的。
这里不得不提一个优秀的Lombok注解:@Slf4j。它能够根据你的类自动注入一个log实例,非常方便快捷,如果你的项目使用了Lombok,不妨用起来。如果没有使用Lombok也没有关系,可以参考它的定义方式:
以上,大家就可以愉快地打日志啦~
【云栖号在线课堂】每天都有产品技术专家分享!
课程地址:https://yqh.aliyun.com/live立即加入社群,与专家面对面,及时了解课程最新动态!
【云栖号在线课堂 社群】https://c.tb.cn/F3.Z8gvnK
原文发布时间:2020-05-05
本文作者:编了个程
本文来自:“掘金”,了解相关信息可以关注“掘金”
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
玩转redis-延时消息队列
上一篇基于redis的list实现了一个简单的消息队列:玩转redis-简单消息队列 源码地址 使用demo 产品经理经常说的一句话,我们不光要有X功能,还要Y功能,这样客户才能更满意。同样的,只有简单消息队列是不够的,还要有延时消息队列才能算是一个完整的消息队列。 看看redis的命令,放眼望去,的有序集合(sorted set)就是一个很好用的命令,完全可以用他做一个延时消息队列 redis有序集合(sorted set) redis有序集合,每个元素都会关联一个double类型的分数。redis正是通过分数来为集合中的成员进行从小到大的排序。有序集合的成员是唯一的,但分数(score)却可以重复。 简单操作 添加数据 127.0.0.1:6379> ZADD testSet1 5 a (integer) 1 127.0.0.1:6379> ZADD testSet1 1 b 8 c 7 d (integer) 3 读取 127.0.0.1:6379> ZRANGEBYSCORE testSet1 0 3 1) "b" 127.0.0.1:6379> ZRA...
- 下一篇
90%的同学都没搞清楚的 Java 字符串常量池问题(图文并茂)
我是风筝,公众号「古时的风筝」,一个不只有技术的技术公众号,一个在程序圈混迹多年,主业 Java,另外 Python、React 也玩儿的 6 的斜杠开发者。 Spring Cloud 系列文章已经完成,可以到 我的 github 上查看系列完整内容。也可以在公众号内回复「pdf」获取我精心制作的 pdf 版完整教程。 字符串问题可谓是 Java 中经久不衰的问题,尤其是字符串常量池经常作为面试题出现。可即便是看似简单而又经常被提起的问题,还是有好多同学一知半解,看上去懂了,仔细分析起来却又发现不太明白。 背景说明 本文以 JDK 1.8 为讨论版本,虽然现在都已经 JDK 14了,奈何我们还是钟爱 1.8。 一个提问引起的讨论 为什么说到字符串常量呢,源于群里为数不多的一个程序员小姐姐的提问。 这本来和字符串常量没有关系,后来,一个同学说不只是 int ,换成 String 一样可以。 为什么会有"Java开发_北京"这么奇特的字符串乱入呢,因为提出问题的这位小姐姐的群昵称叫这个,所以群里的同学开玩笑说,以为她是某个房地产大佬,要来开发北京。 以上是开个玩笑,好了,收。 字符串用 =...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- Docker安装Oracle12C,快速搭建Oracle学习环境
- Windows10,CentOS7,CentOS8安装MongoDB4.0.16
- CentOS8编译安装MySQL8.0.19
- MySQL8.0.19开启GTID主从同步CentOS8
- CentOS8安装Docker,最新的服务器搭配容器使用
- CentOS8,CentOS7,CentOS6编译安装Redis5.0.7
- SpringBoot2整合Redis,开启缓存,提高访问速度
- CentOS7,8上快速安装Gitea,搭建Git服务器
- Docker使用Oracle官方镜像安装(12C,18C,19C)
- CentOS关闭SELinux安全模块