- [26、日志记录](pages/spring-boot-features.md#boot-features-logging)

- [26.1、日志格式](pages/spring-boot-features.md#boot-features-logging-format)

- [26.2、控制台输出](pages/spring-boot-features.md#boot-features-logging-console-output)

- [26.2.1、着色输出](pages/spring-boot-features.md#boot-features-logging-color-coded-output)

- [26.3、文件输出](pages/spring-boot-features.md#boot-features-logging-file-output)

- [26.4、日志等级](pages/spring-boot-features.md#boot-features-custom-log-levels)

- [26.5、日志组](pages/spring-boot-features.md#boot-features-custom-log-groups)

- [26.6、自定义日志配置](pages/spring-boot-features.md#boot-features-custom-log-configuration)

- [26.7、Logback 扩展](pages/spring-boot-features.md#boot-features-logback-extensions)

- [26.7.1、特定 Profile 配置](pages/spring-boot-features.md#_profile_specific_configuration)

- [26.7.2、环境属性](pages/spring-boot-features.md#_environment_properties)

- [27、JSON](pages/spring-boot-features.md#boot-features-json)

- [27.1、Jackson](pages/spring-boot-features.md#boot-features-json-jackson)

- [27.2、Gson](pages/spring-boot-features.md#boot-features-json-gson)

- [27.3、JSON-B](pages/spring-boot-features.md#boot-features-json-json-b)

- 日期和时间：毫秒精度，易于排序。

- 日志级别：`ERROR`、`WARN`、`INFO`、`DEBUG` 或 `TRACE`。

- 进程 ID。

- 一个 `---` 分隔符，用于区分实际日志内容的开始。

- 线程名称：在方括号中（可能会截断控制台输出）。

- 日志记录器名称：这通常是源类名称（通常为缩写）。

- 日志内容。

%clr(%5p)

%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}

<a id="boot-features-custom-log-groups"></a>

将相关记录器组合在一起以便可以同时配置，这通常很有用。例如，您可以更改**所有** Tomcat 相关记录器的日志记录级别，但您无法轻松记住顶层的包名。

为了解决这个问题，Spring Boot 允许您在 Spring `Environment` 中定义日志记录组。例如，以下通过将 **tomcat** 组添加到 `application.properties` 来定义 **tomcat** 组：

logging.group.tomcat=org.apache.catalina, org.apache.coyote, org.apache.tomcat

定义后，您可以使用一行配置来更改组中所有记录器的级别：

logging.level.tomcat=TRACE

Spring Boot 包含以下预定义的日志记录组，可以直接使用：

| 名称 | 日志记录器 |

| --- | --- |

| web | `org.springframework.core.codec`、`org.springframework.http`、`org.springframework.web` |

| sql | `org.springframework.jdbc.core`、`org.hibernate.SQL` |

<a id="boot-features-custom-log-configuration"></a>

可以通过在 classpath 中引入适合的库来激活各种日志记录系统，并且可以通过在 classpath 的根目录中或在以下 Spring `Environment` 属性指定的位置提供合适的配置文件来进一步自定义：`logging.config`。

您可以使用 `org.springframework.boot.logging.LoggingSystem` 系统属性强制 Spring Boot 使用特定的日志记录系统。该值应该是一个实现了 `LoggingSystem` 的类的完全限定类名。您还可以使用 `none` 值完全禁用 Spring Boot 的日志记录配置。

**注意**

根据您的日志记录系统，将加载以下文件：

| 日志记录系统 | 文件 |

| --- | --- |

| Logback | `logback-spring.xml`、`logback-spring.groovy`、`logback.xml` 或者 `logback.groovy` |

| Log4j2 | `log4j2-spring.xml` 或者 `log4j2.xml` |

| JDK（Java Util Logging） | `logging.properties` |

**注意**

**警告**

为了进行自定义，部分其他属性会从 Spring `Environment` 传输到 System 属性，如下表所述：

| Spring Environment | 系统属性 | 说明 |

| --- | --- | --- |

| `logging.exception-conversion-word` | `LOG_EXCEPTION_CONVERSION_WORD` | 记录异常时使用的转换字。 |

| `logging.file` | `LOG_FILE` | 如果已定义，则在默认日志配置中使用它。 |

| `logging.file.max-size` | `LOG_FILE_MAX_SIZE` | 最大日志文件大小（如果启用了 LOG_FILE）。（仅支持默认的 Logback 设置。） |

|`logging.file.max-history` | `LOG_FILE_MAX_HISTORY` | 要保留的归档日志文件最大数量（如果启用了 LOG_FILE）。（仅支持默认的 Logback 设置。） |

| `logging.path` | `LOG_PATH` | 如果已定义，则在默认日志配置中使用它。 |

| `logging.pattern.console` | `CONSOLE_LOG_PATTERN` | 要在控制台上使用的日志模式（stdout）。（仅支持默认的 Logback 设置。） |

| `logging.pattern.dateformat` | `LOG_DATEFORMAT_PATTERN` | 日志日期格式的 Appender 模式。（仅支持默认的 Logback 设置。） |

| `logging.pattern.file` | `FILE_LOG_PATTERN` | 要在文件中使用的日志模式（如果启用了 `LOG_FILE`）。（仅支持默认的 Logback 设置。） |

| `logging.pattern.level` | `LOG_LEVEL_PATTERN` | 渲染日志级别时使用的格式（默认值为 `％5p`）。（仅支持默认的 Logback 设置。） |

| `PID` | `PID` | 当前进程 ID（如果可能，则在未定义为 OS 环境变量时发现）。 |

所有受支持的日志记录系统在解析其配置文件时都可以参考系统属性。有关示例，请参阅 `spring-boot.jar` 中的默认配置：

- [Logback](https://github.com/spring-projects/spring-boot/tree/v2.1.1.RELEASE/spring-boot-project/spring-boot/src/main/resources/org/springframework/boot/logging/logback/defaults.xml)

- [Log4j 2](https://github.com/spring-projects/spring-boot/tree/v2.1.1.RELEASE/spring-boot-project/spring-boot/src/main/resources/org/springframework/boot/logging/log4j2/log4j2.xml)

- [Java Util logging](https://github.com/spring-projects/spring-boot/tree/v2.1.1.RELEASE/spring-boot-project/spring-boot/src/main/resources/org/springframework/boot/logging/java/logging-file.properties)

**提示**

**提示**

<blockquote>

您可以通过仅覆盖 `LOG_LEVEL_PATTERN`（或带 Logback 的 `logging.pattern.level`）将 MDC 和其他特别的内容添加到日志行。例如，如果使用 `logging.pattern.level=user:%X{user} %5p`，则默认日志格式包含 **user** MDC 项（如果存在），如下所示:

</blockquote>

<a id="boot-features-logback-extensions"></a>

Spring Boot 包含许多 Logback 扩展，可用于进行高级配置。您可以在 `logback-spring.xml` 配置文件中使用这些扩展。

**注意**

**警告**

<a id="_profile_specific_configuration"></a>

`<springProfile>` 标签允许您根据激活的 Spring profile 选择性地包含或排除配置部分。在 `<configuration>` 元素中的任何位置都支持配置 profile。使用 `name` 属性指定哪个 proifle 接受配置。`<springProfile>` 标记可以包含简单的 proifle 名称（例如 `staging`）或 profile 表达式。profile 表达式允许表达更复杂的 profile 逻辑，例如 `production & (eu-central | eu-west)`。有关详细信息，请查阅[参考指南](https://docs.spring.io/spring/docs/5.1.3.RELEASE/spring-framework-reference/core.html#beans-definition-profiles-java)。以下清单展示了三个示例 profile：

<springProfile name="staging">

<!-- configuration to be enabled when the "staging" profile is active -->

</springProfile>

<springProfile name="dev | staging">

<!-- configuration to be enabled when the "dev" or "staging" profiles are active -->

</springProfile>

<springProfile name="!production">

<!-- configuration to be enabled when the "production" profile is not active -->

</springProfile>

<a id="_environment_properties"></a>

使用 `<springProperty>` 标记可以让您暴露 Spring 环境（`Environment`）中的属性，以便在 Logback 中使用。如果在 Logback 配置中访问来自 `application.properties` 文件的值，这样做很有用。标签的工作方式与 Logback 的标准 `<property>` 标签类似。但是，您可以指定属性（来自 `Environment`）的 `source`，而不是指定直接的 `value`。如果需要将属性存储在 `local` 范围以外的其他位置，则可以使用 `scope` 属性。如果需要回退值（如果未在 `Environment` 中设置该属性），则可以使用 `defaultValue` 属性。以下示例展示了如何暴露属性以便在 Logback 中使用：

<springProperty scope="context" name="fluentHost" source="myapp.fluentd.host"

defaultValue="localhost"/>

<appender name="FLUENT" class="ch.qos.logback.more.appenders.DataFluentAppender">

<remoteHost>${fluentHost}</remoteHost>

...

</appender>

**注意**

<a id="boot-features-json"></a>

Spring Boot 为三个 JSON 映射库提供了内置集成：

- GSON

- Jackson

- JSON-B

Jackson 是首选和默认的库。

<a id="boot-features-json-jackson"></a>

Spring Boot 提供了 Jackson 的自动配置，Jackson 是 `spring-boot-starter-json` 的一部分。当 Jackson 在 classpath 上时，会自动配置 `ObjectMapper` bean。Spring Boot 提供了几个配置属性来[自定义 `ObjectMapper` 的配置](howto.md#howto-customize-the-jackson-objectmapper)。

<a id="boot-features-json-gson"></a>

Spring Boot 提供 Gson 的自动配置。当 Gson 在 classpath 上时，会自动配置 `Gson` bean。Spring Boot 提供了几个 `spring.gson.*` 配置属性来自定义配置。为了获得更多控制，可以使用一个或多个 `GsonBuilderCustomizer` bean。

<a id="boot-features-json-json-b"></a>

Spring Boot 提供了 JSON-B 的自动配置。当 JSON-B API 和实现在 classpath 上时，将自动配置 `Jsonb` bean。首选的 JSON-B 实现是 Apache Johnzon，它提供了依赖管理。