Spring Boot 使用 SLF4J 实现控制台输出与分类日志文件管理

发布于:2025-06-07 ⋅ 阅读:(25) ⋅ 点赞:(0)

概述

在日常的 Java 项目开发中,日志是最重要的调试与排查手段之一。为了便于开发时实时查看,同时在生产中追踪问题,我们通常希望实现以下日志管理目标:

  • ✅ 控制台实时输出日志,方便开发调试
  • ✅ 日志根据级别分类保存,例如:info.logwarn.logerror.log
  • ✅ 日志文件按日期滚动保存,防止文件过大
  • ✅ 日志保存在 logs/ 文件夹中,项目内统一管理

在本文中,我们将使用 Spring Boot + SLF4J + Logback 组合,完成这一目标。

为什么选择 SLF4J + Logback?

SLF4J 是一个日志“门面”,可以灵活对接多种日志实现,如 Logback、Log4j、Log4j2。

Logback 是 Spring Boot 默认日志实现,功能强大、性能优越。

实战

假设现在有一个项目,项目的结构如下:

配置 application.yaml

# 日志配置
logging:
  # 读取日志配置文件,即 resources 文件夹下的配置文件
  config: classpath:log4j2.xml
  level:
    # 默认整个项目的日志级别
    root: info
    # 如果你想细化项目日志级别,com.cbf下的日志级别是info
    # com.cbf: info

添加日志配置文件

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

  <!-- 日志存放路径(当前项目的 logs 文件夹) -->
  <property name="log.path" value="./logs"/>

  <!-- 日志输出格式 -->
  <property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n"/>

  <!-- 控制台输出 -->
  <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>${log.pattern}</pattern>
    </encoder>
  </appender>

  <!-- INFO 级别日志输出 -->
  <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${log.path}/sys-info.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!-- 按天滚动 -->
      <fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
      <!-- 保留60天历史 -->
      <maxHistory>60</maxHistory>
    </rollingPolicy>
    <encoder>
      <pattern>${log.pattern}</pattern>
    </encoder>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>INFO</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
  </appender>

  <!-- ERROR 级别日志输出 -->
  <appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${log.path}/sys-error.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${log.path}/sys-error.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>60</maxHistory>
    </rollingPolicy>
    <encoder>
      <pattern>${log.pattern}</pattern>
    </encoder>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>ERROR</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
  </appender>

  <!-- 根日志记录器:所有未指定 logger 的日志都会走这里 -->
  <root level="info">
    <!-- 输出到控制台。 -->
    <appender-ref ref="console"/>
    <!-- 输出到 sys-info.log 文件(只记录 INFO 级别)。-->
    <appender-ref ref="file_info"/>
    <!-- 输出到 sys-error.log 文件(只记录 ERROR 级别)。 -->
    <appender-ref ref="file_error"/>
  </root>
</configuration>

效果检验

项目启动后,

  • 控制台将输出全部日志内容。
  • 项目根目录会生成 logs/ 文件夹。
  • 根据不同级别,日志被写入:
  • sys-info.log:包含 INFO 及以上所有级别
  • sys-error.log:只包含 ERROR 级别日志
  • 日志每天自动生成新文件,如:all.2025-06-05.log

输出效果如下: