Java日志框架 -- Logback（Logback入门案例logback配置（FileAppender异步日志拆分Appender过滤器）logback-access）

Posted 2022-06-15 CodeJiao

1. Logback

Logback是由log4j创始人设计的另一个开源日志组件，性能比log4j要好。
官方网站：https://logback.qos.ch/index.html

Logback主要分为三个模块：

• logback-core：其它两个模块的基础模块
• logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API
• logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能

---

1.1 Logback入门案例

首先创建一个Maven工程：

然后添加Logback相关的依赖，这里选择slf4j日志门面技术加上logback日志实现框架：

    <dependencies>
        <!--        单元测试依赖-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
        <!--        slf4j日志门面-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.25</version>
        </dependency>
        <!--        logback相关的依赖-->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
    </dependencies>

编写测试代码：

LogbackTest.java

package com.tian.logs;

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogbackTest 

    public static final Logger LOGGER = LoggerFactory.getLogger(LogbackTest.class);


    // 快速入门
    @Test
    public void testQuick() throws Exception 
        // 日志输出
        LOGGER.error("error");
        LOGGER.warn("wring");
        LOGGER.info("info");
        LOGGER.debug("debug");// 默认级别
        LOGGER.trace("trace");
    

运行结果：

---

1.2 logback配置

logback会依次读取以下类型配置文件：

• logback.groovy
• logback-test.xml
• logback.xml 如果均不存在会采用默认配置

logback组件之间的关系：

1. Logger:日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也
   可以定义日志类型、级别。
2. Appender:用于指定日志输出的目的地，目的地可以是控制台、文件、数据库等等。
3. Layout:负责把事件转换成字符串，格式化的日志信息的输出。在logback中Layout对象被封
   装在encoder中。

---

1.2.1 logback基本配置

logback.xml

配置的这些属性都是通过set方法注入的。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!--
        配置集中管理属性
        我们可以直接改属性的 value 值
        格式：$name
    -->
    <property name="pattern" value="[%-5level] %dyyyy-MM-dd HH:mm:ss.SSS %c %M %L [%thread] %m%n"/>
    <!--
    日志输出格式：
        %-5level 从左显示5个字符宽度
        %dyyyy-MM-dd HH:mm:ss.SSS日期
        %c类的完整名称
        %M为method
        %L为行号
        %thread线程名称
        %m或者%msg为信息
        %n换行
      -->
    <!--控制台日志输出的 appender-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--控制输出流对象 默认 System.out 改为 System.err-->
        <target>System.err</target>
        <!--日志消息格式配置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>$pattern</pattern>
        </encoder>
    </appender>

    <!--root logger 配置 , ALL表示开启所有日志级别 OFF表示关闭日志
    还有5个日志级别为TRACE, DEBUG, INFO, WARN, ERROR。不区分大小写-->
    <root level="ALL">
        <appender-ref ref="console"/>
    </root>
</configuration>

运行结果：

---

1.2.2 FileAppender配置

logback.xml

配置的这些属性都是通过set方法注入的。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!--
        配置集中管理属性
        我们可以直接改属性的 value 值
        格式：$name
    -->
    <property name="pattern" value="[%-5level] %dyyyy-MM-dd HH:mm:ss.SSS %c %M %L [%thread] %m%n"/>
    <!--
    日志输出格式：
        %-5level 从左显示5个字符宽度
        %dyyyy-MM-dd HH:mm:ss.SSS日期
        %c类的完整名称
        %M为method
        %L为行号
        %thread线程名称
        %m或者%msg为信息
        %n换行
      -->
    <!--控制台日志输出的 appender-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--控制输出流对象 默认 System.out 改为 System.err-->
        <target>System.err</target>
        <!--日志消息格式配置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>$pattern</pattern>
        </encoder>
    </appender>

    <!--定义日志文件保存路径属性-->
    <property name="log_dir" value="c:/logs"/>

    <!--日志文件输出的 appender-->
    <appender name="file" class="ch.qos.logback.core.FileAppender">
        <!--日志文件保存路径-->
        <file>$log_dir/logback.log</file>
        <!--日志消息格式配置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>$pattern</pattern>
        </encoder>
    </appender>

    <!--html 格式日志文件输出 appender-->
    <appender name="htmlFile" class="ch.qos.logback.core.FileAppender">
        <!--日志文件保存路径-->
        <file>$log_dir/logback.html</file>
        <!--html 消息格式配置-->
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="ch.qos.logback.classic.html.HTMLLayout">
                <pattern>%-5level%dyyyy-MM-dd HH:mm:ss.SSS%c%M%L%thread%m</pattern>
            </layout>
        </encoder>
    </appender>


    <!--root logger 配置 , ALL表示开启所有日志级别 OFF表示关闭日志
    还有5个日志级别为TRACE, DEBUG, INFO, WARN, ERROR。不区分大小写-->
    <root level="ALL">
        <appender-ref ref="console"/>
        <appender-ref ref="file"/>
        <appender-ref ref="htmlFile"/>
    </root>
</configuration>

运行结果：

---

