log4j2相對於log4j 1.x有了脫胎換骨的變化,其官網宣稱的優勢有多線程下10幾倍於log4j 1.x和logback的高吞吐量、可配置的審計型日誌、基於插件架構的各種靈活配置等。如果已經掌握log4j 1.x,使用log4j2還是非常簡單的。
1、基礎配置
<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>
Maven項目pom.xml
糾正一下:本人親自在搭建項目的時候,發現如果項目中只有這兩個jar,是顯示不正常的,需要加上log4j2的實現。另外一個比較重要的地方就是,有些日誌無法使用log4j2完全接管整個系統的日誌,可能是由於其他的依賴包依賴帶着log4j的包,導致會出現下面的現象:
log4j:WARN No appenders could be found for logger (org.springframework.web.context.ContextLoader).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
解決方法是:將log4j 1.x給排除掉,使用
<exclusion>
<artifactId>log4j</artifactId>
<groupId>log4j</groupId>
</exclusion>
那如何排除呢? 可以藉助IDE編程工具,使用Eclipse或者Interlij Idea,比如Eclipse可以使用POM視圖,方便的查看有哪些包引用了log4j 1.x系列,然後使用exclusion排除即可。祝好運~
糾正前,導入了這兩個包
log4j-api-2.5.jar
log4j-core-2.5.jar
糾正後
<dependency>
<groupId>org.apache.logging.log4j</groupId> -->添加後也支持log4j以前的使用方式
<artifactId>log4j-slf4j-impl</artifactId>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
</dependency>
糾正後支持的使用方式有:
Logger logger = LogManager.getLogger(LogManager.ROOT_LOGGER_NAME); log4j2的專屬方式
Logger logger = LoggerFactory.getLogger(EchoFilter.class); log4j的使用方式
測試代碼
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");
}
運行後輸出
ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console.
20:37:11.965 [main] ERROR - error level
20:37:11.965 [main] FATAL - fatal level
可以看到log4j2先發了一句牢騷,抱怨沒有找到配置文件什麼的,不過還是輸出了error和fatal兩個級別的信息。
log4j2默認會在classpath目錄下尋找log4j.json、log4j.jsn、log4j2.xml等名稱的文件,如果都沒有找到,則會按默認配置輸出,也就是輸出到控制檯。
下面我們按默認配置添加一個log4j2.xml,添加到src根目錄即可
<?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>
重新執行測試代碼,可以看到輸出結果相同,但是沒有再提示找不到配置文件。
來看我們添加的配置文件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 輸出語句所在的行數, 包括類名、方法名、文件名、行數
2、自定義Logger
首先修改測試代碼
public static void main(String[] args) {
Logger logger = LogManager.getLogger("mylog");
logger.trace("trace level");
logger.debug("debug level");
logger.info("info level");
logger.warn("warn level");
logger.error("error level");
logger.fatal("fatal level");
}
logger從獲取Root Logger改爲嘗試獲得一個名稱爲mylog的Logger,在配置文件中一無所得後,又找到了Root Logger,所以執行結果相同。
下面修改配置文件
<Configuration status="WARN" monitorInterval="300">
<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="mylog" level="trace" additivity="false">
<AppenderRef ref="Console" />
</Logger>
<Root level="error">
<AppenderRef ref="Console" />
</Root>
</Loggers>
</Configuration>
再次執行測試代碼,這一次log4j2很高興的找到了名稱爲mylog的配置,於是使用新配置把level改爲trace,全部的信息都輸出了。additivity="false"表示在該logger中輸出的日誌不會再延伸到父層logger。這裏如果改爲true,則會延伸到Root Logger,遵循Root Logger的配置也輸出一次。
注意根節點增加了一個monitorInterval屬性,含義是每隔300秒重新讀取配置文件,可以不重啓應用的情況下修改配置,還是很好用的功能。
3、自定義Appender
修改配置文件,添加一個文件類型的Appender,並且把mylog的AppenderRef改爲新加的Appender
<Configuration status="WARN" monitorInterval="300">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
</Console>
<File name="MyFile" fileName="D:/logs/app.log">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
</File>
</Appenders>
<Loggers>
<Logger name="mylog" level="trace" additivity="true">
<AppenderRef ref="MyFile" />
</Logger>
<Root level="error">
<AppenderRef ref="Console" />
</Root>
</Loggers>
</Configuration>
執行並查看控制檯和D:/logs/app.log的輸出結果
4、實用型配置
下面配置一個按時間和文件大小滾動的RollingRandomAccessFile Appender,名字真是夠長,但不光只是名字長,相比RollingFileAppender有很大的性能提升,官網宣稱是20-200%。
Rolling的意思是當滿足一定條件後,就重命名原日誌文件用於備份,並從新生成一個新的日誌文件。例如需求是每天生成一個日誌文件,但是如果一天內的日誌文件體積已經超過1G,就從新生成,兩個條件滿足一個即可。這在log4j 1.x原生功能中無法實現,在log4j2中就很簡單了。
看下面的配置
<Configuration status="WARN" monitorInterval="300">
<properties>
<property name="LOG_HOME">D:/logs</property>
<property name="FILE_NAME">mylog</property>
</properties>
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
</Console>
<RollingRandomAccessFile name="MyFile"
fileName="${LOG_HOME}/${FILE_NAME}.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">
<PatternLayout
pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
<Policies>
<TimeBasedTriggeringPolicy interval="1" />
<SizeBasedTriggeringPolicy size="10 MB" />
</Policies>
<DefaultRolloverStrategy max="20" />
</RollingRandomAccessFile>
</Appenders>
<Loggers>
<Logger name="mylog" level="trace" additivity="false">
<AppenderRef ref="MyFile" />
</Logger>
<Root level="error">
<AppenderRef ref="Console" />
</Root>
</Loggers>
</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分鐘來驗證結果。
public static void main(String[] args) {
Logger logger = LogManager.getLogger("mylog");
for(int i = 0; i < 50000; i++) {
logger.trace("trace level");
logger.debug("debug level");
logger.info("info level");
logger.warn("warn level");
logger.error("error level");
logger.fatal("fatal level");
}
try {
Thread.sleep(1000 * 61);
} catch (InterruptedException e) {}
logger.trace("trace level");
logger.debug("debug level");
logger.info("info level");
logger.warn("warn level");
logger.error("error level");
logger.fatal("fatal level");
}
5、自定義配置文件位置
log4j2默認在classpath下查找配置文件,可以修改配置文件的位置。在非web項目中:
public static void main(String[] args) throws IOException {
File file = new File("D:/log4j2.xml");
BufferedInputStream in = new BufferedInputStream(new FileInputStream(file));
final ConfigurationSource source = new ConfigurationSource(in);
Configurator.initialize(null, source);
Logger logger = LogManager.getLogger("mylog");
}
如果是web項目,在web.xml中添加
<context-param>
<param-name>log4jConfiguration</param-name>
<param-value>/WEB-INF/conf/log4j2.xml</param-value>
</context-param>
<listener>
<listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>
</listener>
掌握這些基本可以實際使用了,下篇介紹一些高級應用,異步Appender、MongoDB Appender和基於Filters的按級別輸出到不同文件的設置
重大補充:
log4j是apache的一個開源項目,在寫這篇博客的時候已經發布了2.0的beta版本,首先需要注意的是,log4j 2.0與以往的1.x有一個明顯的不同,其配置文件只能採用.xml, .json或者 .jsn。在默認情況下,系統選擇configuration文件的優先級如下:(classpath爲scr文件夾)
- classpath下名爲 log4j-test.json 或者log4j-test.jsn文件
- classpath下名爲 log4j2-test.xml
- classpath下名爲 log4j.json 或者log4j.jsn文件
- classpath下名爲 log4j2.xml
必須注意.xml 文件的文件名爲log4j2,這裏讓我糾結了一個下午,系統一直找不到配置文件,最後發現是文件名裏面少了一個2。下面以log4j2.xml爲例來介紹log4j的配置。
<Filters>
<ThresholdFilter level="TRACE" onMatch="NEUTRAL" onMismatch="DENY"/>
<RegexFilter regex=".* test .*" onMatch="NEUTRAL" onMismatch="DENY"/>
<TimeFilter start="05:00:00" end="05:30:00" onMatch=" NEUTRAL " onMismatch="DENY"/>
</Filters>
<Filters>是組合過濾器額標籤,它包含的子標籤是具體的過濾器,這三個具體過濾器分別是日誌等級過濾器,正則表達式過濾器和時間過濾器。
需要說明的是onMatch和onMismatch可以選擇的值及其含義。可選的值分別是,ACCEPT, DENY, NEUTRAL,ACCEP和DENY比較好理解就是接受和拒絕的意思,在使用單個過濾器的時候,一般就是使用這兩個值。但是在組合過濾器中,如果用接受ACCEPT的話,日誌信息就會直接寫入日誌文件,後續的過濾器不再進行過濾。所以,在組合過濾器中,接受使用NEUTRAL(中立),被第一個過濾器接受的日誌信息,會繼續用後面的過濾器進行過濾,只有符合所有過濾器條件的日誌信息,纔會被最終寫入日誌文件。
一張比較好理解的log4j架構圖