log4j2相對于log4j 1.x有了脫胎換骨的變化,其官網宣稱的優勢有多線程下10幾倍于log4j 1.x和logback的高吞吐量、可配置的審計型日志、基于插件架構的各種靈活配置等。如果已經掌握log4j 1.x,使用log4j2還是非常簡單的。
先看一個示例
1 基礎配置
普通Java項目手動添加jar包
[html] view plaincopy print?
log4j-api-2.5.jar??log4j-core-2.5.jar?? Maven項目pom.xml
[html] view plaincopy print?
<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>?? 測試代碼
[html] view plaincopy print?
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");??}?? 運行后輸出
[html] view plaincopy print?
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根目錄即可
[html] view plaincopy print?
<?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 ?輸出語句所在的行數, 包括類名、方法名、文件名、行數
最后是Logger的配置,這里只配置了一個Root Logger。
2 自定義Logger
首先修改測試代碼
[html] view plaincopy print?
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,所以執行結果相同。
下面修改配置文件
[html] view plaincopy print?
<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
[html] view plaincopy print?
<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中就很簡單了。
看下面的配置
[html] view plaincopy print?
<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分鐘來驗證結果
[java] view plaincopy print?
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項目中:
[java] view plaincopy print?
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中添加
[java] view plaincopy print?
<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的按級別輸出到不同文件的設置
轉載于:https://www.cnblogs.com/kabi/p/6693411.html
總結
以上是生活随笔為你收集整理的详解log4j2(上) - 从基础到实战的全部內容,希望文章能夠幫你解決所遇到的問題。
如果覺得生活随笔網站內容還不錯,歡迎將生活随笔推薦給好友。