最強最全常用開發庫 - 日志類庫詳解

本文轉載自查看原文 2020-01-14 08:45 1440 知識結構

Java日志庫是最能體現Java庫在進化中的淵源關系的，在理解時重點理解日志框架本身和日志門面，以及比較好的實踐等。要關注其歷史淵源和設計（比如橋接），而具體在使用時查詢接口即可，否則會陷入JUL(Java Util Log), JCL(Commons Logging), Log4j, SLF4J, Logback，Log4j2傻傻分不清楚的境地。@pdai

日志庫簡介

我認為全面理解日志庫需要從下面三個角度去理解：@pdai

最重要的一點是區分日志系統和日志門面;
其次是日志庫的使用, 包含配置與API使用；配置側重於日志系統的配置，API使用側重於日志門面；
最后是選型，改造和最佳實踐等

日志庫之日志系統

java.util.logging (JUL)

JDK1.4 開始，通過 java.util.logging 提供日志功能。雖然是官方自帶的log lib，JUL的使用確不廣泛。主要原因:

JUL從JDK1.4 才開始加入(2002年)，當時各種第三方log lib已經被廣泛使用了
JUL早期存在性能問題，到JDK1.5上才有了不錯的進步，但現在和Logback/Log4j2相比還是有所不如
JUL的功能不如Logback/Log4j2等完善，比如Output Handler就沒有Logback/Log4j2的豐富，有時候需要自己來繼承定制，又比如默認沒有從ClassPath里加載配置文件的功能

Log4j

Log4j 是 apache 的一個開源項目，創始人 Ceki Gulcu。Log4j 應該說是 Java 領域資格最老，應用最廣的日志工具。Log4j 是高度可配置的，並可通過在運行時的外部文件配置。它根據記錄的優先級別，並提供機制，以指示記錄信息到許多的目的地，諸如：數據庫，文件，控制台，UNIX 系統日志等。

Log4j 中有三個主要組成部分：

loggers - 負責捕獲記錄信息。
appenders - 負責發布日志信息，以不同的首選目的地。
layouts - 負責格式化不同風格的日志信息。

官網地址：http://logging.apache.org/log4j/2.x/

Log4j 的短板在於性能，在Logback 和 Log4j2 出來之后，Log4j的使用也減少了。

Logback

Logback 是由 log4j 創始人 Ceki Gulcu 設計的又一個開源日記組件，是作為 Log4j 的繼承者來開發的，提供了性能更好的實現，異步 logger，Filter等更多的特性。

logback 當前分成三個模塊：logback-core、logback-classic 和 logback-access。

logback-core - 是其它兩個模塊的基礎模塊。
logback-classic - 是 log4j 的一個改良版本。此外 logback-classic 完整實現 SLF4J API 使你可以很方便地更換成其它日記系統如 log4j 或 JDK14 Logging。
logback-access - 訪問模塊與 Servlet 容器集成提供通過 Http 來訪問日記的功能。

官網地址: http://logback.qos.ch/

Log4j2

維護 Log4j 的人為了性能又搞出了 Log4j2。

Log4j2 和 Log4j1.x 並不兼容，設計上很大程度上模仿了 SLF4J/Logback，性能上也獲得了很大的提升。

Log4j2 也做了 Facade/Implementation 分離的設計，分成了 log4j-api 和 log4j-core。

官網地址: http://logging.apache.org/log4j/2.x/

Log4j vs Logback vs Log4j2

從性能上Log4J2要強，但從生態上Logback+SLF4J優先。@pdai

初步對比

logback和log4j2都宣稱自己是log4j的后代，一個是出於同一個作者，另一個則是在名字上根正苗紅。

撇開血統不談，比較一下log4j2和logback：

log4j2比logback更新：log4j2的GA版在2014年底才推出，比logback晚了好幾年，這期間log4j2確實吸收了slf4j和logback的一些優點（比如日志模板），同時應用了不少的新技術
由於采用了更先進的鎖機制和LMAX Disruptor庫，log4j2的性能優於logback，特別是在多線程環境下和使用異步日志的環境下
二者都支持Filter（應該說是log4j2借鑒了logback的Filter），能夠實現靈活的日志記錄規則（例如僅對一部分用戶記錄debug級別的日志）
二者都支持對配置文件的動態更新
二者都能夠適配slf4j，logback與slf4j的適配應該會更好一些，畢竟省掉了一層適配庫
logback能夠自動壓縮/刪除舊日志
logback提供了對日志的HTTP訪問功能
log4j2實現了“無垃圾”和“低垃圾”模式。簡單地說，log4j2在記錄日志時，能夠重用對象（如String等），盡可能避免實例化新的臨時對象，減少因日志記錄產生的垃圾對象，減少垃圾回收帶來的性能下降
log4j2和logback各有長處，總體來說，如果對性能要求比較高的話，log4j2相對還是較優的選擇。

