|
|
|
|
公众号矩阵

换掉Java的老牌日志框架Logback,我用Log4j2!

Logback 算是 Java 里一个老牌的日志框架,从 2006 年开始第一个版本,迭代至今也十几年了。

作者:空无来源:51CTO技术栈|2021-04-02 07:58

Logback 算是 Java 里一个老牌的日志框架,从 2006 年开始第一个版本,迭代至今也十几年了。

图片来自 Pexels

不过 Logback 最近一个稳定版本还停留在 2017 年,好几年都没有更新;Logback 的兄弟 slf4j 最近一个稳定版也是 2017 年,有点凉凉的意思。

而且 Logback 的异步性能实在拉跨,功能简陋,配置又繁琐,远不及 Apache 的新一代日志框架:Log4j2。

目前来看,Log4j2 就是王者,其他日志框架都不是对手!

Log4j2 简介

Apache Log4j2 是 Log4j(1)的升级版,比它的祖先 Log4j 1.x 有了很大的改进,和 Logback 对比有很大的改进。

除了内部设计的调整外,主要有以下几点的大升级:

  • 更简化的配置
  • 更强大的参数格式化
  • 最夸张的异步性能

Log4j2 中,分为 **API(log4j-api)和实现 (log4j-core)** 两个模块。API 和 slf4j 是一个类型,属于日志抽象/门面。

而实现部分,才是 Log4j2 的核心:

  • 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 替换占位符)。

像下面这样:

  1. logger.debug("Logging in user {} with birthday {}", user.getName(), user.getBirthdayCalendar()); 

②使用 String.format 的形式格式化参数

