Java 程序如何正确的打日志


分享一份 2020 年最新面试题资料!

什么是日志

简单的说,日志就是记录程序的运行轨迹,方便查找关键信息,也方便快速定位解决问题。

我们Java程序员在开发项目时都是依赖 Eclipse/ Idea 等开发工具的 Debug 调试功能来跟踪解决 Bug,在开发环境可以这么做,但项目发布到了测试、生产环境呢?你有可能会说可以使用远程调试,但实际并不能允许让你这么做。

所以,日志的作用就是在测试、生产环境没有 Debug 调试工具时开发、测试人员定位问题的手段。日志打得好,就能根据日志的轨迹快速定位并解决线上问题,反之,日志输出不好不能定位到问题不说反而会影响系统的性能。

优秀的项目都是能根据日志定位问题的,而不是在线调试,或者半天找不到有用的日志而抓狂…

常用日志框架

log4j, Logging, commons-logging, slf4j, logback, 开发的同学对这几个日志相关的技术不陌生吧,为什么有这么多日志技术,它们都是什么区别和联系呢?相信大多数人搞不清楚它们的关系,下面我将一一介绍一下,以后大家再也不用傻傻分不清楚了。

  • Logging

如图所示,这是 Java 自带的日志工具类,在 JDK 1.5 开始就已经有了,在 java.util.logging 包下。

更多关于 Java Logging 的介绍可以看官方文档。

https://docs.oracle.com/javase/8/docs/technotes/guides/logging/overview.html

  • Log4j

Log4j 是 Apache 的一个开源日志框架,也是市场占有率最多的一个框架。大多数没用过 Java Logging, 但没人敢说没用过 Log4j 吧,反正从我接触 Java 开始就是这种情况,做 Java 项目必有 Log4j 日志框架。

注意:log4j 在 2015/08/05 这一天被 Apache 宣布停止维护了,用户需要切换到 Log4j2上面去。

下面是官方宣布原文:

On August 5, 2015 the Logging Services Project Management Committee announced that Log4j 1.x had reached end of life. For complete text of the announcement please see the Apache Blog. Users of Log4j 1 are recommended to upgrade to Apache Log4j 2.

Log4j2 的官方地址:

https://logging.apache.org/log4j/2.x/

  • commons-logging

上面介绍的 log4j 是一个具体的日志框架的实现,而 commons-logging 就是日志的门面接口,它也是 apache 最早提供的日志门面接口,用户可以根据喜好选择不同的日志实现框架,而不必改动日志定义,这就是日志门面的好处,符合面对接口抽象编程。

更多的详细说明可以参考官方说明:

http://commons.apache.org/proper/commons-logging/

  • Slf4j

全称:Simple Logging Facade for Java,即简单日志门面接口,和 Apache 的 commons-logging 是一样的概念,它们都不是具体的日志框架,你可以指定其他主流的日志实现框架。

Slf4j 的官方地址:

https://www.slf4j.org/

Slf4j 也是现在主流的日志门面框架,使用 Slf4j 可以很灵活的使用占位符进行参数占位,简化代码,拥有更好的可读性,这个后面会讲到。

  • Logback

Logback 是 Slf4j 的原生实现框架,同样也是出自 Log4j 一个人之手,但拥有比 log4j 更多的优点、特性和更做强的性能,现在基本都用来代替 log4j 成为主流。

Logback 的官方地址:

https://logback.qos.ch/

为什么 Logback 会成为主流?

无论从设计上还是实现上,Logback相对log4j而言有了相对多的改进。不过尽管难以一一细数,这里还是列举部分理由为什么选择logback而不是log4j。牢记logback与log4j在概念上面是很相似的,它们都是有同一群开发者建立。所以如果你已经对log4j很熟悉,你也可以很快上手logback。如果你喜欢使用log4j,你也许会迷上使用logback。

更快的执行速度

基于我们先前在log4j上的工作,logback 重写了内部的实现,在某些特定的场景上面,甚至可以比之前的速度快上10倍。在保证logback的组件更加快速的同时,同时所需的内存更加少。

更多请参考《从Log4j迁移到LogBack的理由 》:

http://www.oschina.net/translate/reasons-to-prefer-logbak-over-log4j

日志框架总结

1、commons-loggin, slf4j 只是一种日志抽象门面,不是具体的日志框架。

2、log4j, logback 是具体的日志实现框架。

3、一般首选强烈推荐使用 slf4j + logback。当然也可以使用slf4j + log4j, commons-logging + log4j 这两种日志组合框架。

从上图可以看出 slf4j 很强大吧,不但能和各种日志框架对接,还能和日志门面 commons-logging 进行融合。

日志级别详解

日志的输出都是分级别的,不同的设置不同的场合打印不同的日志。下面拿最普遍用的 Log4j 日志框架来做个日志级别的说明,这个也比较奇全,其他的日志框架也都大同小异。

Log4j 的级别类 org.apache.log4j.Level 里面定义了日志级别,日志输出优先级由高到底分别为以下8种。

日志级别 描述
OFF 关闭:最高级别,不输出日志。
FATAL 致命:输出非常严重的可能会导致应用程序终止的错误。
ERROR 错误:输出错误,但应用还能继续运行。
WARN 警告:输出可能潜在的危险状况。
INFO 信息:输出应用运行过程的详细信息。
DEBUG 调试:输出更细致的对调试应用有用的信息。
TRACE 跟踪:输出更细致的程序运行轨迹。
ALL 所有:输出所有级别信息。

所以,日志优先级别标准顺序为:

ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF

如果日志设置为 L ,一个级别为 P 的输出日志只有当 P >= L 时日志才会输出。

即如果日志级别L设置INFO,只有P的输出级别为INFO、WARN,后面的日志才会正常输出。

具体的输出关系可以参考下图:

image

知道了日志级别,这还只是基础,如何了解打日志的规范,以及如何正确地打日志姿势呢?!

image

打日志的规范准则

最开始也说过了,日志不能乱打,不然起不到日志本应该起到的作用不说,还会造成系统的负担。在BAT、华为一些大公司都是对日志规范有要求的,什么时候该打什么日志都是有规范的。

阿里去年发布的《Java开发手册》,里面有一章节就是关于日志规范的,让我们再来回顾下都有什么内容。

下面是阿里的《Java开发手册》终极版日志规约篇。

规范有很多,这里就不再一一详述了,完整终极版可以在微信公众号 “Java技术栈” 中回复 “手册” 获取。这里只想告诉大家,在大公司打日志都是有严格规范的,不是你随便打就行的。

阿里是一线互联网公司,所制定的日志规范也都符合我们的要求,很有参考意义,能把阿里这套日志规约普及也真很不错了。

项目中该如何正确的打日志?

本文是 GitChat 付费文章,继续阅读请点击顶部菜单加入知识星球。

分享一份 2020 年架构师学习资料!