logback-spring.xml中控制台日志模式不生效问题排查

问题根源分析 #

你遇到的核心问题是重复定义了同名的CONSOLE Appender，以及对Spring Boot与Logback配置加载逻辑的误解：

1. 你先引入了Spring Boot自带的org/springframework/boot/logging/logback/console-appender.xml，这个文件已经预先定义了一个名为CONSOLE的ConsoleAppender，并且使用了默认的日志格式。
2. 之后你又手动定义了一个同名的CONSOLE Appender，但Logback在加载配置时，会优先使用先加载的那个（也就是Spring Boot默认的），所以你自定义的Pattern根本没被实际使用。
3. 最初用application.properties时出现重复日志，是因为Logback默认的additivity属性为true——你的com.mypackage Logger会把日志传递给父Logger（root），导致同一日志被控制台输出两次。

两种可行的解决方案 #

方案一：结合application.properties与logback-spring.xml（推荐）

这种方式最简洁，利用Spring Boot的自动配置能力，只在logback-spring.xml里处理Logger的additivity和级别，日志格式交给application.properties维护：

application.properties：

logging.level.com.mypackage=TRACE
# 自定义包含MDC的日志格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%t] [myMdc:%X{myMdcVariable}] %-5level %logger{36} - %m%n

logback-spring.xml：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 引入Spring Boot默认的基础配置和Console Appender -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
    
    <!-- 配置root Logger的默认级别 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    </root>
    
    <!-- 配置自定义Logger，关闭additivity避免重复日志 -->
    <logger name="com.mypackage" level="TRACE" additivity="false">
        <appender-ref ref="CONSOLE"/>
    </logger>
</configuration>

Spring Boot会自动把logging.pattern.console的值注入到默认的CONSOLE Appender中，无需你手动定义Appender，既避免了配置冲突，又保持了配置的简洁性。

方案二：完全自定义Logback配置

如果你想完全通过logback-spring.xml控制所有配置，可以去掉对Spring Boot默认Console Appender的引用，直接定义自己的Appender：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 引入Spring Boot默认的基础配置（比如日志级别映射等） -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    
    <!-- 自定义Console Appender，使用你的日志格式 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss} [%t] [myMdc:%X{myMdcVariable}] %-5level %logger{36} - %m%n</Pattern>
        </encoder>
    </appender>
    
    <!-- 配置root Logger -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    </root>
    
    <!-- 配置自定义Logger，关闭additivity -->
    <logger name="com.mypackage" level="TRACE" additivity="false">
        <appender-ref ref="CONSOLE"/>
    </logger>
</configuration>

额外注意事项 #

• 确保你在代码中正确设置并清理MDC变量，避免线程复用导致的变量污染：

  MDC.put("myMdcVariable", "your-value");
  try {
      // 执行需要输出日志的业务逻辑
      log.trace("This is a trace log with MDC");
  } finally {
      // 务必在finally块中移除MDC变量
      MDC.remove("myMdcVariable");
  }
  

• 如果你的MDC变量是请求级别的，可以结合Spring的HandlerInterceptor或者Filter来统一设置和清理，避免在每个业务方法中重复编写代码。

内容的提问来源于stack exchange，提问作者Archimedes824