### Spring Boot 日志格式配置方法 Spring Boot 提供了多种方式来配置日志格式，主要依赖于内置的日志框架（如 Logback）。以下是详细的配置说明： #### 1. **通过 `application.properties` 或 `application.yml` 配置日志格式** 可以通过简单的键值对形式快速设置日志的基础格式。例如： ```properties logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n ``` 上述配置分别指定了控制台 (`console`) 和文件 (`file`) 输出的日志格式[^1]。 - `%d`: 表示日期时间戳，默认格式为 ISO8601。 - `%thread`: 当前线程名称。 - `%level`: 日志级别（如 DEBUG、INFO 等）。 - `%logger`: 记录器名称。 - `%msg`: 日志消息内容。 - `%n`: 换行符。 如果使用 YAML 文件，则可以这样写： ```yaml logging: pattern: console: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n" file: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n" ``` --- #### 2. **高级日志格式配置：自定义 Logback XML 文件** 对于更复杂的需求，推荐使用 Logback 的 XML 配置文件来自定义日志格式。创建名为 `logback-spring.xml` 的文件，并放置在 `src/main/resources/` 下面。以下是一个完整的例子： ```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.rolling.RollingFileAppender"> <file>logs/app.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>logs/app-%d{yyyy-MM-dd}.log</fileNamePattern> <maxHistory>30</maxHistory> </rollingPolicy> <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> ``` 在这个配置中： - `<pattern>` 节点用于指定日志的具体格式。 - 使用 `TimeBasedRollingPolicy` 来实现按天滚动的日志文件管理功能。 --- #### 3. **结合分布式追踪 ID 注入日志字段** 为了支持分布式系统中的链路追踪，可以在日志中加入 Trace ID 和 Span ID 等信息。这通常需要借助 MDC（Mapped Diagnostic Context）机制。例如： ```java import org.slf4j.MDC; @RestController public class ExampleController { @GetMapping("/example") public String example() { // 设置 Trace ID 到 MDC 中 MDC.put("X-B3-TraceId", "12345"); MDC.put("X-B3-SpanId", "67890"); log.info("This is an example log with trace info."); // 清除 MDC 上下文 MDC.clear(); return "OK"; } } ``` 随后，在日志格式中引入这些字段即可： ```properties logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] X-B3-TraceId:%X{X-B3-TraceId}-X-B3-SpanId:%X{X-B3-SpanId} %-5level %logger{36} - %msg%n ``` 以上配置会在每条日志前自动打印对应的 Trace ID 和 Span ID[^2]。 --- #### 4. **动态加载外部配置文件** 如果希望将日志配置独立存储在外置文件中，可通过如下方式进行加载： ```yaml spring: config: import: optional:classpath:/external-log-config/logback.xml ``` 这种做法特别适用于生产环境下的集中化配置管理[^3]。 --- #### 5. **调试 HTTP 请求和响应的详细日志** 对于需要捕获 HTTP 请求和响应细节的情况，可以将相关组件的日志级别设置为 TRACE： ```yaml logging: level: root: INFO org.springframework.web: TRACE ``` 此配置会记录所有的请求路径、参数以及响应体等内容[^4]。 --- ###