在Spring Boot开发中，日志作为检查问题、追踪系统、分析系统性能的手段之一，为开发者提供了各种快速解决问题的方案。而在Spring Boot中默认采用的日志框架是LogBack，作为一个功能强大的日志框架，支持了各种日志级别的修改、日志格式化的输出以及灵活的日志文件管理机制。下面我们就来详细介绍一下如何在Spring Boot中使用Logback构建基础日志配置，涵盖基本配置、日志文件的管理、日志级别的设置以及其他高级用法。

Spring Boot 中的默认日志配置

在Spring Boot中默认使用的是Logback作为基础日志框架，在没有特别配置的情况下，Spring Boot会自动启动Logback作为默认的日志框架，并且提供基于基础配置的日志输出，如下所示，默认情况下会将日志以INFO级别输出到控制台上。

2024-11-30 12:00:00.000  INFO 12345 --- [ main] c.example.demo.DemoApplication : Starting DemoApplication using Java 11.0.2 on your-hostname with PID 12345

Logback配置文件

在Spring Boot中我们可以通过logback.xml或logback-spring.xml文件对日志进行配置，可以在src/main/resources目录下创建对应的文件，这里我们通过logback-spring.xml文件进行演示。

logback-spring.xml文件的基本结构

Logback 配置文件通常由三个主要部分组成，如下所示。

• Appenders: 定义日志的输出目标（控制台、文件等）。
• Loggers: 定义日志记录器及其日志级别。
• Root Logger: 定义默认日志级别和输出目标。

下面是一个简单的示例代码，展示如何配置logback-spring.xml文件。

<configuration>

    <!-- 定义日志输出到控制台 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 定义日志输出到文件 -->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>logs/application.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 配置日志级别和输出目标 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>

    <!-- 设置特定包的日志级别 -->
    <logger name="org.springframework" level="WARN"/>
    <logger name="com.example" level="DEBUG"/>

</configuration>

配置说明

Appenders

• ConsoleAppender用于将日志输出到控制台。
• FileAppender用于将日志输出到文件。在上面的例子中，日志被写入到 logs/application.log 文件中。

PatternLayout

encoder元素中的pattern定义了日志输出的格式。在上述例子中，输出日志包括日期、日志级别、线程名、日志记录器名（类名）以及日志消息。

Root Logger

• level用来设置默认的日志级别。INFO级别意味着只有INFO及更高级别的日志（如 WARN, ERROR）会被输出，低于INFO的日志（如 DEBUG, TRACE）将被忽略。
• <appender-ref ref="CONSOLE"/> 表示将日志输出到控制台。
• <appender-ref ref="FILE"/> 表示将日志输出到文件。

Logger

在实际操作中，我们可以对特定的包或者是特定的类的日志级别进行单独的配置。例如，我们可以将org.springframework包的日志级别设置为WARN，也就是仅输出警告及以上级别的日志；还可以将com.example包的日志级别设置为DEBUG，允许输出调试级别的日志。

日志级别

Logback 支持六种日志级别，从低到高依次为，如下所示

• TRACE: 最详细的日志级别，通常用于调试小的细节。
• DEBUG: 用于调试和开发过程中打印的日志。
• INFO: 通常用于记录系统的正常行为，默认级别。
• WARN: 用于警告，表示可能存在问题，但并不会影响系统的正常运行。
• ERROR: 用于记录错误日志，表示系统的异常或错误发生。
• FATAL: 严重错误，通常会导致应用程序崩溃。

异常处理与堆栈跟踪

在进行日志输出的时候，我们可以通过Logback自动打印出异常信息的堆栈跟踪信息。我们可以通过%ex或%exception配置将异常信息包裹在日志中进行输出，用来进行异常信息的分析记录以及实时处理，如下所示。

<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{36} - %msg %ex%n</pattern>

这样我们就可以在实时监控日志的时候通过获取异常匹配来定位到具体异常逻辑位置，用来帮助开发者快速定位问题。

日志文件管理

为了防止日志文件过长，Logback还提供了日志文件的回滚功能，我们可以通过RollingFileAppender来配置各种文件的滚动操作，例如比较常见的通过时间和大小进行滚动。

按时间滚动

按时间滚动日志文件，例如我们可以按照天、按照小时进行滚动，如下所示，展示如何按照天进行滚动。

<appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/application.log</file>

    <!-- 定义文件滚动策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>logs/application-%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory> <!-- 保留最近 30 天的日志 -->
    </rollingPolicy>

    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

上述配置会每天生成一个新的日志文件，并将其命名为
application-yyyy-MM-dd.log，同时保留最近30天的日志文件。

按大小滚动

我们可以通过
SizeAndTimeBasedRollingPolicy的配置来配置文件按照大小进行滚动，如下所示。

<appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/application.log</file>

    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <fileNamePattern>logs/application-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <maxFileSize>10MB</maxFileSize> <!-- 每个文件最大 10MB -->
        <maxHistory>30</maxHistory> <!-- 保留最近 30 天的日志 -->
    </rollingPolicy>

    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

如果不需要日志功能，或者需要用到自定义其他日志框架，我们可以在application.properties或application.yml文件中通过如下的配置来禁用Logback。

logging.enabled=false

总结

Logback为Spring Boot应用提供了强大的日志处理功能，提供了多种日志输出方案、日志输出格式以及滚动策略配置，在logback-spring.xml中，我们可以通过灵活的配置来控制日志级别、控制输出目标、日志滚动等。通过合理的配置以及日志的监控可以快速有效的帮助开发者定位排查问题。