日志记录

Spring Boot 没有强制的日志记录依赖项,除了 Commons Logging API,它通常由 Spring Framework 的 spring-jcl 模块提供。要使用 Logback,您需要在类路径中包含它和 spring-jcl。推荐的做法是通过 starters,它们都依赖于 spring-boot-starter-logging。对于 Web 应用程序,您只需要 spring-boot-starter-web,因为它依赖于日志记录 starter。如果您使用 Maven,以下依赖项会为您添加日志记录

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>

Spring Boot 有一个 LoggingSystem 抽象,它尝试根据类路径的内容配置日志记录。如果 Logback 可用,它就是首选。

如果您需要对日志记录进行的唯一更改是设置各种记录器的级别,您可以在 application.properties 中使用“logging.level”前缀来执行此操作,如下例所示

  • 属性

  • YAML

logging.level.org.springframework.web=debug
logging.level.org.hibernate=error
logging:
  level:
    org.springframework.web: "debug"
    org.hibernate: "error"

您还可以使用 logging.file.name 设置将日志写入的文件的位置(除了控制台之外)。

要配置日志记录系统的更细粒度的设置,您需要使用 LoggingSystem 支持的本机配置格式。默认情况下,Spring Boot 从系统默认位置获取本机配置(例如 Logback 的 classpath:logback.xml),但您可以使用 logging.config 属性设置配置文件的位置。

配置 Logback 进行日志记录

如果您需要对 logback 应用超出使用 application.properties 可以实现的自定义,则需要添加一个标准 logback 配置文件。您可以将 logback.xml 文件添加到 classpath 的根目录,以便 logback 找到它。如果您想使用 Spring Boot Logback 扩展,也可以使用 logback-spring.xml

Logback 文档有一个 专门的部分涵盖配置,并提供了一些详细信息。

Spring Boot 提供了许多 logback 配置,可以将这些配置 included 到您自己的配置中。这些 include 旨在允许重新应用某些常见的 Spring Boot 约定。

org/springframework/boot/logging/logback/ 下提供了以下文件

  • defaults.xml - 提供转换规则、模式属性和常见记录器配置。

  • console-appender.xml - 使用 CONSOLE_LOG_PATTERN 添加一个 ConsoleAppender

  • file-appender.xml - 使用 FILE_LOG_PATTERNROLLING_FILE_NAME_PATTERN 添加一个 RollingFileAppender,并使用适当的设置。

此外,还提供了一个旧版 base.xml 文件,以兼容早期版本的 Spring Boot。

一个典型的自定义 logback.xml 文件看起来像这样

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
	<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
	<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
	<root level="INFO">
		<appender-ref ref="CONSOLE" />
	</root>
	<logger name="org.springframework.web" level="DEBUG"/>
</configuration>

您的 logback 配置文件还可以利用 LoggingSystem 为您创建的系统属性

  • ${PID}:当前进程 ID。

  • ${LOG_FILE}:是否在 Boot 的外部配置中设置了 logging.file.name

  • ${LOG_PATH}:是否在 Boot 的外部配置中设置了 logging.file.path(表示日志文件所在的目录)。

  • ${LOG_EXCEPTION_CONVERSION_WORD}:是否在 Boot 的外部配置中设置了 logging.exception-conversion-word

  • ${ROLLING_FILE_NAME_PATTERN}:是否在 Boot 的外部配置中设置了 logging.pattern.rolling-file-name

Spring Boot 还通过使用自定义 Logback 转换器在控制台上(但不在日志文件中)提供了一些漂亮的 ANSI 彩色终端输出。有关示例,请参阅 defaults.xml 配置中的 CONSOLE_LOG_PATTERN

如果 Groovy 在 classpath 中,您还应该能够使用 logback.groovy 配置 Logback。如果存在,则优先考虑此设置。

Groovy 配置不支持 Spring 扩展。不会检测到任何 logback-spring.groovy 文件。

为仅文件输出配置 Logback

如果您想禁用控制台日志记录并将输出仅写入文件,则需要一个自定义的 logback-spring.xml,该文件导入 file-appender.xml 但不导入 console-appender.xml,如下例所示

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
	<include resource="org/springframework/boot/logging/logback/defaults.xml" />
	<property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}/}spring.log}"/>
	<include resource="org/springframework/boot/logging/logback/file-appender.xml" />
	<root level="INFO">
		<appender-ref ref="FILE" />
	</root>
</configuration>

您还需要将 logging.file.name 添加到您的 application.propertiesapplication.yaml 中,如下例所示

  • 属性

  • YAML

logging.file.name=myapplication.log
logging:
  file:
    name: "myapplication.log"

为日志记录配置 Log4j

如果 Spring Boot 在 classpath 中,它支持 Log4j 2 进行日志记录配置。如果您使用 starter 来组装依赖项,则必须排除 Logback,然后包含 Log4j 2。如果您不使用 starter,则需要在 Log4j 2 之外提供(至少)spring-jcl

即使需要进行一些调整,建议的路径也是通过 starter。以下示例展示了如何在 Maven 中设置 starter

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter</artifactId>
	<exclusions>
		<exclusion>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

Gradle 提供了几种不同的方式来设置 starter。一种方法是使用 模块替换。为此,请声明对 Log4j 2 starter 的依赖项,并告诉 Gradle 应将默认日志记录 starter 的任何出现替换为 Log4j 2 starter,如下例所示

dependencies {
	implementation "org.springframework.boot:spring-boot-starter-log4j2"
	modules {
		module("org.springframework.boot:spring-boot-starter-logging") {
			replacedBy("org.springframework.boot:spring-boot-starter-log4j2", "Use Log4j2 instead of Logback")
		}
	}
}
Log4j 启动器收集了常见日志记录要求的依赖项(例如,让 Tomcat 使用 java.util.logging 但使用 Log4j 2 配置输出)。
要确保使用 java.util.logging 执行的调试日志记录被路由到 Log4j 2,请通过将 java.util.logging.manager 系统属性设置为 org.apache.logging.log4j.jul.LogManager 来配置其 JDK 日志记录适配器

使用 YAML 或 JSON 配置 Log4j 2

除了其默认 XML 配置格式外,Log4j 2 还支持 YAML 和 JSON 配置文件。要配置 Log4j 2 以使用备用配置文件格式,请将适当的依赖项添加到类路径并为配置文件命名以匹配您选择的格式,如下例所示

格式 依赖项 文件名

YAML

com.fasterxml.jackson.core:jackson-databind + com.fasterxml.jackson.dataformat:jackson-dataformat-yaml

log4j2.yaml + log4j2.yml

JSON

com.fasterxml.jackson.core:jackson-databind

log4j2.json + log4j2.jsn

使用复合配置配置 Log4j 2

Log4j 2 支持将多个配置文件组合成单个复合配置。要在 Spring Boot 中使用此支持,请使用一个或多个辅助配置文件的位置配置 logging.log4j2.config.override。辅助配置文件将与主配置合并,无论主配置的来源是 Spring Boot 的默认值、标准位置(如 log4j.xml)还是由 logging.config 属性配置的位置。