技術標籤：日誌框架log4j2

文章目錄

• • • • • • 一、log4j2介紹
          • 二、配置檔案節點解析
          • 三、需要的Maven依賴
          • 四、最簡配置
          • 五、較全面的配置
          • 補充

一、log4j2介紹

log4j 2.x版本不再支援像1.x中的.properties字尾的檔案配置方式，2.x版本配置檔案字尾名只能為".xml",".json"或者".jsn"。
配置檔案的格式：log2j配置檔案可以是xml格式的，也可以是json格式的。
配置檔案的位置：log4j2預設會在classpath目錄下尋找log4j2.xml、log4j.json、log4j.jsn等名稱的檔案。

系統選擇配置檔案的優先順序(從先到後)如下：
　　(1).classpath下的名為log4j2-test.json 或者log4j2-test.jsn的檔案.
　　(2).classpath下的名為log4j2-test.xml的檔案.
　　(3).classpath下名為log4j2.json 或者log4j2.jsn的檔案.
　　(4).classpath下名為log4j2.xml的檔案.
　　我們一般預設使用log4j2.xml進行命名。

二、配置檔案節點解析

(1).根節點Configuration有兩個屬性:status和monitorinterval,有兩個子節點:Appenders和Loggers(表明可以定義多個Appender和Logger)。

  status用來指定log4j本身的列印日誌的級別。
  monitorinterval用於指定log4j自動重新配置的監測間隔時間，單位是s,最小是5s。
  (2).Appenders節點，常見的有三種子節點:Console、RollingFile、File。
Console節點用來定義輸出到控制檯的Appender。
  name:指定Appender的名字.
  target:SYSTEM_OUT 或 SYSTEM_ERR,一般只設置預設:SYSTEM_OUT。
  PatternLayout:輸出格式，不設定預設為:%m%n。
File節點用來定義輸出到指定位置的檔案的Appender。
  name:指定Appender的名字。
  fileName:指定輸出日誌的目的檔案帶全路徑的檔名。
  PatternLayout:輸出格式，不設定預設為:%m%n。
RollingFile節點用來定義超過指定大小自動刪除舊的建立新的的Appender。
  name:指定Appender的名字。
  fileName:指定輸出日誌的目的檔案帶全路徑的檔名。
  PatternLayout:輸出格式，不設定預設為:%m%n。
  filePattern:指定新建日誌檔案的名稱格式。
  Policies:指定滾動日誌的策略，就是什麼時候進行新建日誌檔案輸出日誌。
  TimeBasedTriggeringPolicy:Policies子節點，基於時間的滾動策略，interval屬性用來指定多久滾動一次，預設是1 hour。modulate=true用來調整時間：比如現在是早上3am，interval是4，那麼第一次滾動是在4am，接著是8am，12am…而不是7am。
  SizeBasedTriggeringPolicy:Policies子節點，基於指定檔案大小的滾動策略，size屬性用來定義每個日誌檔案的大小。
  DefaultRolloverStrategy:用來指定同一個資料夾下最多有幾個日誌檔案時開始刪除最舊的，建立新的(通過max屬性)。
ThresholdFilter屬性：onMatch表示匹配設定的日誌級別後是DENY還是ACCEPT，onMismatch表示不匹配設定的日誌級別是DENY還是ACCEPT還是NEUTRAL。
  (3).Loggers節點，常見的有兩種:Root和Logger。
  Root節點用來指定專案的根日誌，如果沒有單獨指定Logger，那麼就會預設使用該Root日誌輸出
  level:日誌輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。
  Logger節點用來單獨指定日誌的形式，比如要為指定包下的class指定不同的日誌級別等。
  level:日誌輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。
  name:用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節點。
  AppenderRef：Logger的子節點，用來指定該日誌輸出到哪個Appender,如果沒有指定，就會預設繼承自Root.如果指定了，那麼會在指定的這個Appender和Root的Appender中都會輸出，此時我們可以設定Logger的additivity="false"只在自定義的Appender中進行輸出。
  (4).關於日誌level.
　　共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。
　　All:最低等級的，用於開啟所有日誌記錄。
　　Trace:是追蹤，就是程式推進以下，你就可以寫個trace輸出，所以trace應該會特別多，不過沒關係，我們可以設定最低日誌級別不讓他輸出。
　　Debug:指出細粒度資訊事件對除錯應用程式是非常有幫助的。
　　Info:訊息在粗粒度級別上突出強調應用程式的執行過程。
　　Warn:輸出警告及warn以下級別的日誌。
　　Error:輸出錯誤資訊日誌。
　　Fatal:輸出每個嚴重的錯誤事件將會導致應用程式的退出的日誌。
　　OFF:最高等級的，用於關閉所有日誌記錄。
　　程式會列印高於或等於所設定級別的日誌，設定的日誌等級越高，打印出來的日誌就越少。

