【JAVA日志框架大全】一文快速讲透JAVA日志体系

àì夳堔傛蜴生んèń 2024-02-05 16:56 40阅读 0赞

![4b6136e953bc4bb9a64f189843babb7d.png][]

![620c7589fe294134816e61d9f8e9243e.gif][]

**目录**

1.概述

2.jul

3.log4j

3.1.概述

3.2.日志级别

3.3.配置

4.日志门面

4.1.jcl+log4j

4.1.1.使用

4.1.2.原理

4.2.sl4j+logback

4.2.1.使用

4.2.2.配置

5.适配

6.联系作者

--------------------

## 1.概述 ##

发展史：

![7e4c050ab2814520833d2239a87dee17.png][]

java日志体系中是现有的log4j，后面才有了JDK自带的jul，两者是两套体系，互不兼容。后来为了不同日志体系之间的兼容，apache推出了jcl日志门面。后来log4j的作者因为和apache理念不合，离开apache后推出了一个全新的日志实现——logback，以及一个全新的日志门面——slf4j。最后apache优化了log4j推出了log4j2。

**日志框架的核心问题：**

日志是用来记录应用的一些运行信息的。假设没有日志框架，我们要在应用里手动实现日志相关功能，我们需要关注些什么？其实仔细想想无非两点：

*  记录哪些信息？
 *  记录到哪里去？

当然作为日志框架来说，为了方便使用，它还要关注一点就是：

*  如何进行方便的配置

以上三点核心问题，我们看作为日志框架的开山鼻祖的log4j是怎样解决的：

log4j给出的答案是：

*  记录哪些信息——日志级别（level）
 *  记录到哪里去——提供不同的输出方式（appender），文件、控制台、其它等等
 *  如何进行方便的配置——除硬编码外，提供配置文件

![fb1f14a281904376ae091d25bb3d95b9.png][]

## 2.jul ##

jul是JDK自带的日志框架，作者之前有一篇文章专门讲过，可以移步：

[【JAVA日志框架】JUL，JDK原生日志框架详解。-CSDN博客][JAVA_JUL_JDK_-CSDN]

## 3.log4j ##

### 3.1.概述 ###

log4j最后一个版本是12年发布的，如今apache已经停止对其维护，现在的项目基本上是不会选用log4j来作为日志框架了，但是作为第一款日志框架，其很多设计思想和体系架构，均成为了标准，后面的日志框架其实都是效仿的log4j。

依赖：

### 3.2.日志级别 ###

日志级别：

import org.apache.log4j.Logger;
    import org.junit.Test;
    
    public class test {
        private static Logger logger=Logger.getLogger(test.class);
        @Test
        public void test1(){
            logger.trace("trace");
            logger.debug("debug");
            logger.info("info");
            logger.warn("warn");
            logger.error("error");
            logger.fatal("fatal");
        }
    }

### 3.3.配置 ###

如果直接像上面一样使用，会报错：

![0ac514e3174f4ccbbb8a1843c061678e.png][]

原因很简单，log4j没有进行初始化的默认配置，需要手动去进行配置，才能使用。

log4j的配置，主要就是配置appender，以下将展示几个实际工程中常用的appender：

*  ConsoleAppender
 *  FileAppender
 *  DailyRollingFileAppender，将每天的日志单独写成一个文件，即每天一个日志文件。

**1.ConsoleAppender：**

> \#控制台的appender,stdout是自定义的一个appender的名字。  
> log4j.appender.stdout=org.apache.log4j.ConsoleAppender  
> \#自定义的这个appender用什么方式来输出，这里用System.out  
> log4j.appender.stdout.Target=System.out  
> \#自定义的这个appender的日志级别  
> log4j.appender.stdout.Threshold=INFO  
> \#自定义的这个appender的日志的格式  
> \#d:data %-5p:用5个字符来打印日志级别 %20c:用20个字符来打印全类名 %L：第几行 %m：打印自己的message  
> log4j.appender.stdout.layout=org.apache.log4j.PatternLayout  
> log4j.appender.stdout.layout.ConversionPattern=%d\{yyyy-MM-dd HH:mm:ss\} %-5p %20c %L:%m %n

**2.FileAppender：**

