log4j2的详细使用及问题解决[总结]

log4j2相对于log4j 1.x有了脱胎换骨的变化，其官网宣称的优势有多线程下10几倍于log4j 1.x和logback的高吞吐量、可配置的审计型日志、基于插件架构的各种灵活配置等。如果已经掌握log4j 1.x，使用log4j2还是非常简单的。

先看一个示例

1 基础配置

普通Java项目手动添加jar包

问题：

纠正一下：本人亲自在搭建项目的时候，发现如果项目中只有这两个jar，是显示不正常的，需要加上log4j2的实现

另外一个比较重要的地方就是，有些日志无法使用log4j2完全接管整个系统的日志，可能是由于其他的依赖包依赖带着log4j的包，导致会出现下面的现象：

log4j:WARN No appenders could be found for logger (org.springframework.web.context.ContextLoader).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.

解决方法是：将log4j 1.x给排除掉，使用

<exclusion>
<artifactId>log4j</artifactId>
<groupId>log4j</groupId>
</exclusion>

[html] view plain copy

 print?

1. 纠正前
2. log4j-api-2.5.jar  
3. log4j-core-2.5.jar
4. 纠正后
5. <dependency>
   <groupId>org.apache.logging.log4j</groupId>  -->添加后也支持log4j以前的使用方式
   <artifactId>log4j-slf4j-impl</artifactId>
   </dependency>
   <dependency>
   <groupId>org.apache.logging.log4j</groupId>
   <artifactId>log4j-api</artifactId>
   </dependency>
   <dependency>
   <groupId>org.apache.logging.log4j</groupId>
   <artifactId>log4j-core</artifactId>
   </dependency>
   
6. 纠正后支持的使用方式有：
7.  Logger logger = LogManager.getLogger(LogManager.ROOT_LOGGER_NAME);  log4j2的专属方式
   
8. Logger logger = LoggerFactory.getLogger(EchoFilter.class);      log4j的使用方式

Maven项目pom.xml

[html] view plain copy

 print?

1. <dependencies>  
2.     <dependency>  
3.         <groupId>org.apache.logging.log4j</groupId>  
4.         <artifactId>log4j-api</artifactId>  
5.         <version>2.5</version>  
6.     </dependency>  
7.     <dependency>  
8.         <groupId>org.apache.logging.log4j</groupId>  
9.         <artifactId>log4j-core</artifactId>  
10.         <version>2.5</version>  
11.     </dependency>  
12. </dependencies>  

测试代码

[html] view plain copy

 print?

1. public static void main(String[] args) {  
2.     Logger logger = LogManager.getLogger(LogManager.ROOT_LOGGER_NAME);  
3.     logger.trace("trace level");  
4.     logger.debug("debug level");  
5.     logger.info("info level");  
6.     logger.warn("warn level");  
7.     logger.error("error level");  
8.     logger.fatal("fatal level");  
9. }  

运行后输出

[html] view plain copy

 print?

1. ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console.  
2. 20:37:11.965 [main] ERROR  - error level  
3. 20:37:11.965 [main] FATAL  - fatal level  

可以看到log4j2先发了一句牢骚，抱怨没有找到配置文件什么的，不过还是输出了error和fatal两个级别的信息。

log4j2默认会在classpath目录下寻找log4j.json、log4j.jsn、log4j2.xml等名称的文件，如果都没有找到，则会按默认配置输出，也就是输出到控制台。

下面我们按默认配置添加一个log4j2.xml，添加到src根目录即可

[html] view plain copy

 print?

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <Configuration status="WARN">  
3.     <Appenders>  
4.         <Console name="Console" target="SYSTEM_OUT">  
5.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
6.         </Console>  
7.     </Appenders>  
8.     <Loggers>  
9.         <Root level="error">  
10.             <AppenderRef ref="Console" />  
11.         </Root>  
12.     </Loggers>  
13. </Configuration>  

重新执行测试代码，可以看到输出结果相同，但是没有再提示找不到配置文件。
来看我们添加的配置文件log4j2.xml，以Configuration为根节点，有一个status属性，这个属性表示log4j2本身的日志信息打印级别。如果把status改为TRACE再执行测试代码，可以看到控制台中打印了一些log4j加载插件、组装logger等调试信息。

日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出。对于Loggers中level的定义同样适用。

下面是Appender配置，Appender可以理解为日志的输出目的地，这里配置了一个类型为Console的Appender，也就是输出到控制台。Console节点中的PatternLayout定义了输出日志时的格式：

%d{HH:mm:ss.SSS} 表示输出到毫秒的时间

%t 输出当前线程名称

%-5level 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0