性能對比

附上log4j2與logback性能對比的benchmark，這份benchmark是Apache Logging出的，有多大水分不知道，僅供參考

同步寫文件日志的benchmark：

異步寫日志的benchmark：

當然，這些benchmark都是在日志Pattern中不包含Location信息（如日志代碼行號，調用者信息，Class名/源碼文件名等）時測定的，如果輸出Location信息的話，性能誰也拯救不了：

日志庫之日志門面

common-logging

common-logging 是 apache 的一個開源項目。也稱Jakarta Commons Logging，縮寫 JCL。

common-logging 的功能是提供日志功能的 API 接口，本身並不提供日志的具體實現（當然，common-logging 內部有一個 Simple logger 的簡單實現，但是功能很弱，直接忽略），而是在運行時動態的綁定日志實現組件來工作（如 log4j、java.util.loggin）。

官網地址: http://commons.apache.org/proper/commons-logging/

slf4j

全稱為 Simple Logging Facade for Java，即 java 簡單日志門面。

什么，作者又是 Ceki Gulcu！這位大神寫了 Log4j、Logback 和 slf4j，專注日志組件開發五百年，一直只能超越自己。

類似於 Common-Logging，slf4j 是對不同日志框架提供的一個 API 封裝，可以在部署的時候不修改任何配置即可接入一種日志實現方案。但是，slf4j 在編譯時靜態綁定真正的 Log 庫。使用 SLF4J 時，如果你需要使用某一種日志實現，那么你必須選擇正確的 SLF4J 的 jar 包的集合（各種橋接包）。

官網地址: http://www.slf4j.org/

common-logging vs slf4j

slf4j 庫類似於 Apache Common-Logging。但是，他在編譯時靜態綁定真正的日志庫。這點似乎很麻煩，其實也不過是導入橋接 jar 包而已。

slf4j 一大亮點是提供了更方便的日志記錄方式：

不需要使用logger.isDebugEnabled()來解決日志因為字符拼接產生的性能問題。slf4j 的方式是使用{}作為字符串替換符，形式如下：

logger.debug("id: {}, name: {} ", id, name);

日志庫使用方案

使用日志解決方案基本可分為三步：

引入 jar 包
配置
使用 API

常見的各種日志解決方案的第 2 步和第 3 步基本一樣，實施上的差別主要在第 1 步，也就是使用不同的庫。

日志庫jar包

這里首選推薦使用 slf4j + logback 的組合。

如果你習慣了 common-logging，可以選擇 common-logging+log4j。

強烈建議不要直接使用日志實現組件(logback、log4j、java.util.logging)，理由前面也說過，就是無法靈活替換日志庫。

還有一種情況：你的老項目使用了 common-logging，或是直接使用日志實現組件。如果修改老的代碼，工作量太大，需要兼容處理。在下文，都將看到各種應對方法。

注：據我所知，當前仍沒有方法可以將 slf4j 橋接到 common-logging。如果我孤陋寡聞了，請不吝賜教。

slf4j 直接綁定日志組件

slf4j + logback

添加依賴到 pom.xml 中即可。

logback-classic-1.0.13.jar 會自動將 slf4j-api-1.7.21.jar 和 logback-core-1.0.13.jar 也添加到你的項目中。

<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.0.13</version>
</dependency>

slf4j + log4j

添加依賴到 pom.xml 中即可。

slf4j-log4j12-1.7.21.jar 會自動將 slf4j-api-1.7.21.jar 和 log4j-1.2.17.jar 也添加到你的項目中。

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
  <version>1.7.21</version>
</dependency>

slf4j + java.util.logging

添加依賴到 pom.xml 中即可。

slf4j-jdk14-1.7.21.jar 會自動將 slf4j-api-1.7.21.jar 也添加到你的項目中。

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-jdk14</artifactId>
  <version>1.7.21</version>
</dependency>

