揭秘SpringBoot logback配置，打造独一无二的日志记录系统

2023-09-17 19:55:45

SpringBoot 默认 Logback 配置剖析

SpringBoot 在日志记录方面默认集成了 Logback 框架，为开发者提供了丰富的配置选项。深入理解 Logback 默认配置中的关键属性，对于优化日志记录至关重要。

日志输出级别

Logback 提供了六种日志输出级别：TRACE、DEBUG、INFO、WARN、ERROR 和 FATAL。SpringBoot 默认将输出级别设置为 INFO，即只记录 INFO 及以上级别的日志信息。可通过修改 logging.level.root 属性更改输出级别。

日志格式化器

Logback 提供了多种日志格式化器，允许自定义日志输出格式。SpringBoot 默认使用 PatternLayout，格式为：

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

可根据需要修改格式字符串，以输出更符合需求的日志信息。

日志文件配置

Logback 可将日志输出到文件或流。SpringBoot 默认输出到控制台，若需输出到文件，可修改 logging.file 属性。例如，输出到 application.log 文件的配置：

<appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>application.log</file>
    <append>true</append>
    <layout class="ch.qos.logback.classic.PatternLayout">
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </layout>
</appender>

日志轮转策略

Logback 提供了日志轮转策略，控制日志文件增长。SpringBoot 默认不启用，若需启用，可修改 logging.rollingPolicy 属性。例如，启用按大小轮转的策略，当日志文件达到 10MB 时生成新文件：

<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    <fileNamePattern>application-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
    <maxFileSize>10MB</maxFileSize>
    <maxHistory>7</maxHistory>
</rollingPolicy>

进阶配置

Logback 提供了更高级的配置选项，实现更灵活的日志记录。例如，使用 AppenderRef 将日志输出到多个目标，或使用 Filter 过滤日志消息。详情可参考 Logback 官方文档。

Logback 使用技巧

使用有意义的日志级别： 不要所有日志都设置为 INFO，根据严重程度选择合适级别。

使用清晰的日志消息： 日志消息简洁、易懂，避免模糊术语或缩写。

使用日志上下文： Logback 的 MDC 功能，可在日志消息中添加附加信息，便于调试。

使用日志记录框架： Logback 提供 SLF4J 框架，方便应用程序中使用日志记录。

常见问题解答

如何关闭 Logback 日志输出？
将 logging.level.root 设置为 OFF。
如何更改日志文件路径？
修改 logging.file 属性。
如何启用日志轮转？
修改 logging.rollingPolicy 属性。
如何使用 Logback Filter 过滤日志消息？
在 logback.xml 中定义 Filter，并将其应用到 Appender。
如何使用 Logback AppenderRef 将日志输出到多个目标？
在 logback.xml 中定义多个 Appender，并使用 AppenderRef 将它们链接起来。