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

Posted 2022-02-25 116970u

一、背景

　　使用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命令进行查找。

 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>  

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

 1      <!-- slf4j核心包-->  
 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中设置log4j2的监听器和过滤器（servlet3.0及以上版本不需要该步操作）

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

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

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

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

3.log4j2.xml

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <Configuration status="OFF" monitorInterval="1800">
 3     <properties>
 4         <property name="LOG_HOME">/WEB-INF/logs</property>
 5         <property name="FILE_NAME">finance-pay</property>
 6     </properties>
 7 
 8 
 9     <Appenders>
10         <Console name="Console" target="SYSTEM_OUT">
11             <PatternLayout pattern="%dHH:mm:ss.SSS [%t] %-5level %logger36 - %msg%n" />
12         </Console>
13 
14         <RollingFile name="running-log" fileName="$LOG_HOME/$FILE_NAME.log"
15                      filePattern="$LOG_HOME/$$date:yyyy-MM/$FILE_NAME-%dyyyy-MM-dd-%i.log.gz"
16                      immediateFlush="true">
17             <PatternLayout
18                     pattern="%dateyyyy-MM-dd HH:mm:ss.SSS %level [%thread][%file:%line] - %msg%n" />
19             <Policies>
20                 <TimeBasedTriggeringPolicy />
21                 <SizeBasedTriggeringPolicy size="10 MB" />
22             </Policies>
23             <DefaultRolloverStrategy max="20" />
24         </RollingFile>
25     </Appenders>
26     <Loggers>
27 
28         <!-- <Logger name="com.cssweb.test.app" level="trace" additivity="true">
29             <AppenderRef ref="running-log" /> </Logger> -->
30 
31         <Root level="info">
32             <!-- 这里是输入到文件，很重要-->
33             <AppenderRef ref="running-log" />
34             <!-- 这里是输入到控制台-->
35             <AppenderRef ref="Console" />
36         </Root>
37     </Loggers>
38 </Configuration>

4.测试类UserController.java

 1 package com.hafiz.www.controller;
 2 import com.hafiz.www.po.UserEntity;
 3 import com.hafiz.www.service.UserService;
 4 import org.slf4j.Logger;
 5 import org.slf4j.LoggerFactory;
 6 import org.springframework.beans.factory.annotation.Autowired;
 7 import org.springframework.stereotype.Controller;
 8 import org.springframework.web.bind.annotation.RequestMapping;
 9 import org.springframework.web.bind.annotation.RequestMethod;
10 import org.springframework.web.bind.annotation.ResponseBody;
11 
12 import java.util.ArrayList;
13 import java.util.List;
14 
15 /**
16  * Desc:用户信息控制器
17  * Created by hafiz.zhang on 2016/8/27.
18  */
19 @Controller
20 @RequestMapping("/user")
21 public class UserController 
22 
23     private static final Logger logger = LoggerFactory.getLogger(UserController.class);
24 
25     @Autowired
26     private UserService userService;
27 
28     @RequestMapping(value = "/all", method = RequestMethod.GET)
29     @ResponseBody
30     public List<UserEntity> getAllUsers()
31         logger.info("[GET] /user/all getAllUsers");
32         List<UserEntity> list = userService.getAllUsers();
33         logger.debug("This is log of level of debug");
34         logger.trace("log4j2 Demo");
35         logger.error("哎呀，出错啦~");
36         return list;
37     
38 

注意：在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中修改为如下方式以后就正常了。

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

 

感谢原创作者，原文地址：https://www.cnblogs.com/hafiz/p/6160298.html