slf4j 兼容非 slf4j 日志組件

在介紹解決方案前，先提一個概念——橋接

什么是橋接呢

假如你正在開發應用程序所調用的組件當中已經使用了 common-logging，這時你需要 jcl-over-slf4j.jar 把日志信息輸出重定向到 slf4j-api，slf4j-api 再去調用 slf4j 實際依賴的日志組件。這個過程稱為橋接。下圖是官方的 slf4j 橋接策略圖：

從圖中應該可以看出，無論你的老項目中使用的是 common-logging 或是直接使用 log4j、java.util.logging，都可以使用對應的橋接 jar 包來解決兼容問題。

slf4j 兼容 common-logging

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>jcl-over-slf4j</artifactId>
  <version>1.7.12</version>
</dependency>

slf4j 兼容 log4j

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
    <version>1.7.12</version>
</dependency>

slf4j 兼容 java.util.logging

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jul-to-slf4j</artifactId>
    <version>1.7.12</version>
</dependency>

spring 集成 slf4j

做 java web 開發，基本離不開 spring 框架。很遺憾，spring 使用的日志解決方案是 common-logging + log4j。

所以，你需要一個橋接 jar 包：logback-ext-spring。

<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.1.3</version>
</dependency>
<dependency>
  <groupId>org.logback-extensions</groupId>
  <artifactId>logback-ext-spring</artifactId>
  <version>0.1.2</version>
</dependency>
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>jcl-over-slf4j</artifactId>
  <version>1.7.12</version>
</dependency>

common-logging 綁定日志組件

common-logging + log4j

添加依賴到 pom.xml 中即可。

<dependency>
  <groupId>commons-logging</groupId>
  <artifactId>commons-logging</artifactId>
  <version>1.2</version>
</dependency>
<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>1.2.17</version>
</dependency>

日志庫配置 - 針對於日志框架

log4j2 配置

log4j2 基本配置形式如下：

<?xml version="1.0" encoding="UTF-8"?>;
<Configuration>
  <Properties>
    <Property name="name1">value</property>
    <Property name="name2" value="value2"/>
  </Properties>
  <Filter type="type" ... />
  <Appenders>
    <Appender type="type" name="name">
      <Filter type="type" ... />
    </Appender>
    ...
  </Appenders>
  <Loggers>
    <Logger name="name1">
      <Filter type="type" ... />
    </Logger>
    ...
    <Root level="level">
      <AppenderRef ref="name"/>
    </Root>
  </Loggers>
</Configuration>

配置示例：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="debug" strict="true" name="XMLConfigTest"
               packages="org.apache.logging.log4j.test">
  <Properties>
    <Property name="filename">target/test.log</Property>
  </Properties>
  <Filter type="ThresholdFilter" level="trace"/>
 
  <Appenders>
    <Appender type="Console" name="STDOUT">
      <Layout type="PatternLayout" pattern="%m MDC%X%n"/>
      <Filters>
        <Filter type="MarkerFilter" marker="FLOW" onMatch="DENY" onMismatch="NEUTRAL"/>
        <Filter type="MarkerFilter" marker="EXCEPTION" onMatch="DENY" onMismatch="ACCEPT"/>
      </Filters>
    </Appender>
    <Appender type="Console" name="FLOW">
      <Layout type="PatternLayout" pattern="%C{1}.%M %m %ex%n"/><!-- class and line number -->
      <Filters>
        <Filter type="MarkerFilter" marker="FLOW" onMatch="ACCEPT" onMismatch="NEUTRAL"/>
        <Filter type="MarkerFilter" marker="EXCEPTION" onMatch="ACCEPT" onMismatch="DENY"/>
      </Filters>
    </Appender>
    <Appender type="File" name="File" fileName="${filename}">
      <Layout type="PatternLayout">
        <Pattern>%d %p %C{1.} [%t] %m%n</Pattern>
      </Layout>
    </Appender>
  </Appenders>
 
  <Loggers>
    <Logger name="org.apache.logging.log4j.test1" level="debug" additivity="false">
      <Filter type="ThreadContextMapFilter">
        <KeyValuePair key="test" value="123"/>
      </Filter>
      <AppenderRef ref="STDOUT"/>
    </Logger>
 
    <Logger name="org.apache.logging.log4j.test2" level="debug" additivity="false">
      <AppenderRef ref="File"/>
    </Logger>
 
    <Root level="trace">
      <AppenderRef ref="STDOUT"/>
    </Root>
  </Loggers>
 
