使用log4j2的常用要点

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>

##日志配置

log4j2是使用log4j2.xml配置文件，区别于log4j，配置项也有一些变化。以下是一个最常用的控制台输出日志的配置：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
<Appenders>
	<Console name="Console" target="SYSTEM_OUT">
		<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
	</Console>
	
</Appenders>
<Loggers>
	<Root level="info">
		<AppenderRef ref="Console"/>
	</Root>
</Loggers>
</Configuration>

##兼容其他日志组件

一般常用的日志组件log4j(1.2.x),common-log(jcl),self4j,全部桥接，看着都累，但是很实用，把所有日志API都适配过来，全用log4j2处理。

依赖配置（详见 log4j2 maven-artifacts）如下：

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.7</version>
</dependency>

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.7</version>
</dependency>

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-1.2-api</artifactId>
    <version>2.7</version>
</dependency>

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-jcl</artifactId>
    <version>2.7</version>
</dependency>

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.7</version>
</dependency>

##配置变量支持很多上下文环境中的变量，详见 Log4j2 Lookups

比如：

环境变量是${xxx}，或者是${env:xxx}
系统参数（System Properties）是${sys:xxx}

可以在具体运用时通过环境变量或系统变量去控制日志输出的路径。比如，输出到tomcat/logs下可以这样：

${sys:catalina.base}/logs/xxx.log

因为tomcat启动脚本中加入了 -Dcatalina.base=...系统参数。

##日志输出模板

参见 Log4j2 PatternLayout

一般使用：

<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>

比较有意思的是%c{1.}这个会输出一个缩写的日志记录器名称：

org.apache.commons.Foo -> o.a.c.Foo

会节约不少空间。

##循环文件日志

这个在实际中经常用到，参见 RollingFileAppender

比如：

<RollingFile name="RollingFile"
	fileName="${sys:catalina.base}/logs/xxx.log"
	filePattern="${sys:catalina.base}/logs/xxx.%d{yyyy-MM-dd}-%i.log.gz">
	 <PatternLayout>
	     <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
	 </PatternLayout>
	 <Policies>
	     <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
	     <SizeBasedTriggeringPolicy size="200 MB"/>
	 </Policies>
</RollingFile>

这会每天切出带日期后缀的日志文件，且会根据体积200MB左右一个文件，最赞的是还用gz压缩了（注意使用.gz的后缀会自动压缩，若是.log则是原始文本）

来源：oschina

链接：https://my.oschina.net/u/159728/blog/795569

标签

log4j2