詳解log4j2(上) - 從基礎到實戰

原文:http://blog.csdn.net/autfish/article/details/51203709

log4j2相對於log4j 1.x有了脫胎換骨的變化,其官網宣稱的優勢有多線程下10幾倍於log4j 1.x和logback的高吞吐量、可配置的審計型日誌、基於插件架構的各種靈活配置等。如果已經掌握log4j 1.x,使用log4j2還是非常簡單的。

先看一個示例

1 基礎配置

普通Java項目手動添加jar包

[html] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. log4j-api-2.5.jar  
  2. log4j-core-2.5.jar  
Maven項目pom.xml

[html] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. <dependencies>  
  2.     <dependency>  
  3.         <groupId>org.apache.logging.log4j</groupId>  
  4.         <artifactId>log4j-api</artifactId>  
  5.         <version>2.5</version>  
  6.     </dependency>  
  7.     <dependency>  
  8.         <groupId>org.apache.logging.log4j</groupId>  
  9.         <artifactId>log4j-core</artifactId>  
  10.         <version>2.5</version>  
  11.     </dependency>  
  12. </dependencies>  
測試代碼

[html] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. public static void main(String[] args) {  
  2.     Logger logger = LogManager.getLogger(LogManager.ROOT_LOGGER_NAME);  
  3.     logger.trace("trace level");  
  4.     logger.debug("debug level");  
  5.     logger.info("info level");  
  6.     logger.warn("warn level");  
  7.     logger.error("error level");  
  8.     logger.fatal("fatal level");  
  9. }  
運行後輸出

[html] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console.  
  2. 20:37:11.965 [main] ERROR  - error level  
  3. 20:37:11.965 [main] FATAL  - fatal level  
可以看到log4j2先發了一句牢騷,抱怨沒有找到配置文件什麼的,不過還是輸出了error和fatal兩個級別的信息。

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

下面我們按默認配置添加一個log4j2.xml,添加到src根目錄即可

[html] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <Configuration status="WARN">  
  3.     <Appenders>  
  4.         <Console name="Console" target="SYSTEM_OUT">  
  5.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
  6.         </Console>  
  7.     </Appenders>  
  8.     <Loggers>  
  9.         <Root level="error">  
  10.             <AppenderRef ref="Console" />  
  11.         </Root>  
  12.     </Loggers>  
  13. </Configuration>  
重新執行測試代碼,可以看到輸出結果相同,但是沒有再提示找不到配置文件。
來看我們添加的配置文件log4j2.xml,以Configuration爲根節點,有一個status屬性,這個屬性表示log4j2本身的日誌信息打印級別。如果把status改爲TRACE再執行測試代碼,可以看到控制檯中打印了一些log4j加載插件、組裝logger等調試信息。

日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設置爲WARN,則低於WARN的信息都不會輸出。對於Loggers中level的定義同樣適用。

下面是Appender配置,Appender可以理解爲日誌的輸出目的地,這裏配置了一個類型爲Console的Appender,也就是輸出到控制檯。Console節點中的PatternLayout定義了輸出日誌時的格式:

%d{HH:mm:ss.SSS} 表示輸出到毫秒的時間

%t 輸出當前線程名稱

%-5level 輸出日誌級別,-5表示左對齊並且固定輸出5個字符,如果不足在右邊補0

%logger 輸出logger名稱,因爲Root Logger沒有名稱,所以沒有輸出

%msg 日誌文本

%n 換行

其他常用的佔位符有:

%F 輸出所在的類文件名,如Client.java

%L 輸出行號

%M 輸出所在方法名

%l  輸出語句所在的行數, 包括類名、方法名、文件名、行數

最後是Logger的配置,這裏只配置了一個Root Logger。

2 自定義Logger

首先修改測試代碼

[html] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. public static void main(String[] args) {  
  2.     Logger logger = LogManager.getLogger("mylog");  
  3.     logger.trace("trace level");  
  4.     logger.debug("debug level");  
  5.     logger.info("info level");  
  6.     logger.warn("warn level");  
  7.     logger.error("error level");  
  8.     logger.fatal("fatal level");  
  9. }  
logger從獲取Root Logger改爲嘗試獲得一個名稱爲mylog的Logger,在配置文件中一無所得後,又找到了Root Logger,所以執行結果相同。

下面修改配置文件

[html] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. <Configuration status="WARN" monitorInterval="300">  
  2.     <Appenders>  
  3.         <Console name="Console" target="SYSTEM_OUT">  
  4.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
  5.         </Console>  
  6.     </Appenders>  
  7.     <Loggers>  
  8.         <Logger name="mylog" level="trace" additivity="false">  
  9.         <AppenderRef ref="Console" />  
  10.     </Logger>  
  11.         <Root level="error">  
  12.             <AppenderRef ref="Console" />  
  13.         </Root>  
  14.     </Loggers>  
  15. </Configuration>  
再次執行測試代碼,這一次log4j2很高興的找到了名稱爲mylog的配置,於是使用新配置把level改爲trace,全部的信息都輸出了。

additivity="false"表示在該logger中輸出的日誌不會再延伸到父層logger。這裏如果改爲true,則會延伸到Root Logger,遵循Root Logger的配置也輸出一次。

注意根節點增加了一個monitorInterval屬性,含義是每隔300秒重新讀取配置文件,可以不重啓應用的情況下修改配置,還是很好用的功能。

3 自定義Appender

修改配置文件,添加一個文件類型的Appender,並且把mylog的AppenderRef改爲新加的Appender

