Java中的日志框架

常見日志框架

JUL|Log4j1|Log4j2|Logback|JCL|Slf4j

日志框架需要解決的問題

• 穩(wěn)定性高：不可影響主進(jìn)程的正常運(yùn)行且自身的日志內(nèi)容準(zhǔn)確無歧義
• 擴(kuò)展性高：對于不同的日志輸出需求，有便捷的方式進(jìn)行自定義擴(kuò)展
• 開銷低：不可占用服務(wù)器的過多資源，影響主進(jìn)程的執(zhí)行速度
• 延遲低：對應(yīng)的日志內(nèi)容輸出不可延遲太久，否則失去觀察的意義

框架對比

Slf4j

• 保證了項(xiàng)目內(nèi)日志框架升級的便捷性，項(xiàng)目間日志框架的一致性
• 利用Bridging legacy logging APIs實(shí)現(xiàn)已有JCL、JUL、Log4j多項(xiàng)目的歸并統(tǒng)一
• 參數(shù)化日志打印
• 無綁定、多綁定、版本異常等可以在加載期進(jìn)行檢測提示

解決的問題

without slf4j

with slf4j

調(diào)用關(guān)系鏈

slf4j application

Log4j2

性能對比

log4j2 benchmark 1

log4j2 benchmark 2

基礎(chǔ)概念

Log Level

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

Log Event

Appender

真正執(zhí)行日志輸出的類，log4j2預(yù)定義了多種用途的Appender如Console Appender，F(xiàn)ile Appender，Http Appender等，其中Appender按執(zhí)行層級又可以分為二種：普通Appender與引用Appender，引用Appender即自身并不實(shí)現(xiàn)具體的輸出而是對普通Appender進(jìn)行了一層包裝來實(shí)現(xiàn)異步、過濾、轉(zhuǎn)發(fā)等目的

Logger

具體的日志對象，一個(gè)Logger對象可以包含[0, n)個(gè)Appender來同時(shí)輸出到不同流；同時(shí)Logger對象還包含一些管理信息如Log Level及Log Filter等

結(jié)構(gòu)圖解

log4j 2

常用配置項(xiàng)

<?xml version="1.0" encoding="UTF-8"?>;
<Configuration name="my configuration file" status="WARN" monitorInterval="30" desc="log4jdebug.log">
  <Properties>
    <Property name="name1">value</property>
    <Property name="name2" value="value2"/>
  </Properties>
  <filters>
      <MarkerFilter marker="FLOW" onMatch="ACCEPT" onMismatch="NEUTRAL"/>
      <MarkerFilter marker="EXCEPTION" onMatch="ACCEPT" onMismatch="DENY"/>
  </filters>
  <Appenders>
    <RollingFile name="RollingFile" fileName="logs/app.log"
                 filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
      <PatternLayout>
        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
      </PatternLayout>
      <Policies>
        <TimeBasedTriggeringPolicy />
        <SizeBasedTriggeringPolicy size="250 MB"/>
      </Policies>
    </RollingFile>
    ...
  </Appenders>
  <Loggers>
    <Logger name="name1">
      <filter  ... />
      <AppenderRef ref="name1"/>
      <AppenderRef ref="name2"/>
    </Logger>
    ...
    <Root level="level">
      <AppenderRef ref="name"/>
    </Root>
  </Loggers>
</Configuration>

Configuration

• status：LogLevel；log4j2內(nèi)部代碼日志級別，調(diào)試時(shí)可設(shè)置為trace
• monitorInterval：配置變更檢測間隔，單位秒；注意只有當(dāng)monitorInterval之后并有新的logEvent時(shí)才會(huì)真正觸發(fā)reconfiguration
• dest：err|out|file|URL；log4j2內(nèi)部代碼輸出流，對于不方便直接查看的環(huán)境可以導(dǎo)出調(diào)試信息至文件

Properties

