日志记录

Spring Boot 没有强制的日志依赖，除了 Commons Logging API，它通常由 Spring Framework 的 spring-jcl 模块提供。要使用 Logback，你需要将它和 spring-jcl 包含在类路径中。推荐的方式是通过 Starter，它们都依赖于 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 文件添加到类路径的根目录，供 Logback 查找。如果你想使用 Spring Boot Logback 扩展，你也可以使用 logback-spring.xml。

Logback 文档有 一个专门的部分详细介绍了配置。

Spring Boot 提供了许多 Logback 配置，可以被 include 到你自己的配置中。这些包含旨在允许重新应用某些常见的 Spring Boot 约定。

以下文件位于 org/springframework/boot/logging/logback/ 下

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

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

  • structured-console-appender.xml - 使用 CONSOLE_LOG_STRUCTURED_FORMAT 中的结构化日志记录添加 ConsoleAppender。

  • file-appender.xml - 使用 FILE_LOG_PATTERN 和 ROLLING_FILE_NAME_PATTERN 添加一个带有适当设置的 RollingFileAppender。

  • structured-file-appender.xml - 使用 ROLLING_FILE_NAME_PATTERN 和 FILE_LOG_STRUCTURED_FORMAT 中的结构化日志记录添加一个 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 在类路径上，你也应该能够使用 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.properties 或 application.yaml 中，如以下示例所示：

  • 属性

  • YAML

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

配置 Log4j 进行日志记录

如果 Log4j 2 在类路径上，Spring Boot 支持其进行日志配置。如果你使用 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 Starter 汇集了常见日志记录要求的依赖项（例如让 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 属性配置的位置。

Log4j2 覆盖配置文件的位置可以前缀为 optional:。例如，optional:classpath:log4j2-override.xml 表示只有当资源存在时才应该加载 log4j2-override.xml。
© . This site is unofficial and not affiliated with VMware.