1.2.3 logback 的拆分Appender（按照时间和空间拆分日志文件，包括压缩日志文件）

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!--
        配置集中管理属性
        我们可以直接改属性的 value 值
        格式：$name
    -->
    <property name="pattern" value="[%-5level] %dyyyy-MM-dd HH:mm:ss.SSS %c %M %L [%thread] %m%n"/>
    <!--
    日志输出格式：
        %-5level 从左显示5个字符宽度
        %dyyyy-MM-dd HH:mm:ss.SSS日期
        %c类的完整名称
        %M为method
        %L为行号
        %thread线程名称
        %m或者%msg为信息
        %n换行
      -->
    <!--控制台日志输出的 appender-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--控制输出流对象 默认 System.out 改为 System.err-->
        <target>System.err</target>
        <!--日志消息格式配置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>$pattern</pattern>
        </encoder>
    </appender>

    <!--定义日志文件保存路径属性-->
    <property name="log_dir" value="c:/logs"/>

    <!--日志拆分和归档压缩的 appender 对象-->
    <appender name="rollFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件保存路径-->
        <file>$log_dir/roll_logback.log</file>
        <!--日志消息格式配置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>$pattern</pattern>
        </encoder>
        <!--指定拆分规则-->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--按照时间和压缩格式声明拆分的文件名 如果你不想压缩, 则不加.gz-->
            <!--%i可以指定按照文件大小拆分的序号-->
            <!--yyyy-MM-dd-HH-mm-ss 可以指定按照秒拆分日志,当前是按照天拆分-->
            <fileNamePattern>$log_dir/rolling%i.%dyyyy-MM-dd.log.gz</fileNamePattern>
            <!--按照文件大小拆分-->
            <maxFileSize>1MB</maxFileSize>
        </rollingPolicy>
    </appender>

    <!--root logger 配置 , ALL表示开启所有日志级别 OFF表示关闭日志
    还有5个日志级别为TRACE, DEBUG, INFO, WARN, ERROR。不区分大小写-->
    <root level="ALL">
        <appender-ref ref="console"/>
        <appender-ref ref="rollFile"/>
    </root>
</configuration>

更改测试的代码，使打印日志重复10000次，以此来增大日志文件的大小

运行结果：

---

1.2.4 logback的过滤器

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!--
        配置集中管理属性
        我们可以直接改属性的 value 值
        格式：$name
    -->
    <property name="pattern" value="[%-5level] %dyyyy-MM-dd HH:mm:ss.SSS %c %M %L [%thread] %m%n"/>
    <!--
    日志输出格式：
        %-5level 从左显示5个字符宽度
        %dyyyy-MM-dd HH:mm:ss.SSS日期
        %c类的完整名称
        %M为method
        %L为行号
        %thread线程名称
        %m或者%msg为信息
        %n换行
      -->
    <!--控制台日志输出的 appender-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--控制输出流对象 默认 System.out 改为 System.err-->
        <target>System.err</target>
        <!--日志消息格式配置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>$pattern</pattern>
        </encoder>
        <!--filter配置-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter"> <!--设置拦截日志级别-->
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--root logger 配置 , ALL表示开启所有日志级别 OFF表示关闭日志
    还有5个日志级别为TRACE, DEBUG, INFO, WARN, ERROR。不区分大小写-->
    <root level="ALL">
        <appender-ref ref="console"/>
    </root>
</configuration>

测试代码：

LogbackTest.java

package com.tian.logs;

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogbackTest 

    public static final Logger LOGGER = LoggerFactory.getLogger(LogbackTest.class);


    // 快速入门
    @Test
    public void testQuick() throws Exception 
        // 日志输出
        LOGGER.error("error");
        LOGGER.warn("wring");
        LOGGER.info("info");
        LOGGER.debug("debug");// 默认级别
        LOGGER.trace("trace");
    

运行结果：

---

1.2.5 异步日志

同步（默认）的情况下，需要等待记录完日志文件后才可以继续执行下一步，在生产环境下，这是十分影响效率的。异步日志就可以很好的解决这个问题，它可以使得程序不需要等待日志记录完成就可以执行下一步操作。

开启异步日志：

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <property name="pattern" value="[%-5level] %dyyyy-MM-dd HH:mm:ss.SSS %c %M %L [%thread] %m%n"/>
    <!--定义日志文件保存路径属性-->
    <property name="log_dir" value="c:/logs"/>

    <!--日志拆分和归档压缩的 appender 对象-->
    <appender name="rollFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件保存路径-->
        <file>$log_dir/roll_logback.log</file>
        <!--日志消息格式配置-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>$pattern</pattern>
        </encoder>
        <!--指定拆分规则-->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--按照时间和压缩格式声明拆分的文件名 如果你不想压缩, 则不加.gz-->
            <!--%i可以指定按照文件大小拆分的序号-->
            <!--yyyy-MM-dd-HH-mm-ss 可以指定按照秒拆分日志,当前是按照天拆分-->
            <fileNamePattern>$log_dir/rolling%i.%dyyyy-MM-dd.log.gz</fileNamePattern>
            <!--按照文件大小拆分-->
            <maxFileSize>1MB</maxFileSize>
        </rollingPolicy>
    </appender>

    <!--异步日志-->
    <appender name="async" class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="rollFile"/>
    </appender>

    <!--root logger 配置 , ALL表示开启所有日志级别 OFF表示关闭日志
    还有5个日志级别为TRACE, DEBUG, INFO, WARN, ERROR。不区分大小写-->
    <root level="ALL">
        <appender-ref ref="async"/>
    </root>

</configuration>

测试代码：

LogbackTest.java

package com.tian.logs;

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogbackTest 

    public static final Logger LOGGER = LoggerFactory.getLogger(LogbackTest.class);


    // 快速入门
    @Test
    public void testQuick() throws Exception 
        for (int i = 0; i < 100000; i++) 
            // 日志输出
            LOGGER.error("error");
            LOGGER.warn("wring");
            LOGGER.info("info");
            LOGGER.debug("debug");// 默认级别
            LOGGER.trace("trace");
        
    

运行结果：
Java日志框架：logback详解

Java日志框架：logback详解

java日志框架之logback初探

Java日志框架logback剖析

Java日志框架-logback的介绍及配置使用方法（转）

java日志框架系列：logback框架过滤器（filter）详解