類似POM文件中的Properties，定義通過kvp，引用通過{prefix:name}，如{sys:some.property:-default_value}表示取名為some.property的系統(tǒng)參數(shù)，當(dāng)不存在時(shí)使用default_value`進(jìn)行替換

Filter

Log Event過濾器，每個(gè)過濾器有三種返回結(jié)果Accept|Deny|Neutral，分別表示直接接受，直接拒絕，向下傳遞；根據(jù)Filter的作用域又可以分為以下三種

• 全局Filter，配置節(jié)點(diǎn)與Properties\Appenders\Loggers同級
• Logger Filter，位于Logger中，針對某個(gè)具體的Logger進(jìn)行過濾
• Appender Filter，位于Appender中，針對某個(gè)具體的Appender進(jìn)行過濾

Appenders

Rolling File Appender

觸發(fā)策略Policy配置時(shí)類似Filter，可以使用Policies進(jìn)行多項(xiàng)配置，只要任一項(xiàng)Policy滿足條件則觸發(fā)

<Policies>
  <OnStartupTriggeringPolicy />
  <SizeBasedTriggeringPolicy size="20 MB" />
  <TimeBasedTriggeringPolicy />
</Policies>

AsyncAppender

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Appenders>
    <File name="MyFile" fileName="logs/app.log">
      <PatternLayout>
        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
      </PatternLayout>
    </File>
    <Async name="Async">
      <AppenderRef ref="MyFile"/>
    </Async>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="Async"/>
    </Root>
  </Loggers>
</Configuration>

RewriteAppender

重寫log event，主要用于數(shù)據(jù)過濾或脫敏

RoutingAppender

appender重定向，需要注意的是routing必須定義在所有關(guān)聯(lián)appender之后

Logger

• additivity：true|false；是否繼承父類logger，默認(rèn)繼承
• name：string；唯一標(biāo)識，除root logger外都必須配置
• level：log level；日志輸出級別，默認(rèn)為error
• appenderRef：string；關(guān)聯(lián)appender的name

合并配置項(xiàng)

• 使用XInclude<xi:include href="log4j-xinclude-appenders.xml" />進(jìn)行文件內(nèi)合并
• 使用log4j.configurationFile參數(shù)進(jìn)行跨文件合并：file1,file2

注意事項(xiàng)

• 當(dāng)未提供log4j.configurationFile啟動(dòng)參數(shù)時(shí)，將按內(nèi)置優(yōu)先級依次查找配置文件，都未找到的情況下使用默認(rèn)ConsoleAppender且Level設(shè)置為Error
• 調(diào)試log4j2的內(nèi)部日志有二種常用方式：設(shè)置配置文件的status屬性為trace；在啟動(dòng)參數(shù)中加入log4j2.debug（僅支持debug級別）；更多l(xiāng)og4j2支持的啟動(dòng)參數(shù)請查閱這里

FAQ

為什么我使用了日志配置文件確依然沒有日志輸出？

答：

• 確認(rèn)是否引入了slf4j的實(shí)現(xiàn)包，比如slf4j-log4j-impl；若沒有，slf4j會(huì)提示無法找到對應(yīng)實(shí)現(xiàn)類，若提供了多個(gè)slf4j實(shí)現(xiàn)包，則同樣會(huì)提示綁定沖突
• 確認(rèn)是否正確提供了日志配置文件；若沒有，log4j會(huì)提示找不到配置文件并啟動(dòng)默認(rèn)配置集（Console + Level.Error）
• 確認(rèn)是否配置了bufferIO及緩沖區(qū)；只有緩沖區(qū)滿才會(huì)提交到磁盤IO進(jìn)行寫入操作
• 確認(rèn)是否有磁盤文件創(chuàng)建權(quán)限；可以使用sudo啟動(dòng)或預(yù)先以運(yùn)行用戶的角色建立好日志文件路徑

我添加了依賴slf4j-log4j2-impl，那么我還是否需要額外引入slf4j-api？

答：不需要，slf4j的實(shí)現(xiàn)包具體依賴項(xiàng)以POM文件為準(zhǔn)

分析如下三種函數(shù)使用方式，哪種最優(yōu)，好在哪里？

logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));

if(logger.isDebugEnabled()) {
  logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
}

logger.debug("Entry number: {} is {}.", i, String.valueOf(entry[i]);

答：第三種，減少字符串的合并操作

在log4j的參數(shù)化日志方法中，分析如下幾種情況的輸出

logger.debug("param-1: {}, param-2: {}, param-3: {}", "1", "2", "3")

logger.info("param-1: \\{}, param-2: {}, param-3: {}", "1", "2", "3")

logger.info("param-1: {}, param-2: {{}}, param-3: {}", "1", "2", "3")

答：

• param-1: 1, param-2: 2, param-3: 3
• param-1: {}, param-2: 1, param-3: 2
• param-1: 1, param-2: {2}, param-3: 3

Logger對象定義為static或variable有什么區(qū)別，適用于哪些場景？JCL及Slf4j是如何解決這個(gè)問題的？

static 可能產(chǎn)生的混亂

答：static在同容器多應(yīng)用的場景下可能存在引用沖突；JCL默認(rèn)使用MAP來存儲(chǔ)每個(gè)Logger的引用，需要手動(dòng)釋放可能存在使用不當(dāng)導(dǎo)致內(nèi)存泄漏；Slf4j沒有這樣的機(jī)制，是否static完全交由使用者控制

Slf4j為什么沒有FATAL以及TRACE級別？

答：Slf4j的作者設(shè)計(jì)理念，認(rèn)為FATAL類似ERROR，TRACE類似DEBUG，存在概念上的混淆；如果確實(shí)需要標(biāo)記為FATAL或TRACE可以使用Marker + Pattern來實(shí)現(xiàn)

分析以下配置文件最終生成的日志文件將會(huì)是什么樣的？

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Appenders>
    <RollingFile name="RollingFile" filePattern="logs/app-%d{yyyy-MM-dd-HH}-%i.log.gz">
      <PatternLayout>
        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
      </PatternLayout>
      <Policies>
        <CronTriggeringPolicy schedule="0 0 * * * ?"/>
        <SizeBasedTriggeringPolicy size="250 MB"/>
      </Policies>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
    </Root>
  </Loggers>
</Configuration>

答：

資源鏈接

JUL - java.util.logging - ORACLE

JUL Tutorials - vogella.com

StackOverflow - Why NOT JUL?

JCL - Apache Commons Logging

Slf4j - Simple Logging Facade for Java

Slf4j - 如何正確的排除依賴包中的日志框架

Slf4j - 如何提高日志的性能

Logger - Static or Not?

Log4j 1.x to Log4j 2.x

Log4j 2 Benchmarks

Log4j 2 Pattern Layout