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),在你的启动脚本中减少一个零碎变量的配置:
text
-Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector
总结
Log4j2 现在性能最强,性能最强,而且继续更新保护。还在等什么?是时候替换你的 logback/log4j1 了!
作者:空无 https://juejin.cn/post/694575…