Java 日志框架详解

àì夳堔傛蜴生んèń 2023-10-10 11:44 48阅读 0赞

### **常用日志框架** ###

*  java.util.logging：是 JDK 在 1.4 版本中引入的 Java 原生日志框架
 *  Log4j：Apache 的一个开源项目，可以控制日志信息输送的目的地是控制台、文件、GUI 组件等，可以控制每一条日志的输出格式，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。虽然已经停止维护了，但目前绝大部分企业都是用的 log4j。
 *  LogBack：是 Log4j 的一个改良版本
 *  Log4j2：Log4j2 已经不仅仅是 Log4j 的一个升级版本了，它从头到尾都被重写

### **日志门面 slf4j** ###

上述介绍的是一些日志框架的实现，这里我们需要用日志门面来解决系统与日志实现框架的耦合性。SLF4J，即简单日志门面（Simple Logging Facade for Java），它不是一个真正的日志实现，而是一个抽象层（ abstraction layer），它允许你在后台使用任意一个日志实现。

![20201105190332182.png][]

前面介绍的几种日志框架一样，每一种日志框架都有自己单独的 API，要使用对应的框架就要使用其对应的 API，这就大大的增加应用程序代码对于日志框架的耦合性。

使用了 slf4j 后，对于应用程序来说，无论底层的日志框架如何变，应用程序不需要修改任意一行代码，就可以直接上线了。

### **为什么选用 log4j2** ###

相比与其他的日志系统，log4j2 丢数据这种情况少；disruptor 技术，在多线程环境下，性能高于 logback 等 10 倍以上；利用 jdk1.5 并发的特性，减少了死锁的发生；

在这列举一下一些网上其他博文中对它们的性能评测：

![20201105190351594.png][]

*  可以看到在同步日志模式下，Logback 的性能是最糟糕的.
 *  log4j2 的性能无论在同步日志模式还是异步日志模式下都是最佳的.
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70][]

log4j2 优越的性能其原因在于 log4j2 使用了 LMAX, 一个无锁的线程间通信库代替了，logback 和 log4j 之前的队列。并发性能大大提升。

**SpringBoot 集成log4j2 日志**

spring boot支持的日志框架有，Logback，Log4j2，Log4j和Java Util Logging，默认使用的是Logback日志框架，如果要使用别的日志框架，必须让spring boot项目不使用Logback。

第一步：移除SpringBoot 依赖的Logback 日志框架,添加log4j2 框架的jar 包依赖

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter</artifactId>
    			
    			<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-log4j2</artifactId>
            </dependency>
            
            
            <dependency>
               <groupId>com.lmax</groupId>
               <artifactId>disruptor</artifactId>
               <version>${com.lmax.disruptor}</version>
            </dependency>

第二步:配置log4j2 日志模块的配置文件:

在资源文件夹src/main/resources下添加log4j2.xml或者log4j2-spring.xml，启动后spring boot自动加载，配置文件的内容如下：

<?xml version="1.0" encoding="UTF-8"?>
    
    
    
    <Configuration status="WARN" monitorInterval="30">
     
        <Properties>
            
            <Property name="instance">spring-boot-log</Property>
            <Property name="log.dir">D:\log\dev</Property>
        </Properties>
     
        
        <Appenders>
            
            <Console name="Console" target="SYSTEM_OUT">
                
                <PatternLayout pattern="[%date{yyyy-MM-dd HH:mm:ss.SSS}][%thread][%level][%class][%line]:%message%n"/>
            </Console>
     
            
            <RollingRandomAccessFile name="infoLog"
                                     fileName="${log.dir}/${instance}-info.log"
                                     filePattern="${log.dir}/%d{yyyy-MM}/${instance}-info-%d{yyyy-MM-dd}-%i.log.gz"
                                     append="true">
                <PatternLayout pattern="[%date{yyyy-MM-dd HH:mm:ss.SSS}][%thread][%level][%class][%line]:%message%n"/>
     
                
                <Filters>
                    
                    
                    
                    
                    
                    
                    <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="NEUTRAL"/>
                </Filters>
     
                <Policies>
                    
                    <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                    
                    <SizeBasedTriggeringPolicy size="1MB"/>
                    
                </Policies>
            </RollingRandomAccessFile>
     
     
            
            <RollingRandomAccessFile name="warnLog"
                                     fileName="${log.dir}/${instance}-warn.log"
                                     filePattern="${log.dir}/%d{yyyy-MM}/${instance}-warn-%d{yyyy-MM-dd}-%i.log.gz"
                                     append="true">
                <Filters>
                    
                    
                    
                    
                    
                    
                    <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/>
                    <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
                </Filters>
     
                <PatternLayout pattern="[%date{yyyy-MM-dd HH:mm:ss.SSS}][%thread][%level][%class][%line]:%message%n"/>
     
                <Policies>
                    <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                    <SizeBasedTriggeringPolicy size="1MB"/>
                </Policies>
            </RollingRandomAccessFile>
     
     
            
            <RollingRandomAccessFile name="errorLog"
                                     fileName="${log.dir}/${instance}-error.log"
                                     filePattern="${log.dir}/%d{yyyy-MM}/${instance}-error-%d{yyyy-MM-dd}-%i.log.gz"
                                     append="true">
                <Filters>
                    
                    
                    
                    
                    
                    
                    <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
                </Filters>
     
                <PatternLayout pattern="[%date{yyyy-MM-dd HH:mm:ss.SSS}][%thread][%level][%class][%line]:%message%n"/>
     
                <Policies>
                    <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                    <SizeBasedTriggeringPolicy size="1MB"/>
                </Policies>
            </RollingRandomAccessFile>
        </Appenders>
     
     
        
     
        
        <Loggers>
            
            <logger name="org.springframework" level="info" additivity="true">
                <AppenderRef ref="warnLog"/>
                <AppenderRef ref="errorLog"/>
            </logger>
     
            <logger name="java.sql.PreparedStatement" level="debug" additivity="true">
                <AppenderRef ref="Console"/>
            </logger>
     
            <logger name="codex.terry.filter" level="debug" additivity="true">
                <AppenderRef ref="infoLog"/>
                <AppenderRef ref="warnLog"/>
                <AppenderRef ref="errorLog"/>
            </logger>
     
            
            <Root level="ALL" includeLocation="true">
                <AppenderRef ref="Console"/>
            </Root>
     
            
            
        </Loggers>
     
    </Configuration>

注意:applicatiion.properties 配置读取log4j2 默认名称为log4j2.xml或者log4j2-spring.xml，也可以指定log4j2 读取其他日志配置文件，通过以下属性指定：logging.config=classpath:log4j2-dev.xml

Log4j2 参数配置请参考:

[20201105190332182.png]: https://img-blog.csdnimg.cn/20201105190332182.png
[20201105190351594.png]: https://img-blog.csdnimg.cn/20201105190351594.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201105190419335.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n,size_16,color_FFFFFF,t_70