Log4j2 中除了支持 {} 的参数占位符,还支持 String.format 的形式:

  1. public static Logger logger = LogManager.getFormatterLogger("Foo"); 
  2.  
  3. logger.debug("Logging in user %s with birthday %s", user.getName(), user.getBirthdayCalendar()); 
  4. logger.debug("Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar()); 
  5. logger.debug("Integer.MAX_VALUE = %,d", Integer.MAX_VALUE); 
  6. logger.debug("Long.MAX_VALUE = %,d", Long.MAX_VALUE); 

注意:如果想使用 String.format 的形式,需要使用 LogManager.getFormatterLogger 而不是 LogManager.getLogger。

③使用 logger.printf 格式化参数

Log4j2 的 Logger 接口中,还有一个 printf 方法,无需创建 LogManager.getFormatterLogger,就可以使用 String.format 的形式:

  1. logger.printf(Level.INFO, "Logging in user %1$s with birthday %2$tm %2$te,%2$tY", user.getName(), user.getBirthdayCalendar()); 
  2.  
  3. logger.debug("Opening connection to {}...", someDataSource); 

④“惰性”打日志(lazy logging)

这个功能虽然小,但非常实用。在某些业务流程里,为了留根或追溯问题,需要完整的打印入参。

一般是把入参给用 JSON/XML 序列化后用 debug 级别打印:

  1. logger.debug("入参报文:{}",JSON.toJSONString(policyDTO)); 

如果需要追溯问题时,会将系统的日志级别调到 debug/trace,这样就可以打印。

但是这里有个问题,虽然在 info 级别下 debug 不会输出内容,但 JSON.toJSONString() 这个序列化的代码一定会执行,严重影响正常流程下的执行效率。

我们期望的结果是 info 级别下,连序列化都不执行。

这里可以通过 isDebugEnable 来判断当前配置下 debug 级别是否可以输出:

  1. if(logger.isDebugEnabled()){ 
  2.     logger.debug("入参报文:{}",JSON.toJSONString(policyDTO)); 

这样虽然可以避免不必要的序列化,但每个地方都这么写还是有点难受的,一行变成了三行。

Log4j2 的 logger 对象,提供了一系列 Lambda 的支持,通过这些接口可以实现“惰性”打日志:

  1. void debug(String message, Supplier<?>... paramSuppliers); 
  2. void info(String message, Supplier<?>... paramSuppliers); 
  3. void trace(String message, Supplier<?>... paramSuppliers); 
  4. void error(String message, Supplier<?>... paramSuppliers); 
  5.  
  6. //等同于下面的先判断,后打印 
  7. logger.debug("入参报文:{}",() -> JSON.toJSONString(policyDTO)); 
  8.  
  9. if(logger.isDebugEnabled()){ 
  10.     logger.debug("入参报文:{}",JSON.toJSONString(policyDTO)); 

这种 Supplier+Lambda 的形式,等同于上面的先判断 isDebugEnable 然后打印,三行的代码变成了一行。嗯,真香。

更简化的配置

Log4j2 同时支持 XML/JSON/YML/Properties 四种形式的配置文件,不过最主流的还是 XML 的方式,最直观。

来看一下 Logback 和 Log4j2 的配置文件对比,同样功能的配置下。

logback.xml:

  1. <?xml version="1.0" encoding="UTF-8"?> 
  2. <configuration> 
  3.     <appender name = "File" class"ch.qos.logback.core.rolling.RollingFileAppender"> 
  4.         <file>logs/app.log</file> 
  5.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
  6.             <fileNamePattern>logs/archives/app-%d{yyyy-MM-dd}.log.gz</fileNamePattern> 
  7.                         <!--一天内大于size就单独分隔--> 
  8.               <maxFileSize>1 GB</maxFileSize> 
  9.         </rollingPolicy> 
  10.     </appender> 
  11.     <root level="info"> 
  12.       <appender-ref ref="File"/> 
  13.     </root> 
  14. </configuration> 

log4j2.xml:

  1. <?xml version="1.0" encoding="UTF-8"?> 
  2. <Configuration xmlns:xi="http://www.w3.org/2001/XInclude" 
  3.                status="warn" name="XInclude"> 
  4.     <Appenders> 
  5.           <RollingFile name="File" fileName="logs/app.log" filePattern="logs/archives/app-%d{yyyy-MM-dd}-%i.log.gz"> 
  6.               <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p [%t] %-40.40c{1.} : %m%n"/> 
  7.               <Policies> 
  8.                   <TimeBasedTriggeringPolicy /> 
  9.                   <!--一天内大于size就单独分隔--> 
  10.                   <SizeBasedTriggeringPolicy size="1 GB"/> 
  11.               </Policies> 
  12.           </RollingFile> 
  13.     </Appenders> 
  14.     <Loggers> 
  15.         <Root level="INFO"> 
  16.             <AppenderRef ref="File"/> 
  17.         </Root> 
  18.     </Loggers> 
  19. </Configuration> 

在 log4j2 中,appender 的配置从使用 Appender 实现名即标签名的形式,语法上更简洁一些:

  1. <RollingFile name="File"> 
  2.   <!-- 等同于logback中的 --> 
  3. <appender name = "File" class"ch.qos.logback.core.rolling.RollingFileAppender"> 

与其他日志抽象/门面适配

Log4j2 由于拆分为 API 和实现两部分,所以可能也需要和其他日志框架进行适配。

详细的日志框架适配方案请参考我的另一篇文章《【可能是全网最全的】JAVA日志框架适配/冲突解决方案》:

https://juejin.cn/post/6945220055399399455

其他的特点

如下:

  • 异步队列使用高性能队列 - **LMAX Disruptor **
  • Appender 丰富,有 JMS/JPA/KAFKA/Http/MONGODB/CouchDB/Socket/Script 等各种 Appender 的支持
  • 支持自定义日志级别
  • ……

基本用法

终于介绍完了 Log4j2 的强大,现在来介绍下 Log4j2 的基本使用。

①引用 Log4j2 的 Maven 依赖

log4j-api 在 log4j-core 中已经有依赖了,直接依赖 core 即可:

  1. <dependency> 
  2.     <groupId>org.apache.logging.log4j</groupId> 
  3.     <artifactId>log4j-core</artifactId> 
  4.     <version>2.14.1</version> 
  5. </dependency> 

注意,引用 Log4j2 时,需要注意项目中是否有多套日志框架共存/冲突,需要适配的问题。细节请参考上面的与其他日志抽象/门面适配。

②配置文件示例

首先是配置文件,默认的配置文件路径为:classpath:log4j2.xml(推荐使用 xml):

  1. <?xml version="1.0" encoding="UTF-8"?> 
  2. <Configuration xmlns:xi="http://www.w3.org/2001/XInclude" 
  3.                status="warn" name="XInclude"> 
  4.     <Properties> 
  5.       <Property name="PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p [%t] %-40.40c{1.} : %m%n"/> 
  6.     </Properties> 
  7.     <Appenders> 
  8.               <!-- 输出到控制台,仅在本地开发环境使用 --> 
  9.           <Console name="Console" target="SYSTEM_OUT"> 
  10.             <PatternLayout pattern="${PATTERN}"/> 
  11.           </Console> 
  12.             <!--输出到日志文件,滚动分割日志文件,自动打包gz--> 
  13.           <RollingFile name="File" fileName="logs/app.log" filePattern="logs/archives/app-%d{yyyy-MM-dd}-%i.log.gz"> 
  14.               <PatternLayout pattern="${PATTERN}"/> 
  15.               <Policies> 
  16.                     <!--默认一天一个文件--> 
  17.                   <TimeBasedTriggeringPolicy /> 
  18.                   <!--一天内大于size就单独分隔--> 
  19.                   <SizeBasedTriggeringPolicy size="1 GB"/> 
  20.               </Policies> 
  21.           </RollingFile> 
  22.     </Appenders> 
  23.     <Loggers> 
  24.           <!-- 添加你的自定义logger,一般用于区分包名的日志,不同包名不同的级别/appender --> 
  25.           <!-- additivity 意思是,调用完当前appender,是否继续调用parent logger appender,默认true--> 
  26.           <Logger name="your logger/package name" level="debug" additivity="false"/> 
  27.           <!--默认的Root Logger 级别--> 
  28.         <Root level="INFO"> 
  29.               <!--这里需要区分下环境(配合maven profile之类的)--> 
  30.               <!-- 开发环境使用Console Appender,生产环境使用File Appender --> 
  31.             <AppenderRef ref="Console"/> 
  32.               <AppenderRef ref="File"/> 
  33.         </Root> 
  34.     </Loggers> 
  35. </Configuration> 

③XML 配置文件语法

如下:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Configuration> 
  3.   <Properties> 
  4.     <Property name="name1">value</property> 
  5.     <Property name="name2" value="value2"/> 
  6.   </Properties> 
  7.   <filter  ... /> 
  8.   <Appenders> 
  9.     <appender ... > 
  10.       <filter  ... /> 
  11.     </appender> 
  12.     ... 
  13.   </Appenders> 
  14.   <Loggers> 
  15.     <Logger name="name1"> 
  16.       <filter  ... /> 
  17.     </Logger> 
  18.     ... 
  19.     <Root level="level"> 
  20.       <AppenderRef ref="name"/> 
  21.     </Root> 
  22.   </Loggers> 
  23. </Configuration> 

④创建 Logger

直接使用 Log4j2 的 API:

  1. import org.apache.logging.log4j.LogManager; 
  2. import org.apache.logging.log4j.Logger; 
  3.  
  4. Logger logger = LogManager.getLogger(Log4j2Test.class); 
  5. logger.error(...); 
  6. logger.warn(...); 
  7. logger.info(...); 
  8. logger.debug(...); 
  9. logger.trace(...); 

如果是配合 slf4j 使用也是可以的,只需要按照前面说的,提前做好适配,然后使用 slf4j 的 API 即可。

不过如果是新系统的话,建议直接上 Log4j2 的 API 吧,可以享受所有 Log4j2 的功能,使用 slf4j 之类的 API 时,上面说的参数格式化之类的功能就无法使用了。

⑤全异步配置(重要!!)

推荐配置 Log4j2 全异步(all async),在你的启动脚本中增加一个系统变量的配置:

  1. -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector 

总结

Log4j2 如今性能最强,功能最强,而且持续更新维护。还在等什么?是时候替换你的 Logback/Log4j1 了!

作者:空无

编辑:陶家龙

征稿:有投稿、寻求报道意向技术人请添加小编微信 gordonlonglong

【编辑推荐】

  1. MiniDao1.7.1 版本发布,轻量级Java持久化框架
  2. Java基础与框架全套视频第一部
  3. PHP面向对象基础知识和面向对象框架ThinkPHP框架及项目实战
  4. Hibernate 4.0 之多面学习Hibernate ORM框架视频课程
  5. Go语言web开发iris框架课程
【责任编辑:赵宁宁 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

订阅专栏+更多

数据湖与数据仓库的分析实践攻略

数据湖与数据仓库的分析实践攻略

助力现代化数据管理:数据湖与数据仓库的分析实践攻略
共3章 | 创世达人

7人订阅学习

云原生架构实践

云原生架构实践

新技术引领移动互联网进入急速赛道
共3章 | KaliArch

36人订阅学习

数据中心和VPDN网络建设案例

数据中心和VPDN网络建设案例

漫画+案例
共20章 | 捷哥CCIE

230人订阅学习

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊

51CTO服务号

51CTO官微