Java日志框架中的王者是谁

来源丨juejin.cn/post/6945753017878577165

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

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

目前来看，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中的日志框架里，异步日志的性能是最高的，没有之一。

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("Logginginuser{}withbirthday{}",user.getName(),user.getBirthdayCalendar());

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

log4j2 中除了支持{}的参数占位符，还支持String.format的形式：

publicstaticLoggerlogger=LogManager.getFormatterLogger("Foo");

logger.debug("Logginginuser%swithbirthday%s",user.getName(),user.getBirthdayCalendar());
logger.debug("Logginginuser%1$swithbirthday%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,"Logginginuser%1$swithbirthday%2$tm%2$te,%2$tY",user.getName(),user.getBirthdayCalendar());

logger.debug("Openingconnectionto{}...",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的支持，通过这些接口可以实现“惰性”打日志：

voiddebug(Stringmessage,Supplier...paramSuppliers);
voidinfo(Stringmessage,Supplier...paramSuppliers);
voidtrace(Stringmessage,Supplier...paramSuppliers);
voiderror(Stringmessage,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

<configuration>
<appendername="File"class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/app.logfile>
<rollingPolicyclass="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logs/archives/app-%d{yyyy-MM-dd}.log.gzfileNamePattern>

<maxFileSize>1GBmaxFileSize>
rollingPolicy>
appender>
<rootlevel="info">
<appender-refref="File"/>
root>
configuration>

log4j2.xml

<Configurationxmlns:xi="http://www.w3.org/2001/XInclude"
status="warn"name="XInclude">
<Appenders>
<RollingFilename="File"fileName="logs/app.log"filePattern="logs/archives/app-%d{yyyy-MM-dd}-%i.log.gz">
<PatternLayoutpattern="%d{yyyy-MM-ddHHss.SSS}%5p[%t]%-40.40c{1.}:%m%n"/>
<Policies>
<TimeBasedTriggeringPolicy/>

<SizeBasedTriggeringPolicysize="1GB"/>
Policies>
RollingFile>
Appenders>
<Loggers>
<Rootlevel="INFO">
<AppenderRefref="File"/>
Root>
Loggers>
Configuration>

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

<RollingFilename="File">

<appendername="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.log4jgroupId>
<artifactId>log4j-coreartifactId>
<version>2.14.1version>
dependency>

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

配置文件示例

首先是配置文件，默认的配置文件路径为：classpath:log4j2.xml（推荐使用xml）

<Configurationxmlns:xi="http://www.w3.org/2001/XInclude"
status="warn"name="XInclude">
<Properties>
<Propertyname="PATTERN"value="%d{yyyy-MM-ddHHss.SSS}%5p[%t]%-40.40c{1.}:%m%n"/>
Properties>
<Appenders>

<Consolename="Console"target="SYSTEM_OUT">
<PatternLayoutpattern="${PATTERN}"/>
Console>

<RollingFilename="File"fileName="logs/app.log"filePattern="logs/archives/app-%d{yyyy-MM-dd}-%i.log.gz">
<PatternLayoutpattern="${PATTERN}"/>
<Policies>

<TimeBasedTriggeringPolicy/>

<SizeBasedTriggeringPolicysize="1GB"/>
Policies>
RollingFile>
Appenders>
<Loggers>


<Loggername="yourlogger/packagename"level="debug"additivity="false"/>

<Rootlevel="INFO">


<AppenderRefref="Console"/>
<AppenderRefref="File"/>
Root>
Loggers>
Configuration>

XML配置文件语法

;
<Configuration>
<Properties>
<Propertyname="name1">valueproperty>
<Propertyname="name2"value="value2"/>
Properties>
<filter.../>
<Appenders>
<appender...>
<filter.../>
appender>
...
Appenders>
<Loggers>
<Loggername="name1">
<filter.../>
Logger>
...
<Rootlevel="level">
<AppenderRefref="name"/>
Root>
Loggers>
Configuration>

创建Logger

直接使用log4j2的api：

importorg.apache.logging.log4j.LogManager;
importorg.apache.logging.log4j.Logger;

Loggerlogger=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了！

责任编辑：haq