配置引數解釋
%d{HH:mm:ss.SSS} 表示輸出到毫秒的時間
%t 輸出當前執行緒名稱
%-5level 輸出日誌級別，-5表示左對齊並且固定輸出5個字元，如果不足在右邊補0
%logger 輸出logger名稱，因為Root Logger沒有名稱，所以沒有輸出
%msg 日誌文字
%n 換行
其他常用的佔位符有：
%F 輸出所在的類檔名，如Log4j2Test.java
%L 輸出行號
%M 輸出所在方法名
%l 輸出語句所在的行數, 包括類名、方法名、檔名、行數

三、需要的Maven依賴

<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>  

四、最簡配置

<?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>

五、較全面的配置

<?xml version="1.0" encoding="UTF-8"?>
 <!--日誌級別以及優先順序排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
 <!--Configuration後面的status，這個用於設定log4j2自身內部的資訊輸出，可以不設定，當設定成trace時，你會看到log4j2內部各種詳細輸出-->
 <!--monitorInterval：Log4j能夠自動檢測修改配置 檔案和重新配置本身，設定間隔秒數-->
 <configuration status="WARN" monitorInterval="30">
     <!--先定義所有的appender-->
     <appenders>
     <!--這個輸出控制檯的配置-->
         <console name="Console" target="SYSTEM_OUT">
         <!--輸出日誌的格式-->
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
         </console>
     <!--檔案會打印出所有資訊，這個log每次執行程式會自動清空，由append屬性決定，這個也挺有用的，適合臨時測試用-->
     <File name="log" fileName="log/test.log" append="false">
        <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
     </File>
     <!-- 這個會打印出所有的info及以下級別的資訊，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的資料夾下面並進行壓縮，作為存檔-->
         <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
             <!--控制檯只輸出level及以上級別的資訊（onMatch），其他的直接拒絕（onMismatch）-->        
             <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         </RollingFile>
         <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         <!-- DefaultRolloverStrategy屬性如不設定，則預設為最多同一資料夾下7個檔案，這裡設定了20 -->
             <DefaultRolloverStrategy max="20"/>
         </RollingFile>
         <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         </RollingFile>
     </appenders>
     <!--然後定義logger，只有定義了logger並引入的appender，appender才會生效-->
     <loggers>
         <!--過濾掉spring和mybatis的一些無用的DEBUG資訊-->
         <logger name="org.springframework" level="INFO"></logger>
         <logger name="org.mybatis" level="INFO"></logger>
         <root level="all">
             <appender-ref ref="Console"/>
             <appender-ref ref="RollingFileInfo"/>
             <appender-ref ref="RollingFileWarn"/>
             <appender-ref ref="RollingFileError"/>
         </root>
     </loggers>
 </configuration>

補充

log4j2.xml 檔案需要配置到WEB-INF的classes下面才會生效

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="ERROR" monitorInterval="600">
    <!-- configure.status 為設定日誌輸出級別，級別如下：OFF 、FATAL 、ERROR、WARN、INFO、DEBUG、TRACE、ALL -->
    <!-- configure.monitorInterval 監控間隔 指log4j2每隔600秒（10分鐘），自動監控該配置檔案是否有變化，如果變化，則自動根據檔案內容重新配置 -->

    <Properties>
        <property name="pattern">%d{yyyy/MM/dd HH:mm:ss.SSS} [%p] %t %c %m%n</property>
        <property name="basePath">H:/datatrans/logs</property>
    </Properties>

    <!--配置appenders源：日誌輸出的地址-->
    <Appenders>

        <Console name="console" target="SYSTEM_OUT">
            <PatternLayout pattern="${pattern}"/>
        </Console>

        <RollingRandomAccessFile name="fileLogger"
                                 fileName="${basePath}/server.log"
                                 filePattern="${basePath}/server-%d{yyyy-MM-dd}.log"
                                 append="true">
            <PatternLayout pattern="${pattern}"/>

            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                <!--測試日誌輸出:-->
                <SizeBasedTriggeringPolicy size="3kb"/>
                <!--<SizeBasedTriggeringPolicy size="100MB"/>-->
            </Policies>
        </RollingRandomAccessFile>
    </Appenders>

    <!--配置logers：級別、使用的輸出地-->
    <Loggers>
        <Logger name="com.gblfy.datatrans"
                level="debug"
                additivity="true">
            <appender-ref ref="fileLogger"
                          level="debug"/>
        </Logger>

        <Root level="info" additivity="false">
            <appender-ref ref="console"/>
        </Root>
    </Loggers>
</Configuration>

參考：
Java日誌框架與Log4j2詳解
https://www.jianshu.com/p/1b04924d8a1f
Java日誌列印: log4j2
https://www.cnblogs.com/bestlmc/p/12012875.html