SpringBoot日常：集成slf4j2日志配置

比眉伴天荒 2024-03-22 21:34 92阅读 0赞

#### 文章目录 ####

*   *  简介
     *  1、pom引入依赖
     *  2、剔除依赖
     *  3、创建log4j2.xml配置文件
     *   *  3.1、配置文件内容
         *  3.2、配置参数详解
     *  4、application.yml文件配置
     *  5、测试
     *  6、附录
     *   *  6.1、集成异常一
         *  6.2、 log4j2特性
         *  6.3、 log4j2异步日志的四种队列
         *  6.4 、log4j2使用了disruptor技术

### 简介 ###

本章节主要介绍springboot项目集成slf4j2，看完本章内容可以轻松完成集成。另外说一下，在对日志输出场景比较多的情况下可以考虑将logback更换为log4j2。

### 1、pom引入依赖 ###

<dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.24</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-log4j2</artifactId>
                <version>3.1.0</version>
            </dependency>

### 2、剔除依赖 ###

在springboot 中默认的日志管理就是logback，需要剔除原来的日志包引用，凡是相关的springboot都需要exclusion日志包，下面举例说明

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
                <version>2.7.13</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-logging</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <version>2.7.13</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-logging</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>

### 3、创建log4j2.xml配置文件 ###

在resource目录下创建log4j2.xml文件，log4j2.xml配置详情如下：

#### 3.1、配置文件内容 ####

<?xml version="1.0" encoding="UTF-8"?>
    
    
    <configuration >
        
    
        
        <Properties>
            
            
            <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
            
            <property name="FILE_PATH" value="E:/logss" />
            <property name="FILE_NAME" value="share" />
          
    
        </Properties>
    
        <appenders>
    
            <console name="Console" target="SYSTEM_OUT">
                
                <PatternLayout pattern="${LOG_PATTERN}"/>
                
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            </console>
    
            
            <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
                <PatternLayout pattern="${LOG_PATTERN}"/>
            </File>
    
            
            <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
                
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${LOG_PATTERN}"/>
                <Policies>
                    
                    <TimeBasedTriggeringPolicy interval="1"/>
                    <SizeBasedTriggeringPolicy size="10MB"/>
                </Policies>
                
                <DefaultRolloverStrategy max="15"/>
            </RollingFile>
    
            
            <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
                
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${LOG_PATTERN}"/>
                <Policies>
                    
                    <TimeBasedTriggeringPolicy interval="1"/>
                    <SizeBasedTriggeringPolicy size="10MB"/>
                </Policies>
                
                <DefaultRolloverStrategy max="15"/>
            </RollingFile>
    
            
            <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
                
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${LOG_PATTERN}"/>
                <Policies>
                    
                    <TimeBasedTriggeringPolicy interval="1"/>
                    <SizeBasedTriggeringPolicy size="10MB"/>
                </Policies>
                
                <DefaultRolloverStrategy max="15"/>
            </RollingFile>
    
        </appenders>
    
        
        
        <loggers>
    
            
            <logger name="org.mybatis" level="info" additivity="false">
                <AppenderRef ref="Console"/>
            </logger>
            
            
            <Logger name="org.springframework" level="info" additivity="false">
                <AppenderRef ref="Console"/>
            </Logger>
    
            <root level="info">
                <appender-ref ref="Console"/>
                <appender-ref ref="Filelog"/>
                <appender-ref ref="RollingFileInfo"/>
                <appender-ref ref="RollingFileWarn"/>
                <appender-ref ref="RollingFileError"/>
            </root>
        </loggers>
    
    </configuration>

#### 3.2、配置参数详解 ####

**日志等级说明**

<table> 
 <thead> 
  <tr> 
   <th align="center">等级</th> 
   <th align="center">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">trace</td> 
   <td align="center">追踪，就是程序推进一下，可以写个trace输出</td> 
  </tr> 
  <tr> 
   <td align="center">debug</td> 
   <td align="center">调试，一般作为最低级别，trace基本不用</td> 
  </tr> 
  <tr> 
   <td align="center">info</td> 
   <td align="center">输出重要的信息，使用较多</td> 
  </tr> 
  <tr> 
   <td align="center">warn</td> 
   <td align="center">警告，有些信息不是错误信息，但也要给程序员一些提示。</td> 
  </tr> 
  <tr> 
   <td align="center">error</td> 
   <td align="center">错误信息。用的也很多</td> 
  </tr> 
  <tr> 
   <td align="center">fatal</td> 
   <td align="center">致命错误</td> 
  </tr> 
 </tbody> 
</table>

**输出源**

<table> 
 <thead> 
  <tr> 
   <th align="center">类别</th> 
   <th align="center">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">CONSOLE</td> 
   <td align="center">输出到控制台</td> 
  </tr> 
  <tr> 
   <td align="center">FILE</td> 
   <td align="center">输出到文件</td> 
  </tr> 
 </tbody> 
</table>

**格式**

<table> 
 <thead> 
  <tr> 
   <th align="center">类别</th> 
   <th align="center">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">SimpleLayout</td> 
   <td align="center">以简单的形式显示</td> 
  </tr> 
  <tr> 
   <td align="center">HTMLLayout</td> 
   <td align="center">以HTML表格显示</td> 
  </tr> 
  <tr> 
   <td align="center">PatternLayout</td> 
   <td align="center">自定义形式显示</td> 
  </tr> 
 </tbody> 
