查看原文
其他

你还在用 Logback ?Log4j2 功能与异步性能已经无敌了,还不快试试?

Java精选 2022-08-09

>>号外:关注“Java精选”公众号,回复“2021面试题”关键词,领取全套500多份Java面试题文件。

Logback算术是JAVA里一个老牌的日志框架,从06年开始第一个版本,继承至今也十几年了。不过logback最近一个稳定版本还停留在2017年,好几年都没有更新;logback的兄弟slf4j最近一个稳定版也是2017年,有点凉凉的意思。

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

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

Log4j2简介

Apache Log4j 2是Log4j(1)的升级版,比它的祖先Log4j 1. x有很多的改进,和logback比较有很大的改进。除了内部设计的调整外,主要有以下几点的大升级:

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

Log 4j 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中的日志框架里,反向日志的性能是最高的,没有一个。

先来看一下,几种日志框架基准对比结果(log4j2官方测试结果):

从图上可以研磨,log4j2的异步(全初步,非混合模式)下的性能,远超log4j1和logback,简直吊打。测试下,log4j2的吞吐达到了180w + / s,而logback / log4j1只有不到20w,相差近十倍

零GC(无垃圾)

从2.6版本开始(2016年),log4j2默认就以零GC模式运行了。什么叫零GC呢?就是不会由于log4j2而导致GC。

log4j2中各种消息对象,字符串数组,字节数组等全部重复,不重复创建,大大减少了无用对象的创造,从而实现了“零GC”。

更高级I / O写入的支持

log4j还提供了一个MemoryMappedFileAppender,I / O部分使用MemoryMappedFile来实现,可以得到极高的I / O性能。

更强大的参数格式化

API模块和slf4j比例,提供了更丰富的参数格式化功能。

使用{}占位符格式化参数

在slf4j里,我们可以用{}的方式来实现“ format”的功能(参数会直接到String替换占位符),像下面这样:

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);

“惰性”打日志(懒记录)

这个功能虽然小,但非常实用。

在某些业务流程里,为了留根或引发问题,需要完整的打印入参,一般是把入参给用JSON / XML序列化后用debug等级打印:

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

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

我们期望的结果是信息等级下,连序列化都不执行。这里可以通过isDebugEnable来判断当前配置下的调试等级是否可以输出:

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和实现两部分,所以可能也需要和其他日志框架进行调整

其他的特点

  1. 初步量化使用高效能-** LMAX Disruptor **
  2. Appender丰富,有JMS / JPA / KAFKA / Http / MONGODB / CouchDB / Socket / Script等各种Appender的支持
  3. 支持自定义日志等级
  4. ……

基本用法

终于介绍完了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>

创建记录仪

直接使用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了!

作者:空无

juejin.cn/post/6945753017878577165

往期精选  点击标题可跳转

Spring Boot 项目不同环境打包配置与Shell脚本部署实践,太实用了!

Spring boot 项目中如何优雅停止服务的五种方法,值得收藏!

Java 中什么是 IO 流,字节流、字符流两者区别,缓冲流原理代码剖析

你可能忽视的 MyBatis 3.5.X 在 JDK8 中存在的性能问题

复盘 Spring boot 中定时任务如何启用异步线程池

Spring Boot 框架中使用自定义注解 + 拦截器实现身份证等敏感数据加解密

Java 中处理 Exception 的 9 种实践,曾被很多团队认可采纳,值得收藏!

Java 中 ThreadPoolExecutor 线程池必备知识点:工作流程、常见参数、性能调优及监控

Java 中统计代码执行耗时,列举 4 种优雅的解决方案

MySQL 分页使用 limit 和 offset 参数为什么会导致执行变慢?

全网可能是最全的 JAVA 日志框架适配、冲突解决方案

点个赞,就知道你“在看”!

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存