开发 Java 应用时如何用好 Log

▐  日志系统与日志框架

每个应用为了方便排查问题都要输出日志，大家经常使用：log4j、logback 等。我们先搞明白日志系统的整套体系是如何运作的。

• 日志系统

        直接负责打印输出日志，提供完整的日志输出能力：

1. JUL

   • java.util.logging.*，java 自带的日志系统简称 JUL。目前除了 Java 自身代码很少被生态系统类库使用。

2. Log4j

   • https://logging.apache.org/ ，目前已经发展到 2.x 版本（2.x 版本有超越 logback 的趋势），早期的 1.x 版本非常成功。开创日志系统模型（Logger\Appender\Level 等概念）并被各种日志框架采用，且一直沿用至今

   • log4j 可直接使用，也可配合日志框架一起使用

3. Logback

• • http://logback.qos.ch/ ，Log4j 作者的另一个作品，（比 Log4j1.x 新，Log4j2.x 旧）吸取多年经验教训重新设计的一套日志系统，使用更方便、功能更强、性能更好。

  • logback 不能单独使用，需配置日志框架 SLF4J 一起使用

• 日志框架

为了克服各种日志系统标准混乱，诞生了日志框架，日志框架不提供日志输出的功能，它定义标准，提供标准接口 API，日志框架 + 日志系统 = 输出日志。

写代码过程中使用日志框架的好处：编码的时候调用日志框架 API，部署的时候可根据不同的环境在多种日志系统中随意切换。

1. JCL

   • https://commons.apache.org/proper/commons-logging/ ，前几年最流行的日志框架，由 Apache 社区维护，大量的老牌知名框架版本都在使用，比如 Spring（甚至新版本依然在使用）。

2. SLF4J

• • https://www.slf4j.org/ ，Log4j 作者推出，这几年最流行的日志框架，特别是配合 Logback 使用。

  • 当然也可以配合 log4j 使用

目前在 Java 生态趋势主要是使用：SLF4J+Logback 组合。

▐  如何正确组合使用日志系统和日志框架

上一节我们介绍了日志框架和日志系统，因为存在多套，所以：如何在系统中正确使用是我们的重点。

• 日志系统之间互斥

1. 日志框架：JCL 和 JCL-over-SLF4J 桥接包直接互斥

2. 日志系统：logback 和 slf4j-log4j12 互斥，不能共存

我们大概可枚举出如下几种组合：

类型	说明
slf4j+logback	目前最主流的玩法，除了依赖 slf4j、logback，还需要考虑把二方库和三方库内部使用的 jcl 和 log4j 桥接到 slf4j 上来，并避免依赖反桥接的包
slf4j+log4j	不推荐。需要把 slf4j 桥接到 log4j，并把 jul 桥接到 slf4j
jcl+log4j	不推荐。这需要你直接使用 jcl 接口来编码，并把把 slf4j 桥接到 log4j
log4j	不推荐。直接依赖日志系统

• slf4j+logback 组合

下面列出一个正确的 slf4j+logback 依赖，这个环节很重要，很多应用因为依赖搞不清楚经常出现日志丢失问题：

  ${xxxx}  ${yyyyy}

            commons-logging      commons-logging      999-not-exist              com.alibaba.external      jakarta.commons.logging      999-not-exist              org.slf4j      slf4j-log4j12      999-not-exist                com.alibaba.external        org.slf4j.slf4j-log4j12        999-not-exist              org.slf4j      slf4j-nop      999-not-exist              org.slf4j      slf4j-simple      999-not-exist                com.alibaba.external        org.slf4j.slf4j-simple        999-not-exist              log4j      log4j      999-not-exist              org.slf4j      slf4j-api      ${slf4j.version}              org.slf4j      slf4j-ext      ${slf4j.version}              org.slf4j      jcl-over-slf4j      ${slf4j.version}              org.slf4j      jul-to-slf4j      ${slf4j.version}              org.slf4j      log4j-over-slf4j      ${slf4j.version}              ch.qos.logback      logback-core      ${logback.version}              ch.qos.logback      logback-classic      ${logback.version}      


      org.slf4j    slf4j-api        org.slf4j    slf4j-ext        org.slf4j    jcl-over-slf4j        org.slf4j    jul-to-slf4j        org.slf4j    log4j-over-slf4j        ch.qos.logback    logback-core        ch.qos.logback    logback-classic  

1. 先将依赖全部写在 节点中，这样可影响间接依赖，如果只当初的使用 dependencies 节点，只会应用直接依赖