</Configuration>

logback 配置

<?xml version="1.0" encoding="UTF-8" ?>
 
<!-- logback中一共有5種有效級別，分別是TRACE、DEBUG、INFO、WARN、ERROR，優先級依次從低到高 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
 
  <property name="DIR_NAME" value="spring-helloworld"/>
 
  <!-- 將記錄日志打印到控制台 -->
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
    </encoder>
  </appender>
 
  <!-- RollingFileAppender begin -->
  <appender name="ALL" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 根據時間來制定滾動策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${user.dir}/logs/${DIR_NAME}/all.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
 
    <!-- 根據文件大小來制定滾動策略 -->
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>30MB</maxFileSize>
    </triggeringPolicy>
 
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
    </encoder>
  </appender>
 
  <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 根據時間來制定滾動策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${user.dir}/logs/${DIR_NAME}/error.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
 
    <!-- 根據文件大小來制定滾動策略 -->
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>10MB</maxFileSize>
    </triggeringPolicy>
 
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>ERROR</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
 
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
    </encoder>
  </appender>
 
  <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 根據時間來制定滾動策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${user.dir}/logs/${DIR_NAME}/warn.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
 
    <!-- 根據文件大小來制定滾動策略 -->
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>10MB</maxFileSize>
    </triggeringPolicy>
 
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>WARN</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
 
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
    </encoder>
  </appender>
 
  <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 根據時間來制定滾動策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${user.dir}/logs/${DIR_NAME}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
 
    <!-- 根據文件大小來制定滾動策略 -->
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>10MB</maxFileSize>
    </triggeringPolicy>
 
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>INFO</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
 
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
    </encoder>
  </appender>
 
  <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 根據時間來制定滾動策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${user.dir}/logs/${DIR_NAME}/debug.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
 
    <!-- 根據文件大小來制定滾動策略 -->
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>10MB</maxFileSize>
    </triggeringPolicy>
 
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>DEBUG</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
 
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
    </encoder>
  </appender>
 
  <appender name="TRACE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 根據時間來制定滾動策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${user.dir}/logs/${DIR_NAME}/trace.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
 
    <!-- 根據文件大小來制定滾動策略 -->
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>10MB</maxFileSize>
    </triggeringPolicy>
 
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>TRACE</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
 
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
    </encoder>
  </appender>
 
  <appender name="SPRING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 根據時間來制定滾動策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${user.dir}/logs/${DIR_NAME}/springframework.%d{yyyy-MM-dd}.log
      </fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
 
    <!-- 根據文件大小來制定滾動策略 -->
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>10MB</maxFileSize>
    </triggeringPolicy>
 
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] [%-5p] %c{36}.%M - %m%n</pattern>
    </encoder>
  </appender>
  <!-- RollingFileAppender end -->
 
  <!-- logger begin -->
  <!-- 本項目的日志記錄，分級打印 -->
  <logger name="org.zp.notes.spring" level="TRACE" additivity="false">
    <appender-ref ref="STDOUT"/>
    <appender-ref ref="ERROR"/>
    <appender-ref ref="WARN"/>
    <appender-ref ref="INFO"/>
    <appender-ref ref="DEBUG"/>
    <appender-ref ref="TRACE"/>
  </logger>
 
  <!-- SPRING框架日志 -->
  <logger name="org.springframework" level="WARN" additivity="false">
    <appender-ref ref="SPRING"/>
  </logger>
 
  <root level="TRACE">
    <appender-ref ref="ALL"/>
  </root>
  <!-- logger end -->
 
</configuration>

log4j 配置

