使用slf4j + Log4j2构建日志

http://blog.csdn.net/heyutao007/article/details/50371668

一、背景

Log4j 1.x 在高并发情况下出现死锁导致cpu使用率异常飙升，而Log4j2.0基于LMAX Disruptor的异步日志在多线程环境下性能会远远优于Log4j 1.x和logback（官方数据是10倍以上），这里分享slf4j + Log4j2的使用方法。

二、步骤

1、pom.xml

删除以往依赖Log4j1.x的依赖项，比如slf4j-log4j12、log4j等包。
可以到项目的根目录，执行：mvn dependency:tree > tree.log  ，查看之后 cat tree.log | grep log4j查找。

[html]  view plain  copy

1. <exclusions>  
2.         <exclusion>  
3.             <groupId>org.slf4j</groupId>  
4.             <artifactId>slf4j-log4j12</artifactId>  
5.         </exclusion>  
6.         <exclusion>  
7.             <groupId>log4j</groupId>  
8.             <artifactId>log4j</artifactId>  
9.         </exclusion>  
10.     </exclusions>  

然后在工程的pom.xml新增以下log4j2的依赖关系：
 

[html]  view plain  copy

1. <!-- Logging use log4j2-->  
2.         <dependency>  
3.             <groupId>org.slf4j</groupId>  
4.             <artifactId>slf4j-api</artifactId>  
5.             <version>1.7.13</version>  
6.         </dependency>  
7.         <dependency>  
8.             <groupId>org.slf4j</groupId>  
9.             <artifactId>jcl-over-slf4j</artifactId>  
10.             <version>1.7.13</version>  
11.             <scope>runtime</scope>  
12.         </dependency>  
13.   
14.         <!--核心log4j2jar包-->  
15.         <dependency>  
16.             <groupId>org.apache.logging.log4j</groupId>  
17.             <artifactId>log4j-api</artifactId>  
18.             <version>2.4.1</version>  
19.         </dependency>  
20.         <dependency>  
21.             <groupId>org.apache.logging.log4j</groupId>  
22.             <artifactId>log4j-core</artifactId>  
23.             <version>2.4.1</version>  
24.         </dependency>  
25.         <!--用于与slf4j保持桥接-->  
26.         <dependency>  
27.             <groupId>org.apache.logging.log4j</groupId>  
28.             <artifactId>log4j-slf4j-impl</artifactId>  
29.             <version>2.4.1</version>  
30.         </dependency>  
31.         <!--web工程需要包含log4j-web，非web工程不需要-->  
32.         <dependency>  
33.             <groupId>org.apache.logging.log4j</groupId>  
34.             <artifactId>log4j-web</artifactId>  
35.             <version>2.4.1</version>  
36.             <scope>runtime</scope>  
37.         </dependency>  
38.   
39.         <!--需要使用log4j2的AsyncLogger需要包含disruptor-->  
40.         <dependency>  
41.             <groupId>com.lmax</groupId>  
42.             <artifactId>disruptor</artifactId>  
43.             <version>3.2.0</version>  
44.         </dependency>  

2、web.xml

web工程的web.xml文件中添加（Servlet3.0不需要）：

[html]  view plain  copy