2. 使用 999-not-exist 这样的版本：欺骗 maven，直接依赖一个空包占位，这样 Maven 就不会再去依赖相同坐标的真实依赖，间接起到排包的作用

▐  logback 配置

• 文件名和位置

应用类型	文件名	文件配置（启动模块）	说明
spring-boot	logback-spring.xml	src/main/resources/	支持从 spring-boot 配置文件中直接读取 property
普通 java 应用	logback.xml	src/main/resources/
WAR 应用	logback.xml	src/main/webapp/WEB-INF/	需要依赖 slf4j-ext，然后在 web.xml 里使用监听器挂载这个文件
单元测试和集成测试	logback-test.xml	src/test/resources/

• 配置样例

          
      class="ch.qos.logback.core.rolling.RollingFileAppender">    ${LOG_FILE}          ${LOG.PATTERN}      ${LOG.CHARSET}              ${LOG_FILE}.%d{yyyy-MM-dd}.%i.log      7      50MB      20GB      
            
            
            
            
            
            
            
            
        

1. 使用 SizeAndTimeBasedRollingPolicy 使日志可以根据大小和日期进行滚动

2. 日志编码请使用 UTF-8

3. 请正确使用日志级别，不要统统输出 error

• 日志级别根据不同环境可配

1. 如果是 Pandora-boot 或 spring-boot 可以直接在配置里使用 property 读取 application.properties，application.properties 在不同环境下使用 - Dspring.profiles.active 进行切换

2. 普通应用和 WAR 应用：请使用 autoconfig-maven-plugin 插件

一些实用的日志技巧

▐  动态修改日志级别

场景：应用在运行中，默认日志配置的打印级别是 error，但是我现在想针对某个包或者某个类输出下 info 日志。

使用 Arthas：https://arthas.aliyun.com/doc/logger.html，该工具提供了动态修改日志的能力。

▐  追加业务信息到日志中，并格式化输出：追加 MDC 信息，方便排查问题

这是日志系统的一个扩容能力，可以把一些额外的信息输出到日志里，只需要在 MDC 上下文中写入 kv，https://logback.qos.ch/manual/mdc.html

例如：

public static void main(String[] args) {    //代码里使用MDC.put写入key为traceId的值    //在logback.xml里就可以使用%X{traceId}进行输出    MDC.put("traceId", UUID.randomUUID().toString().replace("-", ""));}

▐  配置定时日志磁盘占用清理

一定要配置合理的日志清理策略，避免磁盘被打爆，可借助日志框架自身能力，或借助可用的日志清理系统（如果有）

在 logback.xml 配置中，可通过配置带有清理作用的 rollingPolicy 来完成日志定时清理和滚动，例如：SizeAndTimeBasedRollingPolicy

这段配置的含义是：最多保留 7 天，单个文件最大 50MB，该日志（包括滚动的）最大只能保存 20GB。

▐  不要封装一个日志 Util，而应该直接使用日志框架进行输出

反例：LogUtil.log ("通过封装的日志工具打印日志");

正例：log.info ("直接使用日志框架的 api 进行日志输出");

理由：在日志输出的时候，日志系统会打印日志产生的原始位置：比如哪个包的哪个类，以及第几行（如果配置了 [% L]），如果你使用 LogUtil 等自己封装的工具，所有的日志输出打印的位置都是 LogUtil 的，这样不便于做日志问题定位

系统日志打不出来或者丢日志排查思路

目前没有现成的工具帮你一键做好这个事情，下面给出一个排查思路

1. 先明确该系统到底使用的是什么日志框架 + 日志系统组合，这个很重要，必须搞清是何种组合才可有针对性的处理后续步骤

2. 如果是 slf4j+logback 组合，则可根据第一章列出的 maven 依赖进行排包处理，优先保证依赖的包没有错误，90% 的情况下都是包依赖混乱导致的日志丢失

3. 排查自己的 logback 配置文件是否放在正确的路径下、文件名是否正确，配置文件位置不对也会导致日志输出的不对甚至丢失

4. 检查 logback 配置文件内部每个 logger 及其 level 配置是否正确，避免自己期望打印 info，却配置了 error

总结

日志系统的正确使用，对于应用的日常维护和问题排查尤为重要，所谓：工欲善其事，必先利其器。本篇文章重点讲解了日志系统的结构和包如何正确依赖，这是很多同学最容易犯的错误，需要格外注意并认真阅读，只有正确理解其中的含义才可以更好的使用日志系统，在日常使用中大家要不断总结经验。