Spring Boot使用Logback实现日志配置与异常记录

介绍

Spring Boot是一款轻量级的应用框架，它提供了很多有用的功能来简化应用开发流程，其中包括了日志记录功能。Logback是一个优秀的日志框架，它可以取代Java标准库的日志框架，并支持通过XML文件配置日志。在这篇教程中，我们将看到如何在Spring Boot应用中使用Logback实现日志配置和异常记录。

步骤

1. 添加Logback依赖

首先，我们需要在pom.xml文件中添加Logback的依赖：

<dependencies>
    <!-- logback日志框架 -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
    </dependency>
</dependencies>

2. 添加Logback配置文件

在src/main/resources目录下创建一个名为logback.xml的文件，添加以下配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <property name="LOG_PATH" value="./logs"/>
    <!-- 控制台输出日志 -->
    <appender name="CONSOLE_APPENDER" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!-- 设置输出日志级别 -->
            <level>INFO</level> 
        </filter>
        <encoder>
            <!-- 输出日志信息格式 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 输出到文件 -->
    <appender name="FILE_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/test.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天分割日志 -->
            <fileNamePattern>${LOG_PATH}/test-%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            <!-- 日志信息输出编码 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!-- 配置日志记录器 -->
    <logger name="com.example" level="DEBUG" additivity="false">
        <appender-ref ref="CONSOLE_APPENDER"/>
        <appender-ref ref="FILE_APPENDER"/>
    </logger>
    <root level="INFO">
        <appender-ref ref="CONSOLE_APPENDER"/>
        <appender-ref ref="FILE_APPENDER"/>
    </root>
</configuration>

以上配置中，我们添加了两个appender：CONSOLE_APPENDER和FILE_APPENDER，分别用于将日志信息输出到控制台和文件。另外设置了日志级别为INFO，记录器名为com.example，表示只记录com.example包及其子包的日志信息。

3. 使用Logback记录日志

在代码中使用Logback记录日志非常简单，只需要使用LoggerFactory.getLogger获得Logger实例，然后使用相应的日志级别记录日志即可。

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

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

    public void test() {
        logger.debug("debug level log message");
        logger.info("info level log message");
        logger.warn("warn level log message");
        logger.error("error level log message");
    }
}

上面的例子展示了如何在控制器类ExampleController中使用Logger记录日志信息，同时记录了不同级别的日志信息，包括DEBUG、INFO、WARN、ERROR。具体使用哪个级别根据实际需求而定。

4. 记录异常信息

Logback还提供了记录异常信息的功能。当出现异常时，我们可以将异常信息记录到日志中，方便调试和错误分析。

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

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

    public void test() {
        try {
            int a = 1/0;
        } catch (Exception e) {
            logger.error("exception message: {}", e.getMessage(), e);
        }
    }
}

以上代码展示了如何在服务类ExampleService中记录异常信息，使用了Logger的error方法，传入了异常信息Message和Exception对象。其中，{}是占位符，用于在后面传入变量格式化输出日志信息。

5. 运行应用

最后，我们启动应用程序，在控制台和文件中查看日志信息。

结论

使用Logback记录日志是一个非常方便、有效的方式，它提供了多种输出方式，可以灵活地配置输出目的地，并提供了处理异常信息的能力。在Spring Boot应用中，Logback与其它组件的集成是非常自然的，我们可以用与前面的Logback配置方法相同的方式配置日志输出。