玩转 Springboot 日志：轻松实现控制台和文件输出

2022-11-22 03:14:46

让你的 Springboot 日志如春风般绽放！

背景

日志记录是软件开发的命脉，它帮助我们洞察应用程序的运行状况、识别问题和进行调试。Springboot 作为 Java 开发者的宠儿，提供了强大的日志功能，让我们轻松记录和管理日志。

第一步：导入依赖

在你的 Springboot 项目中，添加以下依赖：

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>1.7.36</version>
</dependency>
<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.2.11</version>
</dependency>

第二步：配置日志

在项目根目录创建 logback.xml 文件，并添加以下配置：

<?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} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

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

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

第三步：使用日志

在代码中，使用 org.slf4j.Logger 和 LoggerFactory 来记录日志：

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("春天来了，世界焕然一新！");
  }
}

优势

清晰的日志输出： 自定义的日志格式提供了清晰易读的日志输出，方便分析和故障排除。
文件和控制台输出： 日志可以同时输出到文件和控制台，为不同目的提供便利性。
灵活的日志级别： 通过配置 root 元素的 level 属性，可以轻松控制日志记录的粒度。
强大的 Logback 特性： Logback 提供丰富的特性，如过滤器、附加器和布局，增强了日志管理的灵活性。

常见问题解答

1. 如何更改日志级别？

修改 logback.xml 中 root 元素的 level 属性，例如：

<root level="DEBUG">

2. 如何添加自定义日志附加器？

在 logback.xml 中声明一个新的附加器，并将其添加到 root 元素：

<appender name="MY_APPENDER" class="ch.qos.logback.core.ConsoleAppender">
  ...
</appender>

<root level="INFO">
  <appender-ref ref="CONSOLE" />
  <appender-ref ref="FILE" />
  <appender-ref ref="MY_APPENDER" />
</root>

3. 如何过滤日志消息？

使用过滤器来控制哪些日志消息输出，例如：

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  <level>WARN</level>
</filter>

<appender name="FILE" class="ch.qos.logback.core.FileAppender">
  ...
  <filter>myFilter</filter>
</appender>

4. 如何使用日志上下文？

日志上下文提供了在不同线程中隔离日志的功能，例如：

MDC.put("requestId", "12345");
logger.info("处理请求...");
MDC.remove("requestId");

5. 如何处理日志归档？

Logback 提供了滚动归档器，例如：

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  ...
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>logs/springboot-%d{yyyy-MM-dd}.log</fileNamePattern>
  </rollingPolicy>
</appender>