log4j2 使用詳解

轉自: http://blog.csdn.net/lrenjun/article/details/8178875   

前段時間一直用jWebSocket開發長連接的web服務，發現log4j記錄log極爲好用，今天準備仔細研究一下。

1. Log4j2的導入

        

        首先到http://logging.apache.org/log4j/2.x/download.html 上下載最新的log4j2的jar包，然後再eclipse中加入log4j-api-2.0-beta2.jar和log4j-core-2.0-beta2.jar，需要注意的是不要將所有jar都導入工程造成不必要的混亂。

2. 測試用例

      log4j 2.0的使用非常簡單，只要用LogManager的getLogger函數獲取一個logger，就可以使用logger記錄日誌，代碼如下：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class HelloLog4j {
    private static Logger logger = LogManager.getLogger("HelloLog4j");
    public static void main(String[] args) {
        MyApplication myApplication =  new MyApplication();

        logger.entry();
        logger.info("Hello, World!");
        myApplication.doIt();
        logger.error("Hello, World!");
        logger.exit();
    }
}

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;


public class MyApplication {
    static Logger logger = LogManager.getLogger(MyApplication.class.getName());

    public boolean doIt() {
      logger.entry();   //Log entry to a method
      logger.error("Did it again!");   //Log a message object with the ERROR level
      logger.exit();    //Log exit from a method
      return false;
    }
}

運行程序，輸出結果爲：

16:10:28.672 [main] ERROR MyApplication - Did it again!
16:10:28.672 [main] ERROR HelloLog4j - Hello, World!

注意到，輸出的log都是在ERROR level上的，log4j定義了8個級別的log（除去OFF和ALL，可以說分爲6個級別），優先級從高到低依次爲：OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、 ALL。如果將log level設置在某一個級別上，那麼比此級別優先級高的log都能打印出來。例如，如果設置優先級爲WARN，那麼OFF、FATAL、ERROR、WARN 4個級別的log能正常輸出，而INFO、DEBUG、TRACE、 ALL級別的log則會被忽略。從我們實驗的結果可以看出，log4j默認的優先級爲ERROR或者WARN（實際上是ERROR）。

3. 配置文件

          log4j是apache的一個開源項目，在寫這篇博客的時候已經發布了2.0的beta版本，首先需要注意的是，log4j 2.0與以往的1.x有一個明顯的不同，其配置文件只能採用.xml, .json或者 .jsn。在默認情況下，系統選擇configuration文件的優先級如下：（classpath爲scr文件夾）

1. classpath下名爲 log4j-test.json 或者log4j-test.jsn文件
2. classpath下名爲 log4j2-test.xml
3. classpath下名爲 log4j.json 或者log4j.jsn文件
   
4. classpath下名爲 log4j2.xml

        必須注意.xml 文件的文件名爲log4j2，這裏讓我糾結了一個下午，系統一直找不到配置文件，最後發現是文件名裏面少了一個2。下面以log4j2.xml爲例來介紹log4j的配置。

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
  <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="trace">
      <appender-ref ref="Console"/>
    </root>
  </loggers>
</configuration>

         

         首先介紹loggers標籤，用於定義logger的lever和所採用的appender，其中appender-ref必須爲先前定義的appenders的名稱，例如，此處爲Console。那麼log就會以appender所定義的輸出格式來輸出log。

         root標籤爲log的默認輸出形式，如果一個類的log沒有在loggers中明確指定其輸出lever與格式，那麼就會採用root中定義的格式。例如以下定義：

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
  <appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </appenders>
  <loggers>
    <logger name="com.relin.HelloLog4j" level="error" additivity="false">
      <appender-ref ref="Console"/>
    </logger>
    <root level="trace">
      <appender-ref ref="Console"/>
    </root>
  </loggers>
</configuration>

此時，HelloLog4j則會在error級別上輸出log，而其他類則會在trace級別上輸出log。需要注意的是 additivity選項，如果設置爲true（默認值）則HelloLog4j的log會被打印兩次，第二次打印是由於HelloLog4j同時也滿足root裏面定義的trace

4. 其他特徵

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="error">
  <appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/>
      <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
    </Console>
    <File name="log" fileName="target/test.log" append="false">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
    </File>
    <RollingFile name="RollingFile" fileName="logs/app.log"
                 filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
      <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
      <SizeBasedTriggeringPolicy size="500 MB" />
    </RollingFile>
  </appenders>
  <loggers>
    <root level="trace">
      <appender-ref ref="RollingFile"/>
      <appender-ref ref="Console"/>
    </root>
  </loggers>
</configuration>

擴展組件

1，ConsoleAppender

輸出結果到System.out或是System.err。

2，FileAppender

輸出結果到指定文件，同時可以指定輸出數據的格式。append=“false”指定不追加到文件末尾

3，RollingFileAppender

自動追加日誌信息到文件中，直至文件達到預定的大小，然後自動重新生成另外一個文件來記錄之後的日誌。

過濾標籤

1，ThresholdFilter

用來過濾指定優先級的事件。

2，TimeFilter

設置start和end，來指定接收日誌信息的時間區間。