%logger 输出logger名称，因为Root Logger没有名称，所以没有输出

%msg 日志文本

%n 换行

其他常用的占位符有：

%F 输出所在的类文件名，如Client.java

%L 输出行号

%M 输出所在方法名

%l  输出语句所在的行数, 包括类名、方法名、文件名、行数

最后是Logger的配置，这里只配置了一个Root Logger。

2 自定义Logger

首先修改测试代码

[html] view plain copy

 print?

1. public static void main(String[] args) {  
2.     Logger logger = LogManager.getLogger("mylog");  
3.     logger.trace("trace level");  
4.     logger.debug("debug level");  
5.     logger.info("info level");  
6.     logger.warn("warn level");  
7.     logger.error("error level");  
8.     logger.fatal("fatal level");  
9. }  

logger从获取Root Logger改为尝试获得一个名称为mylog的Logger，在配置文件中一无所得后，又找到了Root Logger，所以执行结果相同。

下面修改配置文件

[html] view plain copy

 print?

1. <Configuration status="WARN" monitorInterval="300">  
2.     <Appenders>  
3.         <Console name="Console" target="SYSTEM_OUT">  
4.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
5.         </Console>  
6.     </Appenders>  
7.     <Loggers>  
8.         <Logger name="mylog" level="trace" additivity="false">  
9.         <AppenderRef ref="Console" />  
10.     </Logger>  
11.         <Root level="error">  
12.             <AppenderRef ref="Console" />  
13.         </Root>  
14.     </Loggers>  
15. </Configuration>  

再次执行测试代码，这一次log4j2很高兴的找到了名称为mylog的配置，于是使用新配置把level改为trace，全部的信息都输出了。

additivity="false"表示在该logger中输出的日志不会再延伸到父层logger。这里如果改为true，则会延伸到Root Logger，遵循Root Logger的配置也输出一次。

注意根节点增加了一个monitorInterval属性，含义是每隔300秒重新读取配置文件，可以不重启应用的情况下修改配置，还是很好用的功能。

3 自定义Appender

修改配置文件，添加一个文件类型的Appender，并且把mylog的AppenderRef改为新加的Appender

[html] view plain copy

 print?

1. <Configuration status="WARN" monitorInterval="300">  
2.     <Appenders>  
3.         <Console name="Console" target="SYSTEM_OUT">  
4.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
5.         </Console>  
6.         <File name="MyFile" fileName="D:/logs/app.log">  
7.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
8.         </File>  
9.     </Appenders>  
10.     <Loggers>  
11.         <Logger name="mylog" level="trace" additivity="true">  
12.             <AppenderRef ref="MyFile" />  
13.         </Logger>  
14.         <Root level="error">  
15.             <AppenderRef ref="Console" />  
16.         </Root>  
17.     </Loggers>  
18. </Configuration>  

执行并查看控制台和D:/logs/app.log的输出结果

4 实用型配置

下面配置一个按时间和文件大小滚动的RollingRandomAccessFile Appender，名字真是够长，但不光只是名字长，相比RollingFileAppender有很大的性能提升，官网宣称是20-200%。

Rolling的意思是当满足一定条件后，就重命名原日志文件用于备份，并从新生成一个新的日志文件。例如需求是每天生成一个日志文件，但是如果一天内的日志文件体积已经超过1G，就从新生成，两个条件满足一个即可。这在log4j 1.x原生功能中无法实现，在log4j2中就很简单了。

看下面的配置

[html] view plain copy

 print?

1. <Configuration status="WARN" monitorInterval="300">  
2.     <properties>  
3.         <property name="LOG_HOME">D:/logs</property>  
4.         <property name="FILE_NAME">mylog</property>  
5.     </properties>  
6.     <Appenders>  
7.         <Console name="Console" target="SYSTEM_OUT">  
8.             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
9.         </Console>  
10.         <RollingRandomAccessFile name="MyFile"  
11.             fileName="${LOG_HOME}/${FILE_NAME}.log"  
12.             filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">  
13.             <PatternLayout  
14.                 pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />  
15.             <Policies>  
16.                 <TimeBasedTriggeringPolicy interval="1" />  
17.                 <SizeBasedTriggeringPolicy size="10 MB" />  
18.             </Policies>  
19.             <DefaultRolloverStrategy max="20" />  
20.         </RollingRandomAccessFile>  
21.     </Appenders>  
22.   
23.     <Loggers>  
24.         <Logger name="mylog" level="trace" additivity="false">  
25.             <AppenderRef ref="MyFile" />  
26.         </Logger>  
27.         <Root level="error">  
28.             <AppenderRef ref="Console" />  
29.         </Root>  
30.     </Loggers>  
31. </Configuration>  

