springboot 整合logback, 你从不知道的强大用法

2023-09-06 12:38:53

Logback：SpringBoot 中强大的日志记录利器

Logback 的基本用法

在应用程序开发中，日志记录至关重要，它有助于监控应用程序的运行状况，识别问题并进行调试。在 SpringBoot 中，Logback 是一款出色的日志记录框架，它提供强大而灵活的功能，让日志记录变得轻而易举。

添加 Logback 依赖

要将 Logback 集成到 SpringBoot 项目中，需要在 pom.xml 文件中添加以下依赖：

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

配置 Logback

接下来，在 resources 目录下创建 logback.xml 文件，用于配置 Logback 的日志输出方式：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="file" class="ch.qos.logback.core.FileAppender">
        <file>log.txt</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="INFO">
        <appender-ref ref="console"/>
        <appender-ref ref="file"/>
    </root>
</configuration>

记录日志

在代码中使用 Logback 记录日志：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    private static final Logger logger = LoggerFactory.getLogger(Main.class);

    public static void main(String[] args) {
        logger.info("Hello, Logback!");
    }
}

Logback 的高级用法

记录结构化日志

Logback 可以记录结构化日志，更易于解析和存储：

<configuration>
    <appender name="json" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="net.logstash.logback.encoder.LogstashEncoder">
            <fieldNames>
                <timestamp>[@timestamp]</timestamp>
                <level>[level]</level>
                <logger>[logger]</logger>
                <message>[message]</message>
            </fieldNames>
        </encoder>
    </appender>

    <root level="INFO">
        <appender-ref ref="json"/>
    </root>
</configuration>

日志分级

Logback 可以对日志进行分级，并根据不同级别输出不同信息：

<configuration>
    <logger name="com.example.app.controller" level="DEBUG"/>
    <logger name="com.example.app.service" level="INFO"/>
    <logger name="com.example.app.repository" level="WARN"/>

    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="INFO">
        <appender-ref ref="console"/>
    </root>
</configuration>

异步日志输出

Logback 支持异步日志输出，可以提高应用程序性能：

<configuration>
    <appender name="async" class="ch.qos.logback.classic.AsyncAppender">
        <queueSize>512</queueSize>
        <discardingThreshold>0</discardingThreshold>
        <appender-ref ref="console"/>
    </appender>

    <root level="INFO">
        <appender-ref ref="async"/>
    </root>
</configuration>