Spring Boot 2 中的日志记录和 Logback 入门指南

2023-10-17 18:35:57

Spring Boot 2 是一个强大的 Java 框架，被广泛应用于企业级应用开发。日志记录对于快速定位和解决问题至关重要。Spring Boot 2 中的默认日志记录库是 Commons Logging，但它支持您使用其他日志记录库，例如 Logback。

Logback 是一个非常受欢迎的日志记录库，因为它提供了强大的功能和灵活的配置选项。在本文中，我们将向您展示如何配置 Spring Boot 2 中的 Logback。

配置 Logback

Spring Boot 2 为 Logback 提供了自动配置支持。这表示您无需在 Spring Boot 应用程序中手动配置 Logback。但是，您可能希望自定义 Logback 配置，以满足您的特定需求。

要在 Spring Boot 应用程序中自定义 Logback 配置，您可以使用以下两种方法之一：

使用 logging.config 属性。这种方法允许您指定一个 Logback 配置文件的路径。
使用 spring.logging 属性。这种方法允许您直接在应用程序的属性文件中配置 Logback。

Logback 配置示例

以下是一个 Logback 配置示例：

logging.config=classpath:logback.xml

这个配置告诉 Spring Boot 2 从 classpath:logback.xml 文件加载 Logback 配置。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

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

这个 Logback 配置文件指定了以下内容：

CONSOLE appender 将日志记录输出到控制台。
PatternLayoutEncoder 将日志记录信息格式化为人类可读的文本。
root logger 的级别设置为 INFO。这意味着只有 INFO 级别的日志记录信息才会被输出到控制台。

日志记录 API

Spring Boot 2 提供了几个日志记录 API，您可以使用它们来记录日志信息。最常用的日志记录 API 是 Logger 接口。

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

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

  public void log() {
    logger.info("This is an info message.");
    logger.warn("This is a warning message.");
    logger.error("This is an error message.");
  }
}