[html] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. <Configuration status="WARN" monitorInterval="300">  
  2.     <Appenders>  
  3.         <Console name="Console" target="SYSTEM_OUT">  
  4.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
  5.         </Console>  
  6.         <File name="MyFile" fileName="D:/logs/app.log">  
  7.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
  8.         </File>  
  9.     </Appenders>  
  10.     <Loggers>  
  11.         <Logger name="mylog" level="trace" additivity="true">  
  12.             <AppenderRef ref="MyFile" />  
  13.         </Logger>  
  14.         <Root level="error">  
  15.             <AppenderRef ref="Console" />  
  16.         </Root>  
  17.     </Loggers>  
  18. </Configuration>  
執行並查看控制檯和D:/logs/app.log的輸出結果

4 實用型配置

下面配置一個按時間和文件大小滾動的RollingRandomAccessFile Appender,名字真是夠長,但不光只是名字長,相比RollingFileAppender有很大的性能提升,官網宣稱是20-200%。

Rolling的意思是當滿足一定條件後,就重命名原日誌文件用於備份,並從新生成一個新的日誌文件。例如需求是每天生成一個日誌文件,但是如果一天內的日誌文件體積已經超過1G,就從新生成,兩個條件滿足一個即可。這在log4j 1.x原生功能中無法實現,在log4j2中就很簡單了。

看下面的配置

[html] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. <Configuration status="WARN" monitorInterval="300">  
  2.     <properties>  
  3.         <property name="LOG_HOME">D:/logs</property>  
  4.         <property name="FILE_NAME">mylog</property>  
  5.     </properties>  
  6.     <Appenders>  
  7.         <Console name="Console" target="SYSTEM_OUT">  
  8.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
  9.         </Console>  
  10.         <RollingRandomAccessFile name="MyFile"  
  11.             fileName="${LOG_HOME}/${FILE_NAME}.log"  
  12.             filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">  
  13.             <PatternLayout  
  14.                 pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
  15.             <Policies>  
  16.                 <TimeBasedTriggeringPolicy interval="1" />  
  17.                 <SizeBasedTriggeringPolicy size="10 MB" />  
  18.             </Policies>  
  19.             <DefaultRolloverStrategy max="20" />  
  20.         </RollingRandomAccessFile>  
  21.     </Appenders>  
  22.   
  23.     <Loggers>  
  24.         <Logger name="mylog" level="trace" additivity="false">  
  25.             <AppenderRef ref="MyFile" />  
  26.         </Logger>  
  27.         <Root level="error">  
  28.             <AppenderRef ref="Console" />  
  29.         </Root>  
  30.     </Loggers>  
  31. </Configuration>  

<properties>定義了兩個常量方便後面複用

RollingRandomAccessFile的屬性:

fileName  指定當前日誌文件的位置和文件名稱

filePattern  指定當發生Rolling時,文件的轉移和重命名規則

SizeBasedTriggeringPolicy  指定當文件體積大於size指定的值時,觸發Rolling

DefaultRolloverStrategy  指定最多保存的文件個數

TimeBasedTriggeringPolicy  這個配置需要和filePattern結合使用,注意filePattern中配置的文件重命名規則是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i,最小的時間粒度是mm,即分鐘,TimeBasedTriggeringPolicy指定的size是1,結合起來就是每1分鐘生成一個新文件。如果改成%d{yyyy-MM-dd HH},最小粒度爲小時,則每一個小時生成一個文件。

修改測試代碼,模擬文件體積超過10M和時間超過1分鐘來驗證結果

[java] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. public static void main(String[] args) {  
  2.     Logger logger = LogManager.getLogger("mylog");  
  3.     for(int i = 0; i < 50000; i++) {  
  4.         logger.trace("trace level");  
  5.         logger.debug("debug level");  
  6.         logger.info("info level");  
  7.         logger.warn("warn level");  
  8.         logger.error("error level");  
  9.         logger.fatal("fatal level");  
  10.     }  
  11.     try {  
  12.         Thread.sleep(1000 * 61);  
  13.     } catch (InterruptedException e) {}  
  14.     logger.trace("trace level");  
  15.     logger.debug("debug level");  
  16.     logger.info("info level");  
  17.     logger.warn("warn level");  
  18.     logger.error("error level");  
  19.     logger.fatal("fatal level");  
  20. }  

5 自定義配置文件位置

log4j2默認在classpath下查找配置文件,可以修改配置文件的位置。在非web項目中:

[java] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. public static void main(String[] args) throws IOException {  
  2.     File file = new File("D:/log4j2.xml");  
  3.     BufferedInputStream in = new BufferedInputStream(new FileInputStream(file));  
  4.     final ConfigurationSource source = new ConfigurationSource(in);  
  5.     Configurator.initialize(null, source);  
  6.       
  7.     Logger logger = LogManager.getLogger("mylog");  
  8. }  
如果是web項目,在web.xml中添加

[java] view plain copy
 print?在CODE上查看代碼片派生到我的代碼片
  1. <context-param>  
  2.     <param-name>log4jConfiguration</param-name>  
  3.     <param-value>/WEB-INF/conf/log4j2.xml</param-value>  
  4. </context-param>  
  5.   
  6. <listener>  
  7.     <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>  
  8. </listener>  

掌握這些基本可以實際使用了,下篇介紹一些高級應用,異步Appender、MongoDB Appender和基於Filters的按級別輸出到不同文件的設置
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章