完整的 log4j.xml 參考示例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
 
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>
 
  <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern"
             value="%d{yyyy-MM-dd HH:mm:ss,SSS\} [%-5p] [%t] %c{36\}.%M - %m%n"/>
    </layout>
 
    <!--過濾器設置輸出的級別-->
    <filter class="org.apache.log4j.varia.LevelRangeFilter">
      <param name="levelMin" value="debug"/>
      <param name="levelMax" value="fatal"/>
      <param name="AcceptOnMatch" value="true"/>
    </filter>
  </appender>
 
 
  <appender name="ALL" class="org.apache.log4j.DailyRollingFileAppender">
    <param name="File" value="${user.dir}/logs/spring-common/jcl/all"/>
    <param name="Append" value="true"/>
    <!-- 每天重新生成日志文件 -->
    <param name="DatePattern" value="'-'yyyy-MM-dd'.log'"/>
    <!-- 每小時重新生成日志文件 -->
    <!--<param name="DatePattern" value="'-'yyyy-MM-dd-HH'.log'"/>-->
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern"
             value="%d{yyyy-MM-dd HH:mm:ss,SSS\} [%-5p] [%t] %c{36\}.%M - %m%n"/>
    </layout>
  </appender>
 
  <!-- 指定logger的設置，additivity指示是否遵循缺省的繼承機制-->
  <logger name="org.zp.notes.spring" additivity="false">
    <level value="error"/>
    <appender-ref ref="STDOUT"/>
    <appender-ref ref="ALL"/>
  </logger>
 
  <!-- 根logger的設置-->
  <root>
    <level value="warn"/>
    <appender-ref ref="STDOUT"/>
  </root>
</log4j:configuration>

日志庫API - 針對於日志門面

slf4j 用法

使用 slf4j 的 API 很簡單。使用LoggerFactory初始化一個Logger實例，然后調用 Logger 對應的打印等級函數就行了。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
public class App {
    private static final Logger log = LoggerFactory.getLogger(App.class);
    public static void main(String[] args) {
        String msg = "print log, current level: {}";
        log.trace(msg, "trace");
        log.debug(msg, "debug");
        log.info(msg, "info");
        log.warn(msg, "warn");
        log.error(msg, "error");
    }
}

common-logging 用法

common-logging 用法和 slf4j 幾乎一樣，但是支持的打印等級多了一個更高級別的：fatal。

此外，common-logging 不支持{}替換參數，你只能選擇拼接字符串這種方式了。

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
 
public class JclTest {
    private static final Log log = LogFactory.getLog(JclTest.class);
 
    public static void main(String[] args) {
        String msg = "print log, current level: ";
        log.trace(msg + "trace");
        log.debug(msg + "debug");
        log.info(msg + "info");
        log.warn(msg + "warn");
        log.error(msg + "error");
        log.fatal(msg + "fatal");
    }
}

日志庫選型與改造

對Java日志組件選型的建議

slf4j已經成為了Java日志組件的明星選手，可以完美替代JCL，使用JCL橋接庫也能完美兼容一切使用JCL作為日志門面的類庫，現在的新系統已經沒有不使用slf4j作為日志API的理由了
日志記錄服務方面，log4j在功能上輸於logback和log4j2，在性能方面log4j2則全面超越log4j和logback。所以新系統應該在logback和log4j2中做出選擇，對於性能有很高要求的系統，應優先考慮log4j2

對日志架構使用比較好的實踐

總是使用Log Facade，而不是具體Log Implementation

正如之前所說的，使用 Log Facade 可以方便的切換具體的日志實現。而且，如果依賴多個項目，使用了不同的Log Facade，還可以方便的通過 Adapter 轉接到同一個實現上。如果依賴項目使用了多個不同的日志實現，就麻煩的多了。

具體來說，現在推薦使用 Log4j-API 或者 SLF4j，不推薦繼續使用 JCL。

只添加一個 Log Implementation依賴

毫無疑問，項目中應該只使用一個具體的 Log Implementation，建議使用 Logback 或者Log4j2。如果有依賴的項目中，使用的 Log Facade不支持直接使用當前的 Log Implementation，就添加合適的橋接器依賴。具體的橋接關系可以看上一篇文章的圖。

具體的日志實現依賴應該設置為optional和使用runtime scope

在項目中，Log Implementation的依賴強烈建議設置為runtime scope，並且設置為optional。例如項目中使用了 SLF4J 作為 Log Facade，然后想使用 Log4j2 作為 Implementation，那么使用 maven 添加依賴的時候這樣設置:

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>${log4j.version}</version>
    <scope>runtime</scope>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>${log4j.version}</version>
    <scope>runtime</scope>
    <optional>true</optional>
</dependency>

設為optional，依賴不會傳遞，這樣如果你是個lib項目，然后別的項目使用了你這個lib，不會被引入不想要的Log Implementation 依賴；

Scope設置為runtime，是為了防止開發人員在項目中直接使用Log Implementation中的類，而不適用Log Facade中的類。

如果有必要, 排除依賴的第三方庫中的Log Impementation依賴

