log4j2 使用紀要

簡介

Apache Log4j 2 是Log4j 的升級版，在該版本實現中，日志的處理流程及效率有了顯著提升。
此外新版本也合入了一些logback日志框架體系的一些改進點。

關鍵特性

• API分離，接口與實現分離，便於擴展

• 性能提升，框架基於LMAX Disruptor庫實現了下一代的 Asynchronous Loggers。在多線程場景下相比log4j1.x和logback有將近18倍的性能提升，參考幾近瘋狂的log4j2,關於異步的參考

• 支持多API,包括Log4j 1.2, SLF4J, Commons Logging 以及 java.util.logging (JUL) APIs.

• 自動重載配置

• 更高級的過濾

• 支持插件結構，可以方便的定制格式

• 支持系統屬性配置

• 支持自定義Level

• 極少的垃圾回收，大大提升了響應時間

• Java 8 Lambda 表達式支持

• 直接與Tomcat/Jetty等應用服務器集成

maven依賴

<dependencies>  
    <dependency>  
        <groupId>org.apache.logging.log4j</groupId>  
        <artifactId>log4j-api</artifactId>  
        <version>2.5</version>  
    </dependency>  
    <dependency>  
        <groupId>org.apache.logging.log4j</groupId>  
        <artifactId>log4j-core</artifactId>  
        <version>2.5</version>  
    </dependency>  
</dependencies>  

簡單示例

配置路徑
log4j2默認會在classpath目錄下尋找log4j.json、log4j.jsn、log4j2.xml等名稱的文件，如果都沒有找到，則會按默認配置輸出，也就是輸出到控制台

代碼樣例

public static void main(String[] args) {  
    Logger logger = LogManager.getLogger(LogManager.ROOT_LOGGER_NAME);  
    logger.trace("trace level");  
    logger.debug("debug level");  
    logger.info("info level");  
    logger.warn("warn level");  
    logger.error("error level");  
    logger.fatal("fatal level");  
}  

默認配置

<?xml version="1.0" encoding="UTF-8"?>  
<Configuration status="WARN">  
    <Appenders>  
        <Console name="Console" target="SYSTEM_OUT">  
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
        </Console>  
    </Appenders>  
    <Loggers>  
        <Root level="error">  
            <AppenderRef ref="Console" />  
        </Root>  
    </Loggers>  
</Configuration>  

格式說明

%d{HH:mm:ss.SSS} 表示輸出到毫秒的時間
%t 				輸出當前線程名稱
%-5level 		輸出日志級別，-5表示左對齊並且固定輸出5個字符，如果不足在右邊補0
%logger 		輸出logger名稱，因為Root Logger沒有名稱，所以沒有輸出
%msg 			日志文本
%n 				換行
%F 				輸出所在的類文件名，如Client.java
%L 				輸出行號
%M 				輸出所在方法名
%l  			輸出語句所在的行數, 包括類名、方法名、文件名、行數

更多格式說明

log4j2.xml，以Configuration為根節點，有一個status屬性，這個屬性表示log4j2本身的日志信息打印級別。
如果把status改為TRACE再執行測試代碼，可以看到控制台中打印了一些log4j加載插件、組裝logger等調試信息。

實用配置

在生產系統中通常需要定義不同模塊的日志，此外日志文件的Rolling也需要做相應配置。
一種比較常見的需求是按日期和大小(兩者滿足其一)則產生日志滾動。通過log4j2可以輕松的實現。

配置示例

<Configuration status="WARN" monitorInterval="300">  
    <properties>  
        <property name="LOG_ROOT">/var/log/app</property>  
        <property name="FILE_NAME">application</property>  
    </properties>  
    <Appenders>  
        <Console name="Console" target="SYSTEM_OUT">  
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS}–[%t] %-5level -%l - %msg%n" />  
        </Console>  
        <RollingRandomAccessFile name="MainFile"  
            fileName="${LOG_ROOT}/${FILE_NAME}.log"  
            filePattern="${LOG_ROOT}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH}-%i.log">  
            <PatternLayout  
                pattern="%d{yyyy-MM-dd HH:mm:ss.SSS}–[%t] %-5level -%l - %msg%n" />  
            <Policies>  
                <TimeBasedTriggeringPolicy interval="1" />  
                <SizeBasedTriggeringPolicy size="50 MB" />  
            </Policies>  
            <DefaultRolloverStrategy max="20" />  
        </RollingRandomAccessFile>  
    </Appenders>  
  
    <Loggers>  
        <Logger name="main" level="trace" additivity="false">  
            <AppenderRef ref="MainFile" />  
        </Logger>  
        <Root level="error">  
            <AppenderRef ref="Console" />  
            <AppenderRef ref="MainFile" />  
        </Root>  
    </Loggers>  
</Configuration>  

說明

• Configuration.status 指定log4j本身日志為warn級別，monitorInterval指定5分鍾檢查配置是否發生變更(支持重載)
• properties定義了相關變量配置，包括目錄、文件名稱
• Root級別為error，指定輸出到Console
• mylog配置了一個自定義Appender，RollingRandomAccessFile支持按時間和大小實現滾動
  TimeBasedTriggeringPolicy 與filePattern匹配，每個小時生成一個文件
  SizeBasedTriggeringPolicy 指定每50M生成一個文件
  DefaultRolloverStrategy max=20指定按大小滾動時最多個數

log4j2整合slf4j

       <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>2.9.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.9.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>2.9.1</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.25</version>
        </dependency>

參考文檔

Log4j2基礎到實踐
RollingFileAppender定義
web應用程序集成
Springboot集成slf4j-log4j2