> \#文件appender  
> log4j.appender.a1=org.apache.log4j.FileAppender  
> \#自定义的这个appender用什么方式来输出，这里用System.out  
> log4j.appender.a1.File=$\{user.home\}/LogDemo/log4j/a1.log  
> \#自定义的这个appender的日志级别  
> log4j.appender.a1.Threshold=INFO  
> \#自定义的这个appender的日志的格式  
> \#d:data %-5p:用5个字符来打印日志级别 %20c:用20个字符来打印全类名 %L：第几行 %m：打印自己的message  
> log4j.appender.a1.layout=org.apache.log4j.PatternLayout  
> log4j.appender.a1.layout.ConversionPattern=%d\{yyyy-MM-dd HH:mm:ss\} %-5p %20c %L:%m %n

**3.DailyRollingFileAppender：**

> \#将每天的日志单独写成一个文件，即每天一个日志文件的appender,stdout是自定义的一个appender的名字。  
> log4j.appender.a2=org.apache.log4j.DailyRollingFileAppender  
> \#自定义的这个appender用什么方式来输出，这里用System.out  
> log4j.appender.a2.File=$\{user.home\}/LogDemo/log4j/a1.log  
> \#自定义的这个appender的日志级别  
> log4j.appender.a2.Threshold=INFO  
> \#自定义的这个appender的日志的格式  
> \#d:data %-5p:用5个字符来打印日志级别 %20c:用20个字符来打印全类名 %L：第几行 %m：打印自己的message  
> log4j.appender.a2.layout=org.apache.log4j.PatternLayout  
> log4j.appender.a2.layout.ConversionPattern=%d\{yyyy-MM-dd HH:mm:ss\} %-5p %20c %L:%m %n

光是配置好了，还不能用，要把配置的appender关联到根logger上去：

\#日志级别以及appender  
log4j.rootLogger=Info,stdout,a1,a2

将配置文件放到classpath下面去即可，log4j会去classpath下找配置文件：

![66f5dea1117548e483384943c4818924.png][]

再运行就可以看到效果：

![782111018f894fbe8fe16615eb3ba3fe.png][]

## 4.日志门面 ##

### 4.1.jcl+log4j ###

#### 4.1.1.使用 ####

jcl也是apache推出的一个日志门面，jcl可能听起来比较陌生，它的另一个名字大家就会觉得很熟悉了——commons-logging。jcl最后一次更新是14年，后面apache放弃了对jcl的维护，所以jcl和log4j一样都不太会在新项目里面被使用，学jcl主要是理解它的思想。

依赖：

> <dependency>  
> <groupId>commons-logging</groupId>  
> <artifactId>commons-logging</artifactId>  
> <version>1.2</version>  
> </dependency>

jcl默认使用jul进行输出，其支持的日志级别和log4j一样：

package com.eryi;
    
    import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    import org.junit.Test;
    
    public class test {
        private static Log log= LogFactory.getLog(test.class);
        @Test
        public void test1(){
            log.trace("trace");
            log.debug("debug");
            log.info("info");
            log.warn("warn");
            log.error("error");
            log.fatal("fatal");
        }
    }

![86dd516366ac4587b107661c6f608ecb.png][]

要切换成log4j，直接引入log4j的依赖即可：

> <dependencies>  
> <dependency>  
> <groupId>ch.qos.logback</groupId>  
> <artifactId>logback-classic</artifactId>  
> <version>1.2.3</version>  
> </dependency>  
> </dependencies>

然后记得把log4j的配置文件放到classpath下面。

然后执行效果如下，可以看到是log4j输出的：

![ef8bac870bae4670a28fb4ff17edb2f9.png][]

#### 4.1.2.原理 ####

其实源码没什么看头，核心就是去获取log的时候，这个log的底层实现用什么？

jcl里面写死了要适配的所有日志框架的logger的类全路径：

private static final String[] classesToDiscover = new String[]{"org.apache.commons.logging.impl.Log4JLogger", "org.apache.commons.logging.impl.Jdk14Logger", "org.apache.commons.logging.impl.Jdk13LumberjackLogger", "org.apache.commons.logging.impl.SimpleLog"};

去load这些实现类，然后用反射实例化出来作为底层提供能力的内核。获取实现类的时候用了一个简单的模板模式，提供能力的时候用了一个简单的适配器模式，经此而已。

### 4.2.sl4j+logback ###

#### 4.2.1.使用 ####

sl4j是目前常用的日志门面，logback是目前常用的日志框架。

依赖：

> <dependencies>  
> <dependency>  
> <groupId>org.slf4j</groupId>  
> <artifactId>slf4j-api</artifactId>  
> <version>1.7.25</version>  
> </dependency>  
> <dependency>  
> <groupId>ch.qos.logback</groupId>  
> <artifactId>logback-core</artifactId>  
> <version>1.2.3</version>  
> </dependency>  
> <dependency>  
> <groupId>ch.qos.logback</groupId>  
> <artifactId>logback-classic</artifactId>  
> <version>1.2.3</version>  
> </dependency>  
> </dependencies>

