換掉Logback!Log4j2的異步性能已經無敵了,還不快試試
Logback 算是JAVA 里一個老牌的日志框架,從06年開始第一個版本,迭代至今也十幾年了。不過logback最近一個穩定版本還停留在 2017 年,好幾年都沒有更新;logback的兄弟 slf4j 最近一個穩定版也是2017年,有點涼涼的意思。
而且 logback的異步性能實在拉跨,功能簡陋,配置又繁瑣,遠不及Apache 的新一代日志框架 - Log4j2
目前來看,Log4j2 就是王者,其他日志框架都不是對手
Log4j2簡介
Apache Log4j 2是 Log4j(1) 的升級版,比它的祖先 Log4j 1. x 有了很大的改進,和logback對比有很大的改進。除了內部設計的調整外,主要有以下幾點的大升級:
- 更簡化的配置
- 更強大的參數格式化
- 最夸張的異步性能
Log4j 2中,分為**API(log4j-api)和實現(log4j-core)**兩個模塊。API 和slf4j 是一個類型,屬于日志抽象/門面,而實現部分,才是Log4j 2的核心。
- org.apache.logging.log4j » log4j-api
- org.apache.logging.log4j » log4j-core
最牛逼的性能
最強的異步性能
這個特性,算是Log4j2最強之處了。log4j2 在目前JAVA中的日志框架里,異步日志的性能是最高的,沒有之一。
先來看一下,幾種日志框架benchmark對比結果(log4j2官方測試結果):
從圖上可以看出,log4j2的異步(全異步,非混合模式)下的性能,遠超log4j1和logback,簡直吊打。壓力越大的情況下,吞吐上的差距就越大。在64線程測試下,log4j2的吞吐達到了180w+/s,而logback/log4j1只有不到20w,相差近十倍
零GC(Garbage-free)
從2.6版本開始(2016年),log4j2 默認就以零GC模式運行了。什么叫零GC呢?就是不會由于log4j2而導致GC。
log4j2 中各種Message對象,字符串數組,字節數組等全部復用,不重復創建,大大減少了無用對象的創建,從而做到“零GC”。
更高性能 I/O 寫入的支持
log4j 還提供了一個MemoryMappedFileAppender,I/O 部分使用MemoryMappedFile來實現,可以得到極高的I/O性能。不過在使用MemoryMappedFileAppender之前,得確定你足夠了解MemoryMappedFile的相關知識,否則不要輕易使用呦。
更強大的參數格式化
API模塊和slf4j相比,提供了更豐富的參數格式化功能。
使用{}占位符格式化參數
在slf4j里,我們可以用{}的方式來實現“format”的功能(參數會直接toString替換占位符),像下面這樣:
- logger.debug("Logging in user {} with birthday {}", user.getName(), user.getBirthdayCalendar());
- 復制代碼
使用String.format的形式格式化參數
log4j2 中除了支持{}的參數占位符,還支持String.format的形式:
- public static Logger logger = LogManager.getFormatterLogger("Foo");
- logger.debug("Logging in user %s with birthday %s", user.getName(), user.getBirthdayCalendar());
- logger.debug("Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar());
- logger.debug("Integer.MAX_VALUE = %,d", Integer.MAX_VALUE);
- logger.debug("Long.MAX_VALUE = %,d", Long.MAX_VALUE);
- 復制代碼
** 注意,如果想使用String.format的形式,需要使用LogManager.getFormatterLogger而不是LogManager.getLogger**
使用logger.printf格式化參數
log4j2 的 Logger接口中,還有一個printf方法,無需創建LogManager.getFormatterLogger,就可以使用String.format的形式
- logger.printf(Level.INFO, "Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar());
- logger.debug("Opening connection to {}...", someDataSource);
- 復制代碼
“惰性”打日志(lazy logging)
這個功能雖然小,但非常實用。
在某些業務流程里,為了留根或追溯問題,需要完整的打印入參,一般是把入參給用JSON/XML序列化后用debug級別打印:
- logger.debug("入參報文:{}",JSON.toJSONString(policyDTO));
- 復制代碼
如果需要追溯問題時,會將系統的日志級別調到debug/trace,這樣就可以打印。但是這里有個問題,雖然在info級別下debug不會輸出內容,但JSON.toJSONString()這個序列化的代碼一定會執行,嚴重影響正常流程下的執行效率。
我們期望的結果是info級別下,連序列化都不執行。這里可以通過isDebugEnable來判斷當前配置下debug級別是否可以輸出:
- if(logger.isDebugEnabled()){
- logger.debug("入參報文:{}",JSON.toJSONString(policyDTO));
- }
- 復制代碼
這樣雖然可以避免不必要的序列化,但每個地方都這么寫還是有點難受的,一行變成了三行。
- log4j2 的 logger 對象,提供了一系列lambda的支持,通過這些接口可以實現“惰性”打日志:
- void debug(String message, Supplier<?>... paramSuppliers);
- void info(String message, Supplier<?>... paramSuppliers);
- void trace(String message, Supplier<?>... paramSuppliers);
- void error(String message, Supplier<?>... paramSuppliers);
- //等同于下面的先判斷,后打印
- logger.debug("入參報文:{}",() -> JSON.toJSONString(policyDTO));
- if(logger.isDebugEnabled()){
- logger.debug("入參報文:{}",JSON.toJSONString(policyDTO));
- }
- 復制代碼
這種 Supplier + Lambda 的形式,等同于上面的先判斷 isDebugEnable 然后打印,三行的代碼變成了一行。嗯,真香。
更簡化的配置
Log4j 2 同時支持XML/JSON/YML/Properties 四種形式的配置文件,不過最主流的還是XML的方式,最直觀。
來看一下logback和log4j2的配置文件對比,同樣功能的配置下:
logback.xml
- <?xml version="1.0" encoding="UTF-8"?>
- <configuration>
- <appender name = "File" class= "ch.qos.logback.core.rolling.RollingFileAppender">
- <file>logs/app.log</file>
- <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
- <fileNamePattern>logs/archives/app-%d{yyyy-MM-dd}.log.gz</fileNamePattern>
- <!--一天內大于size就單獨分隔-->
- <maxFileSize>1 GB</maxFileSize>
- </rollingPolicy>
- </appender>
- <root level="info">
- <appender-ref ref="File"/>
- </root>
- </configuration>
- 復制代碼
log4j2.xml
- <?xml version="1.0" encoding="UTF-8"?>
- <Configuration xmlns:xi="http://www.w3.org/2001/XInclude"
- status="warn" name="XInclude">
- <Appenders>
- <RollingFile name="File" fileName="logs/app.log" filePattern="logs/archives/app-%d{yyyy-MM-dd}-%i.log.gz">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p [%t] %-40.40c{1.} : %m%n"/>
- <Policies>
- <TimeBasedTriggeringPolicy />
- <!--一天內大于size就單獨分隔-->
- <SizeBasedTriggeringPolicy size="1 GB"/>
- </Policies>
- </RollingFile>
- </Appenders>
- <Loggers>
- <Root level="INFO">
- <AppenderRef ref="File"/>
- </Root>
- </Loggers>
- </Configuration>
- 復制代碼
在log4j2中,appender的配置從使用 Appender 實現名即標簽名的形式,語法上更簡潔一些:
- <RollingFile name="File">
- <!-- 等同于logback中的 -->
- <appender name = "File" class= "ch.qos.logback.core.rolling.RollingFileAppender">
- 復制代碼
與其他日志抽象/門面適配
log4j2 由于拆分為 API 和 實現兩部分,所以可能也需要和其他日志框架進行適配
其他的特點
- 異步隊列使用高性能隊列 - **LMAX Disruptor **
- Appender豐富,有JMS/JPA/KAFKA/Http/MONGODB/CouchDB/Socket/Script等各種Appender的支持
- 支持自定義日志級別
- ……
基本用法
終于介紹完了Log4j2的強大,現在來介紹下Log4j2的基本使用。
引用log4j2的maven依賴
log4j-api在log4j-core中已經有依賴了,直接依賴core即可
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-core</artifactId>
- <version>2.14.1</version>
- </dependency>
- 復制代碼
注意,引用log4j2時,需要注意項目中是否有多套日志框架共存/沖突,需要適配的問題。細節請參考上面的與其他日志抽象/門面適配
配置文件示例
首先是配置文件,默認的配置文件路徑為:classpath:log4j2.xml(推薦使用xml)
- <?xml version="1.0" encoding="UTF-8"?>
- <Configuration xmlns:xi="http://www.w3.org/2001/XInclude"
- status="warn" name="XInclude">
- <Properties>
- <Property name="PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p [%t] %-40.40c{1.} : %m%n"/>
- </Properties>
- <Appenders>
- <!-- 輸出到控制臺,僅在本地開發環境使用 -->
- <Console name="Console" target="SYSTEM_OUT">
- <PatternLayout pattern="${PATTERN}"/>
- </Console>
- <!--輸出到日志文件,滾動分割日志文件,自動打包gz-->
- <RollingFile name="File" fileName="logs/app.log" filePattern="logs/archives/app-%d{yyyy-MM-dd}-%i.log.gz">
- <PatternLayout pattern="${PATTERN}"/>
- <Policies>
- <!--默認一天一個文件-->
- <TimeBasedTriggeringPolicy />
- <!--一天內大于size就單獨分隔-->
- <SizeBasedTriggeringPolicy size="1 GB"/>
- </Policies>
- </RollingFile>
- </Appenders>
- <Loggers>
- <!-- 添加你的自定義logger,一般用于區分包名的日志,不同包名不同的級別/appender -->
- <!-- additivity 意思是,調用完當前appender,是否繼續調用parent logger appender,默認true-->
- <Logger name="your logger/package name" level="debug" additivity="false"/>
- <!--默認的Root Logger 級別-->
- <Root level="INFO">
- <!--這里需要區分下環境(配合maven profile之類的)-->
- <!-- 開發環境使用Console Appender,生產環境使用File Appender -->
- <AppenderRef ref="Console"/>
- <AppenderRef ref="File"/>
- </Root>
- </Loggers>
- </Configuration>
- 復制代碼
XML配置文件語法
- <?xml version="1.0" encoding="UTF-8"?>;
- <Configuration>
- <Properties>
- <Property name="name1">value</property>
- <Property name="name2" value="value2"/>
- </Properties>
- <filter ... />
- <Appenders>
- <appender ... >
- <filter ... />
- </appender>
- ...
- </Appenders>
- <Loggers>
- <Logger name="name1">
- <filter ... />
- </Logger>
- ...
- <Root level="level">
- <AppenderRef ref="name"/>
- </Root>
- </Loggers>
- </Configuration>
- 復制代碼
創建Logger
直接使用log4j2的api:
- import org.apache.logging.log4j.LogManager;
- import org.apache.logging.log4j.Logger;
- Logger logger = LogManager.getLogger(Log4j2Test.class);
- logger.error(...);
- logger.warn(...);
- logger.info(...);
- logger.debug(...);
- logger.trace(...);
- 復制代碼
如果是配合slf4j使用也是可以的,只需要按照前面說的,提前做好適配,然后使用slf4j的api即可。不過如果是新系統的話,建議直接上log4j2的api吧,可以享受所有log4j2的功能,使用slf4j之類的api時,上面說的參數格式化之類的功能就無法使用了。
全異步配置(重要!!)
推薦配置log4j2 全異步(all async),在你的啟動腳本中增加一個系統變量的配置:
- -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector
- 復制代碼
總結
Log4j2 如今性能最強,功能最強,而且持續更新維護。還在等什么?是時候替換你的logback/log4j1了!