這是很常見的一個問題，第三方庫的開發者未必會把具體的日志實現或者橋接器的依賴設置為optional，然后你的項目繼承了這些依賴——具體的日志實現未必是你想使用的，比如他依賴了Log4j，你想使用Logback，這時就很尷尬。另外，如果不同的第三方依賴使用了不同的橋接器和Log實現，也極容易形成環。

這種情況下，推薦的處理方法，是使用exclude來排除所有的這些Log實現和橋接器的依賴，只保留第三方庫里面對Log Facade的依賴。

比如阿里的JStorm就沒有很好的處理這個問題，依賴jstorm會引入對Logback和log4j-over-slf4j的依賴，如果你想在自己的項目中使用Log4j或其他Log實現的話，就需要加上excludes:

<dependency>
    <groupId>com.alibaba.jstorm</groupId>
    <artifactId>jstorm-core</artifactId>
    <version>2.1.1</version>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>log4j-over-slf4j</artifactId>
        </exclusion>
        <exclusion>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
        </exclusion>
    </exclusions>
</dependency>

避免為不會輸出的log付出代價

Log庫都可以靈活的設置輸出界別，所以每一條程序中的log，都是有可能不會被輸出的。這時候要注意不要額外的付出代價。

先看兩個有問題的寫法：

logger.debug("start process request, url: " + url);
logger.debug("receive request: {}", toJson(request));

第一條是直接做了字符串拼接，所以即使日志級別高於debug也會做一個字符串連接操作；第二條雖然用了SLF4J/Log4j2 中的懶求值方式來避免不必要的字符串拼接開銷，但是toJson()這個函數卻是都會被調用並且開銷更大。

推薦的寫法如下:

logger.debug("start process request, url:{}", url); // SLF4J/LOG4J2
logger.debug("receive request: {}", () -> toJson(request)); // LOG4J2
logger.debug(() -> "receive request: " + toJson(request)); // LOG4J2
if (logger.isDebugEnabled()) { // SLF4J/LOG4J2
    logger.debug("receive request: " + toJson(request)); 
}

日志格式中最好不要使用行號，函數名等字段

原因是，為了獲取語句所在的函數名，或者行號，log庫的實現都是獲取當前的stacktrace，然后分析取出這些信息，而獲取stacktrace的代價是很昂貴的。如果有很多的日志輸出，就會占用大量的CPU。在沒有特殊需要的情況下，建議不要在日志中輸出這些這些字段。

最后， log中不要輸出稀奇古怪的字符！

部分開發人員為了方便看到自己的log，會在log語句中加上醒目的前綴，比如:

logger.debug("========================start process request=============");

雖然對於自己來說是方便了，但是如果所有人都這樣來做的話，那log輸出就沒法看了！正確的做法是使用grep 來看只自己關心的日志。

對現有系統日志架構的改造建議

如果現有系統使用JCL作為日志門面，又確實面臨着JCL的ClassLoader機制帶來的問題，完全可以引入slf4j並通過橋接庫將JCL api輸出的日志橋接至slf4j，再通過適配庫適配至現有的日志輸出服務（如log4j），如下圖：

這樣做不需要任何代碼級的改造，就可以解決JCL的ClassLoader帶來的問題，但沒有辦法享受日志模板等slf4j的api帶來的優點。不過之后在現系統上開發的新功能就可以使用slf4j的api了，老代碼也可以分批進行改造。

如果現有系統使用JCL作為日志門面，又頭疼JCL不支持logback和log4j2等新的日志服務，也可以通過橋接庫以slf4j替代JCL，但同樣無法直接享受slf4j api的優點。

如果想要使用slf4j的api，那么就不得不進行代碼改造了，當然改造也可以參考1中提到的方式逐步進行。

如果現系統面臨着log4j的性能問題，可以使用Apache Logging提供的log4j到log4j2的橋接庫log4j-1.2-api，把通過log4j api輸出的日志橋接至log4j2。這樣可以最快地使用上log4j2的先進性能，但組件中缺失了slf4j，對后續進行日志架構改造的靈活性有影響。另一種辦法是先把log4j橋接至slf4j，再使用slf4j到log4j2的適配庫。這樣做稍微麻煩了一點，但可以逐步將系統中的日志輸出標准化為使用slf4j的api，為后面的工作打好基礎。

參考文檔

主要參考整理自：

此外還參考了：