slf4j和jcl使用上是相似的，只是工程的叫法不同，jcl里面叫LogFactory，slf4j里面叫LoggerFactory：

package com.eryi;
    
    
    import org.junit.Test;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class test {
        private static Logger logger= LoggerFactory.getLogger(test.class);
        @Test
        public void test1(){
            logger.trace("trace");
            logger.debug("debug");
            logger.info("info");
            logger.warn("warn");
            logger.error("error");
        }
    }

输出结果：

![2862d5e30e5e4079b32ddde2614b9f17.png][]

#### 4.2.2.配置 ####

logback默认会去classpath里面寻找配置文件。

配置文件示例：

<?xml version="1.0" encoding="UTF-8"?>
    <configuration scan="true" scanPeriod="10 seconds">
        
        
        
        
        <contextName>logback</contextName>
        
        <property name="LOG_SAVE_PATH" value="logs"></property>
        
        <property name="DEFAULT_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger] - (%F:%L\\) : %msg%n"/>
    
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <Pattern>${DEFAULT_PATTERN}</Pattern>
                
                <charset>UTF-8</charset>
            </encoder>
        </appender>
    
        
        <appender name="RollingFileInfo" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_SAVE_PATH}/console.log</file>
            <encoder>
                <pattern>${DEFAULT_PATTERN}</pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_SAVE_PATH}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="RollingFileWarn" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_SAVE_PATH}/warn.log</file>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_SAVE_PATH}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="RollingFileError" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_SAVE_PATH}/error.log</file>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [%logger{50}] - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_SAVE_PATH}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <logger name="org.springframework" level="INFO" additivity="false">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="RollingFileInfo"/>
        </logger>
        <logger name="org.springframework.security" level="INFO"></logger>
        <Logger name="org.apache.ibatis.io.DefaultVFS" level="INFO"/>
        <Logger name="org.apache.ibatis.io" level="INFO"/>
        
        <root level="ALL">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="DEFAULT_FILE"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </configuration>

![3ef000f61c0b41bf84362c164cd12e2d.png][]

## 5.适配 ##

由于api均不统一，jcl兼容log4j，slf4j兼容logback，当想交叉组合，比如slf4j+log4j时，需要用到适配包，各门面和各实现之间的适配关系如下图所示，用到的时候去查一下即可：

![d2ddaaa55d3d40b9b2b2d9ad446d06a8.png][]

## 6.联系作者 ##

商务合作、各种交流：

![279c29e2674c44539dfbb82ffe488505.jpeg][]

[4b6136e953bc4bb9a64f189843babb7d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/91af4e6edf0846adb0560e63b8a8f5bb.png
[620c7589fe294134816e61d9f8e9243e.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/859c5acefdb8419cb7fd58c2d6d2b34a.png
[7e4c050ab2814520833d2239a87dee17.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/1121a49126704bfbbecb96a0c43e8182.png
[fb1f14a281904376ae091d25bb3d95b9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/97116b0bad384d53ba30b19beab7c08d.png
[JAVA_JUL_JDK_-CSDN]: https://blog.csdn.net/Joker_ZJN/article/details/135039876?spm=1001.2014.3001.5501
[0ac514e3174f4ccbbb8a1843c061678e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/6c1f9c8940cf40b2b853a484653f4c32.png
[66f5dea1117548e483384943c4818924.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/14ad4311147841c6a42cfd1775bcbceb.png
[782111018f894fbe8fe16615eb3ba3fe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/9c254701691c4a09bf376eaac99cdb7d.png
[86dd516366ac4587b107661c6f608ecb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/81a445e2ea954245ade562c73342eac2.png
[ef8bac870bae4670a28fb4ff17edb2f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/a7b29ff25f1f41d3a2dc7b557ff761b4.png
[2862d5e30e5e4079b32ddde2614b9f17.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/687c3cea9ec74c9d9ce0849fc203985d.png
[3ef000f61c0b41bf84362c164cd12e2d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/45af09cd24f2426eb731eef4a82308b2.png
[d2ddaaa55d3d40b9b2b2d9ad446d06a8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/ee19dd3b96b24ed784ffc88a40d262fc.png
[279c29e2674c44539dfbb82ffe488505.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/d4b1f6344fb247318634f61a6ccd8345.png