SpringBoot日志详解

一、简介

Spring Boot中的日志抽象确实是SLF4J（Simple Logging Facade for Java），它是一个面向Java的简单日志门面，旨在将各种现有的日志框架映射到基于统一抽象接口的通用API上。

通过使用SLF4J，应用程序可以将日志记录器与任何后端日志实现（如Log4j、Logback、Java Util Logging等）进行解耦。这使得在不更改应用程序代码的情况下，可以轻松地在不同的日志实现之间切换。

而Spring Boot中默认的日志实现是Logback，它是由同一作者创建的log4j框架的改进版。

Logback是一个功能强大、快速且易于配置的日志框架，它提供了多种日志输出渠道（包括控制台、文件、远程套接字、可插拔的多种数据库支持等），并支持过滤器、多线程等在内的一系列高级特性。

当然，你也可以在Spring Boot中使用各种不同的日志框架，比如Log4j2、SLF4j等，只需要在项目中引入对应的依赖，按照对应的配置方式即可。 

二、日志的抽象与实现

SpringBoot选用 SLF4j（日志抽象层）和logback（日志实现）

简化的日志调用关系图

三、配置文件

2.1 application.properties

在 application.properties 文件中，logging.config 属性用于指定 Logback 配置文件的位置。

Logback 是一个流行的 Java 日志框架，它提供了一种灵活的方式来记录应用程序日志。

如果您没有在 application.properties 文件中设置 logging.config 属性，则 Spring Boot 将使用默认的 Logback 配置。

默认情况下，Spring Boot 会在类路径下查找名为 logback-spring.xml 或 logback.xml 的文件，并使用找到的第一个文件作为 Logback 配置文件。如果找不到任何文件，则 Spring Boot 将使用 Logback 的默认配置。 

如果您没有在应用程序中显式地配置 Logback，则 Spring Boot 将使用 Logback 的默认配置。默认情况下，Logback 的默认配置将日志事件输出到控制台，并将日志级别设置为 INFO。

例如，如果您的 Logback 配置文件名为 logback-spring.xml，并且位于应用程序的根目录下，则您可以在 application.properties 文件中添加以下行

logging.config=classpath:logback-spring.xml

注意：classpath前缀表示该文件位于应用程序的类路径下。

2.2 application.properties与logback-spring.xml的优先级

当在application.properties/application.yml和logback-spring.xml中都配置了同一属性时（比如logging.level.root），Spring Boot会优先读取application.properties/application.yml中的配置，而忽略logback-spring.xml中的配置。

这是因为在Spring Boot的日志系统中，logging属性优先级最高，即使你在 logback-spring.xml 中配置了某个属性，如果在 application.properties/application.yml 中发现了同名的属性，则会覆盖logback-spring.xml中的配置。

这也是Spring Boot日志配置中logging属性优先级高于logback-spring.xml中的原因。

因此，在实际应用中，如果您需要对日志输出级别、使用附加器等进行配置，推荐使用logback-spring.xml这样的日志配置文件，它可以实现更加灵活和细粒度的配置，而application.properties/application.yml中的配置主要用于简洁明了的全局配置。

2.3 自定义MDC

示例：

2023-06-07 10:21:02.971 INFO [,,,] 14676 --- [ main] c.e.s.SpringCloudSleuthDemoApplication : Started SpringCloudSleuthDemoApplication in 4.397 seconds (JVM running for 5.68)

这个日志格式中，[,,,]这一部分表示MDC（Mapped Diagnostic Context），它是一种记录应用程序信息的机制，在Logback框架和Spring Cloud Sleuth中都有应用。

MDC机制通常用于在系统运行时，记录一些信息，在日志输出时将这些信息一并输出，帮助我们在分析日志时能够更轻松地定位问题。例如，可以记录请求ID、用户IP、客户端信息等，然后在日志中输出这些信息，方便跟踪和排查。

在Spring Cloud Sleuth中，MDC中一般会包含Trace ID、Span ID，代表当前所在的请求链路信息，用于服务追踪和调用链路追踪。[,,,]这种空的中括号表示当前日志所在的上下文中没有设置MDC信息。

需要注意的是，MDC中记录的信息必须是线程私有的，不同线程之间不能共用MDC。若要在多线程环境下使用MDC，一般会配合使用ThreadLocal等线程安全的工具。

Logback支持自定义MDC信息。可以通过在代码中设置MDC，然后在日志输出时通过%X占位符输出MDC中的数据。比如：

MDC.put("requestId", "123456"); logger.info("This is a test log message with requestId={}", MDC.get("requestId"));

在上面的代码中，我们在MDC中添加了一个名为requestId的键值对，然后在日志记录时使用了%X占位符将requestId的值输出。

在Logback的配置文件中也可以指定每个appender是否包含MDC信息，举个例子

<appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - [%X{requestId}] %msg%n</pattern> </encoder> </appender>

在上面的配置中，我们使用了%X{requestId}来输出MDC中名为requestId的键的值，将值输出到日志消息的括号中。

需要注意的是，在Logback中设置MDC信息可能会对性能造成影响，过多或过大的MDC数据可能会导致GC times过长等问题。为了避免这些问题，应该尽量精简MDC信息，只记录必要的信息。并且，MDC信息应该在不使用时及时清除。

在Spring Cloud Sleuth中，MDC默认记录如下

名称	说明
appname	记录跨度的应用程序的名称
spanId	发生的特定操作的ID
traceId	包含span的延迟图的ID
exportable	是否将日志导出到Zipkin

2016-02-02 15:31:01.936 INFO [bar,46ab0d418373cbc9,46ab0d418373cbc9,false] 23030 --- [nio-8081-exec-4] ...