SpringBoot 3.2.0 基于Logback定制日志框架

日志门面和日志实现

日志门面（如Slf4j）就是一个标准，同JDBC一样来制定“规则”，把不同的日志系统的实现进行了具体的抽象化，只提供了统一的日志使用接口。而Logback、log4j等具体的日志系统就如同MySQL驱动、PGSQL驱动一样，才是日志功能的真正实现。

SpringBoot默认日志框架

SpringBoot使用Slf4j作为日志门面，Logback作为默认的日志实现。在SpringBoot的pom.xml中，依赖为：

org.springframework.boot spring-boot-starter-logging

此依赖在SpringBoot Starter包中包含，所以在SpringBoot项目中导入 spring-boot-starter 后可直接使用：

org.springframework.boot spring-boot-starter

打印日志

基于LoggerFactory创建日志记录器实例

import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplicationpublic class LoggingApplication { private static final Logger logger = LoggerFactory.getLogger(LoggingApplication.class); public static void main(String[] args) { logger.info("LoggingApplication start..."); SpringApplication.run(LoggingApplication.class, args); logger.info("LoggingApplication end..."); }}

引入lombok依赖，通过注解@Slf4j创建日志记录器实例

org.springframework.boot spring-boot-starter org.projectlombok lombok import lombok.extern.slf4j.Slf4j;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication; @Slf4j@SpringBootApplicationpublic class LoggingApplication { public static void main(String[] args) { log.info("LoggingApplication start..."); SpringApplication.run(LoggingApplication.class, args); log.info("LoggingApplication end..."); }}

配置Logback

默认配置

SpringBoot推荐将配置文件名称命名为logback-spring.xml表示这是SpringBoot下Logback专用的配置，可以使用SpringBoot 的高级Pro?le功能，它的内容类似于这样：

最外层由configuration包裹，一旦编写，那么就会替换默认的配置，所以如果内部什么都不写的话，那么会导致我们的SpringBoot项目没有配置任何日志输出方式，控制台也不会打印日志。

也可在配置文件中指定要使用的日志配置，如application.yml中通过配置 logging.config指定要使用的日志配置。

logging: config: classpath:logback-spring.xml

基于SpringBoot默认Logback配置进行定制

SpringBoot 的默认Logback文件可在依赖项中找到。路径为：org/springframework/boot/logging/logback/defaults.xml

在配置文件中对默认配置进行引用，及编写定制配置覆盖默认配置。

${CONSOLE_LOG_THRESHOLD} ${CONSOLE_LOG_PATTERN} ${CONSOLE_LOG_CHARSET}

配置日志信息输出到文件

logback-spring.xml 添加如下内容：

${FILE_LOG_THRESHOLD} ${FILE_LOG_PATTERN} ${FILE_LOG_CHARSET} ${LOG_FILE} ${LOGBACK_ROLLINGPOLICY_FILE_NAME_PATTERN:-${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz} ${LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START:-false} ${LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE:-10MB} ${LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP:-0} ${LOGBACK_ROLLINGPOLICY_MAX_HISTORY:-7}

MDC机制

Slf4j官方解释

MDC全称Mapped Diagnostic Context（映射诊断上下文），“映射诊断上下文” 本质上是由日志记录框架维护的映射，其中应用程序代码提供键值对，然后可以由日志记录框架将其插入日志消息中。MDC数据在过滤消息或触发某些操作时也非常有用。

通俗的说就是可以将特定的信息（如请求Id，链路Id），通过MDC机制注入到当前日志线程的上下文中，将信息在日志中记录、输出。

MDC的使用

MDC 常用的三个方法：

MDC.put(key,value) 注入值

MDC.remove(key) 移除指定的MDC注入信息

MDC.clear 移除所有当前线程的MDC注入信息

MDC注入属性配置：

在logback-spring.xml文件的输出格式中添加需要注入的KEY信息与代码注入的信息相对应。假定我需要注入当前用户的Id信息，且设置key为user-id

代码：

import lombok.extern.slf4j.Slf4j;import org.slf4j.MDC;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication; import java.util.UUID; @Slf4j@SpringBootApplicationpublic class LoggingApplication { public static void main(String[] args) { SpringApplication.run(LoggingApplication.class, args); String mdcKey = "user-id"; log.info("Logging before MDC put..."); MDC.put("mdcKey", UUID.randomUUID.toString); log.info("Logging after MDC put..."); MDC.clear; log.info("Logging after MDC clear..."); }}

logback-spring.xml

${CONSOLE_LOG_THRESHOLD} ${CONSOLE_LOG_PATTERN} ${CONSOLE_LOG_CHARSET}

使用方式：

通过注册拦截器或过滤器，在业务开始前获取到相关信息（请求Id，操作人Id），将相关信息通过MDC自动注入到当前线程中，实现关键信息记录。 在创建子线程时，需要通过MDC.getCopyOfContextMap方法获取到当前线程的MDC注入相关信息，传递给子线程，才能在子线打印日志信息时获取到父线程MDC的注入信息。

Logback参考配置

${CONSOLE_LOG_THRESHOLD} ${CONSOLE_LOG_PATTERN} ${CONSOLE_LOG_CHARSET} ${FILE_LOG_THRESHOLD} ${FILE_LOG_PATTERN} ${FILE_LOG_CHARSET} ${LOG_FILE} ${FILE_NAME_PATTERN} ${LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START} ${LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE} ${LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP} ${LOGBACK_ROLLINGPOLICY_MAX_HISTORY}