1. <!--log4j2-->  
2.     <!--对于log4j2，Servlet2.5以前的版本需要-->  
3.     <listener>  
4.         <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>  
5.     </listener>  
6.     <filter>  
7.         <filter-name>log4jServletFilter</filter-name>  
8.         <filter-class>org.apache.logging.log4j.web.Log4jServletFilter</filter-class>  
9.     </filter>  
10.     <filter-mapping>  
11.         <filter-name>log4jServletFilter</filter-name>  
12.         <url-pattern>/*</url-pattern>  
13.         <dispatcher>REQUEST</dispatcher>  
14.         <dispatcher>FORWARD</dispatcher>  
15.         <dispatcher>INCLUDE</dispatcher>  
16.         <dispatcher>ERROR</dispatcher>  
17.     </filter-mapping>  

3、log4j2.xml

log4j2不再支持properties文件了，只支持xml，json或是yaml。
默认不指定位置，可以放在src/main/resources下。如果需要自定义位置，需要在上面的web.xml中添加

[html]  view plain  copy

1. <context-param>  
2.         <param-name>log4jConfiguration</param-name>  
3.         <param-value>/WEB-INF/classes/log4j2.xml</param-value>  
4.     </context-param>  

下面是一个log4j2.xml的demo

[html]  view plain  copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2.   
3. <Configuration status="off" monitorInterval="1800">  
4.   
5.     <properties>  
6.         <property name="LOG_HOME">/opt/logs/gct/shoppromo/logs</property>  
7.         <property name="ERROR_LOG_FILE_NAME">error</property>  
8.     </properties>  
9.   
10.   
11.     <Appenders>  
12.         <Console name="Console" target="SYSTEM_OUT">  
13.             <PatternLayout pattern="%d %-5p (%F:%L) - %m%n" />  
14.         </Console>  
15.   
16.         <RollingRandomAccessFile name="ErrorLog"  
17.                                  fileName="${LOG_HOME}/${ERROR_LOG_FILE_NAME}.log"  
18.                                  filePattern="${LOG_HOME}/${ERROR_LOG_FILE_NAME}.log.%d{yyyy-MM-dd}.gz">  
19.             <PatternLayout  
20.                     pattern="%d %-5p (%F:%L) - %m%n"/>  
21.             <Policies>  
22.                 <TimeBasedTriggeringPolicy/>  
23.                 <SizeBasedTriggeringPolicy size="100 MB"/>  
24.             </Policies>  
25.             <DefaultRolloverStrategy max="20"/>  
26.         </RollingRandomAccessFile>  
27.   
28.     </Appenders>  
29.   
30.     <Loggers>  
31.         <!-- 3rdparty Loggers -->  
32.         <logger name="org.springframework.core" level="info">  
33.         </logger>  
34.         <logger name="org.springframework.beans" level="info">  
35.         </logger>  
36.         <logger name="org.springframework.context" level="info">  
37.         </logger>  
38.         <logger name="org.springframework.web" level="info">  
39.         </logger>  
40.   
41.         <logger name="com.meituan.gct.shop.promo" level="error" includeLocation="true" additivity="false">  
42.             <appender-ref ref="ErrorLog"/>  
43.             <appender-ref ref="Console"/>  
44.         </logger>  
45.   
46.         <root level="info" includeLocation="true">  
47.             <appender-ref ref="Console"/>  
48.         </root>  
49.     </Loggers>  
50. </Configuration>  

4、代码示例

[java]  view plain  copy

1. import org.springframework.stereotype.Controller;  
2. import org.springframework.ui.ModelMap;  
3. import org.springframework.web.bind.annotation.RequestMapping;  
4.   
5. import javax.servlet.http.HttpServletRequest;  
6. import javax.servlet.http.HttpServletResponse;  
7. import org.apache.logging.log4j.LogManager;  
8. import org.apache.logging.log4j.Logger;  
9.   
10. @Controller  
11. @RequestMapping("/api/")  
12. public class TestController {  
13.     private static Logger log = LogManager.getLogger(TestController.class.getName());  
14.   
15.   
16.     @RequestMapping(value = "/test")  
17.     public String test(  
18.             HttpServletRequest request, HttpServletResponse response, ModelMap modelMap) {  
19.   
20.         log.info("你好啊");  
21.         log.debug("我是debug");  
22.         log.error("错了");  
23.         log.trace("这是什么");  
24.   
25.         modelMap.put("s", "ok");  
26.         return "string";  
27.     }  
28.   
29.   
30. }  

注意：在JVM启动参数中增加 -DLog4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector 开启异步日志