使用Slf4j集成Log4j2构建项目日志系统的完美解决方案

一、背景

　　最近因为公司项目性能需要，我们考虑把以前基于的log4j的日志系统重构成基于Slf4j和log4j2的日志系统，因为，使用slf4j可以很好的保证我们的日志系统具有良好的兼容性，兼容当前常见几种日志系统，而使用log4j2而不是log4j是因为Log4j 1.x 在高并发情况下出现死锁导致cpu使用率异常飙升，而Log4j2.0基于LMAX Disruptor的异步日志在多线程环境下性能会远远优于Log4j 1.x和logback（官方数据是10倍以上）。

　　关于slf4j的原理以及优点，请参见我的另一篇博客：slf4j介绍以及实现原理窥探

二、搭建步骤

　　1.依赖管理

　　　　1).删除项目中存在的Log4j1.x所必须的log4j和slf4j-log4j12等依赖。

　　　　　　可以到项目的根目录，执行：mvn dependency:tree > tree.log，之后使用 cat tree.log | grep log4j命令进行查找。

     <exclusions>
         <exclusion>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-log4j12</artifactId>
         </exclusion>
         <exclusion>
             <groupId>log4j</groupId>
             <artifactId>log4j</artifactId>
         </exclusion>
     </exclusions>  

　　　　2).添加以下slf4j和log4j2的依赖.

     <!-- slf4j核心包-->
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
             <version>1.7.13</version>
         </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>jcl-over-slf4j</artifactId>
             <version>1.7.13</version>
             <scope>runtime</scope>
         </dependency>  
 
         <!--核心log4j2jar包-->
         <dependency>
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-api</artifactId>
             <version>2.4.1</version>
         </dependency>
         <dependency>
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-core</artifactId>
             <version>2.4.1</version>
         </dependency>
         <!--用于与slf4j保持桥接-->
         <dependency>
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-slf4j-impl</artifactId>
             <version>2.4.1</version>
         </dependency>
         <!--web工程需要包含log4j-web，非web工程不需要-->
         <dependency>
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-web</artifactId>
             <version>2.4.1</version>
             <scope>runtime</scope>
         </dependency>  
 
         <!--需要使用log4j2的AsyncLogger需要包含disruptor-->
         <dependency>
             <groupId>com.lmax</groupId>
             <artifactId>disruptor</artifactId>
             <version>3.2.0</version>
         </dependency>  

　　2.web.xml中设置log4j2的监听器和过滤器（servlet3.0及以上版本不需要该步操作）

 <!--对于log4j2，Servlet2.5以前的版本需要-->
   <listener>
      <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>
   </listener>
   <filter>
      <filter-name>log4jServletFilter</filter-name>
      <filter-class>org.apache.logging.log4j.web.Log4jServletFilter</filter-class>
   </filter>
   <filter-mapping>
      <filter-name>log4jServletFilter</filter-name>
      <url-pattern>/*</url-pattern>
      <dispatcher>REQUEST</dispatcher>
      <dispatcher>FORWARD</dispatcher>
      <dispatcher>INCLUDE</dispatcher>
      <dispatcher>ERROR</dispatcher>
   </filter-mapping>  

　　注意：log4j2不再支持properties文件了，只支持xml，json或是yaml，不指定位置的情况下默认在src/main/resources下查找。

　　　　　如果需要自定义位置，需要在上面的web.xml中添加以下代码

 <context-param>
   <param-name>log4jConfiguration</param-name>
   <param-value>/WEB-INF/classes/log4j2.xml</param-value>
 </context-param> 

　　3.log4j2.xml

 <?xml version="1.0" encoding="UTF-8"?>  
 
 <Configuration status="off" monitorInterval="1800">  
 
     <properties>
         <property name="LOG_HOME">/opt/logs/hafiz/log4j2Demo/logs</property>
         <property name="ERROR_LOG_FILE_NAME">error</property>
     </properties>  
 
     <Appenders>
         <Console name="Console" target="SYSTEM_OUT">
             <PatternLayout pattern="%d %-5p (%F:%L) - %m%n" />
         </Console>  
 
         <RollingRandomAccessFile name="ErrorLog"
                                  fileName="${LOG_HOME}/${ERROR_LOG_FILE_NAME}.log"
                                  filePattern="${LOG_HOME}/${ERROR_LOG_FILE_NAME}.log.%d{yyyy-MM-dd}.gz">
             <PatternLayout
                     pattern="%d %-5p (%F:%L) - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
             <DefaultRolloverStrategy max="20"/>
         </RollingRandomAccessFile>  
 
     </Appenders>  
 
     <Loggers>
         <!-- 3rdparty Loggers -->
         <logger name="org.springframework.core" level="info">
         </logger>
         <logger name="org.springframework.beans" level="info">
         </logger>
         <logger name="org.springframework.context" level="info">
         </logger>
         <logger name="org.springframework.web" level="info">
         </logger>  
 
         <logger name="com.hafiz.www.controller" level="error" includeLocation="true" additivity="false">
             <appender-ref ref="ErrorLog"/>
             <appender-ref ref="Console"/>
         </logger>  
 
         <root level="info" includeLocation="true">
             <appender-ref ref="Console"/>
         </root>
     </Loggers>
 </Configuration>  

　　4.测试类UserController.java

 package com.hafiz.www.controller;
 
 import com.hafiz.www.po.UserEntity;
 import com.hafiz.www.service.UserService;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.ResponseBody;
 
 import java.util.ArrayList;
 import java.util.List;
 
 /**
  * Desc:用户信息控制器
  * Created by hafiz.zhang on 2016/8/27.
  */
 @Controller
 @RequestMapping("/user")
 public class UserController {
 
     private static final Logger logger = LoggerFactory.getLogger(UserController.class);
 
     @Autowired
     private UserService userService;
 
     @RequestMapping(value = "/all", method = RequestMethod.GET)
     @ResponseBody
     public List<UserEntity> getAllUsers(){
         logger.info("[GET] /user/all getAllUsers");
         List<UserEntity> list = userService.getAllUsers();
         logger.debug("This is log of level of debug");
         logger.trace("log4j2 Demo");
         logger.error("哎呀，出错啦~");
         return list;
     }
 }

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

三、小问题：

　　项目不打印日志并且报：SLF4J: Class path contains multiple SLF4J bindings.主要问题在于在项目中既存在slf4j-log4j12的jar包又存在log4j-slf4j-impl的jar包，导致出现了两个打印日志实现类，所以slf4j门面不知道具体应该使用哪一个进行输出日志，所以导致不打印日志。

　　因为我之前是log4j 1.x，并且我在web.xml里面指定了log4j.properties文件的位置，第一次运行项目，忘了修改其值为log4j2.xml，出现了"Context [] startup failed due to previous errors"的错误，导致项目启动不起来，web.xml中修改为如下方式以后就正常了。

 <context-param>
     <param-name>log4jConfiguration</param-name>
     <param-value>/WEB-INF/classes/log4j2.xml</param-value>
  </context-param>