<properties>定义了两个常量方便后面复用

RollingRandomAccessFile的属性：

fileName  指定当前日志文件的位置和文件名称

filePattern  指定当发生Rolling时，文件的转移和重命名规则

SizeBasedTriggeringPolicy  指定当文件体积大于size指定的值时，触发Rolling

DefaultRolloverStrategy  指定最多保存的文件个数

TimeBasedTriggeringPolicy  这个配置需要和filePattern结合使用，注意filePattern中配置的文件重命名规则是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i，最小的时间粒度是mm，即分钟，TimeBasedTriggeringPolicy指定的size是1，结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH}，最小粒度为小时，则每一个小时生成一个文件。

修改测试代码，模拟文件体积超过10M和时间超过1分钟来验证结果

[java] view plain copy

 print?

1. public static void main(String[] args) {  
2.     Logger logger = LogManager.getLogger("mylog");  
3.     for(int i = 0; i < 50000; i++) {  
4.         logger.trace("trace level");  
5.         logger.debug("debug level");  
6.         logger.info("info level");  
7.         logger.warn("warn level");  
8.         logger.error("error level");  
9.         logger.fatal("fatal level");  
10.     }  
11.     try {  
12.         Thread.sleep(1000 * 61);  
13.     } catch (InterruptedException e) {}  
14.     logger.trace("trace level");  
15.     logger.debug("debug level");  
16.     logger.info("info level");  
17.     logger.warn("warn level");  
18.     logger.error("error level");  
19.     logger.fatal("fatal level");  
20. }  

5 自定义配置文件位置

log4j2默认在classpath下查找配置文件，可以修改配置文件的位置。在非web项目中：

[java] view plain copy

 print?

1. public static void main(String[] args) throws IOException {  
2.     File file = new File("D:/log4j2.xml");  
3.     BufferedInputStream in = new BufferedInputStream(new FileInputStream(file));  
4.     final ConfigurationSource source = new ConfigurationSource(in);  
5.     Configurator.initialize(null, source);  
6.       
7.     Logger logger = LogManager.getLogger("mylog");  
8. }  

如果是web项目，在web.xml中添加

[java] view plain copy

 print?

1. <context-param>  
2.     <param-name>log4jConfiguration</param-name>  
3.     <param-value>/WEB-INF/conf/log4j2.xml</param-value>  
4. </context-param>  
5.   
6. <listener>  
7.     <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>  
8. </listener>  

掌握这些基本可以实际使用了，下篇介绍一些高级应用，异步Appender、MongoDB Appender和基于Filters的按级别输出到不同文件的设置

补充：

log4j是apache的一个开源项目，在写这篇博客的时候已经发布了2.0的beta版本，首先需要注意的是，log4j 2.0与以往的1.x有一个明显的不同，其配置文件只能采用.xml, .json或者 .jsn。在默认情况下，系统选择configuration文件的优先级如下：（classpath为scr文件夹）

1. classpath下名为 log4j-test.json 或者log4j-test.jsn文件
2. classpath下名为 log4j2-test.xml
3. classpath下名为 log4j.json 或者log4j.jsn文件
   
4. classpath下名为 log4j2.xml

        必须注意.xml 文件的文件名为log4j2，这里让我纠结了一个下午，系统一直找不到配置文件，最后发现是文件名里面少了一个2。下面以log4j2.xml为例来介绍log4j的配置

1. <Filters>  
2.     <ThresholdFilter level="TRACE" onMatch="NEUTRAL" onMismatch="DENY"/>  
3.     <RegexFilter regex=".* test .*" onMatch="NEUTRAL" onMismatch="DENY"/>  
4.            <TimeFilter start="05:00:00" end="05:30:00" onMatch=" NEUTRAL " onMismatch="DENY"/>          
5. </Filters>  

<Filters>是组合过滤器额标签，它包含的子标签是具体的过滤器，这三个具体过滤器分别是日志等级过滤器，正则表达式过滤器和时间过滤器。

需要说明的是onMatch和onMismatch可以选择的值及其含义。可选的值分别是，ACCEPT, DENY, NEUTRAL，ACCEP和DENY比较好理解就是接受和拒绝的意思，在使用单个过滤器的时候，一般就是使用这两个值。但是在组合过滤器中，如果用接受ACCEPT的话，日志信息就会直接写入日志文件,后续的过滤器不再进行过滤。所以，在组合过滤器中，接受使用NEUTRAL（中立），被第一个过滤器接受的日志信息，会继续用后面的过滤器进行过滤，只有符合所有过滤器条件的日志信息，才会被最终写入日志文件。

一张比较好理解的log4j架构图