</table>

PatternLayout自定义日志布局：

<table> 
 <thead> 
  <tr> 
   <th align="center">格式</th> 
   <th align="center">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">%d{HH:mm:ss.SSS}</td> 
   <td align="center">表示输出到毫秒的时间</td> 
  </tr> 
  <tr> 
   <td align="center">%t</td> 
   <td align="center">输出当前线程名称</td> 
  </tr> 
  <tr> 
   <td align="center">%-5level</td> 
   <td align="center">输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0</td> 
  </tr> 
  <tr> 
   <td align="center">%logger</td> 
   <td align="center">输出logger名称</td> 
  </tr> 
  <tr> 
   <td align="center">%msg</td> 
   <td align="center">日志文本</td> 
  </tr> 
  <tr> 
   <td align="center">%n</td> 
   <td align="center">换行</td> 
  </tr> 
  <tr> 
   <td align="center">%F</td> 
   <td align="center">输出所在的类文件名，如Test.java</td> 
  </tr> 
  <tr> 
   <td align="center">%L</td> 
   <td align="center">输出行号</td> 
  </tr> 
  <tr> 
   <td align="center">%M</td> 
   <td align="center">输出所在方法名</td> 
  </tr> 
  <tr> 
   <td align="center">%l</td> 
   <td align="center">输出语句所在的行数, 包括类名、方法名、文件名、行数</td> 
  </tr> 
 </tbody> 
</table>

### 4、application.yml文件配置 ###

需要指定加在的配置文件，因为默认加载的文件名为log4j2-spring.xml

logging:
      config: classpath:log4j2.xml
      level:
        root: trace

### 5、测试 ###

写一段测试代码打印日志，启动项目进行测试即可

@Slf4j
    public class Test {
        
    
        @GetMapping(value = "/testFeign", produces = MediaType.APPLICATION_JSON_VALUE)
        public Result<Boolean> testFeign() {
        
            log.info("测试feign调用------biz");
            return Result.success(true);
        }
    
    }

### 6、附录 ###

#### 6.1、集成异常一 ####

如果启动的时候出现如下错误，则需要  
![在这里插入图片描述][dff589c55a914ee5b12c229fcfb7b58e.png]  
SLF4J: Failed to load class “org.slf4j.impl.StaticLoggerBinder”.  
SLF4J: Defaulting to no-operation (NOP) logger implementation

**解决方法：**  
引入如下依赖即可

<dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-nop</artifactId>
                <version>1.7.36</version>
            </dependency>

#### 6.2、 log4j2特性 ####

（1）数据丢失少，可以用来做审计功能。自身内部报的exception会被发现，但是logback和log4j不会；  
（2）log4j2使用了disruptor技术，在多线程环境下，性能高于logback等10倍以上；  
（3）(garbage free）之前的版本会产生非常多的临时对象，会造成GC频繁，log4j2则在这方面上做了优化，减少产生临时对象。尽可能少的GC，其实也是基于disruptor技术；  
（4）支持lambda表达式；  
（5）对filter的功能支持的更强大；  
（6）系统日志(Syslog)协议支持TCP 和 UDP  
（7）支持kafka queue

#### 6.3、 log4j2异步日志的四种队列 ####

列出了log4j2异步日志的四种队列，有兴趣可以深入了解

ArrayBlockingQueue -- 默认的队列，通过 java 原生的 ArrayBlockingQueue 实现。
    LinkedTransferQueue -- 通过 java7 以上原生支持的 LinkedTransferQueue 实现。
    DisruptorBlockingQueue -- disruptor 包实现的高性能队列。
    JCToolsBlockingQueue -- JCTools 实现的无锁队列。

#### 6.4 、log4j2使用了disruptor技术 ####

Disruptor有三大杀器 CAS、消除伪共享、RingBuffer  
Disruptor通过以下设计来解决队列速度慢的问题:

*  **环形数组结构**
    
    为了避免垃圾回收, 采用数组而非链表. 同时, 数组对处理器的缓存机制更加友好。  
    类似的实现思想还有其他应用：

<table> 
 <thead> 
  <tr> 
   <th align="center">disruptor</th> 
   <th align="right">mysql</th> 
   <th align="right">linux 内核</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">RingBuffer 环形队列实现</td> 
   <td align="right">redolog通过一个环形的存储区域实现其循环写入</td> 
   <td align="right">进程间通信所使用的 fifo 通过环形存储区域</td> 
  </tr> 
 </tbody> 
</table>

*  **元素位置定位**
    
    数组长度2^n, 通过位运算, 加快定位的速度. 下标采取递增的形式. 不用担心index溢出的问题. index是long类型, 即使100万QPS的处理速度, 也需要30万年才能用完。
 *  **无锁设计**
    
    每个生产者或者消费者线程, 会先申请可以操作的元素在数组中的位置, 申请到之后, 直接在该位置写入或者读取数据。

[dff589c55a914ee5b12c229fcfb7b58e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/f0b206b38166408f972a39fbef8f9b70.png