如何通过自定义SpringBoot Starter配置带TraceId的Logback file-pattern？

方案一：使用EnvironmentPostProcessor提前注入日志属性 #

创建EnvironmentPostProcessor实现类，在应用环境初始化阶段注入自定义日志格式，既保证Starter配置优先生效，又能让应用自身配置覆盖Starter设置（符合Spring Boot配置优先级逻辑）。

代码示例：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MapPropertySource;
import java.util.HashMap;
import java.util.Map;

public class LoggingPatternEnvironmentPostProcessor implements EnvironmentPostProcessor {
    private static final String LOGGING_PATTERN_FILE = "logging.pattern.file";
    private static final String DEFAULT_TRACE_PATTERN = "-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %X{TRACE_ID}%m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}";

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        // 仅当应用未配置日志文件格式时注入自定义规则
        if (!environment.containsProperty(LOGGING_PATTERN_FILE)) {
            Map<String, Object> properties = new HashMap<>();
            properties.put(LOGGING_PATTERN_FILE, DEFAULT_TRACE_PATTERN);
            environment.getPropertySources().addFirst(new MapPropertySource("starterLoggingPattern", properties));
        }
    }
}

在Starter的resources/META-INF/spring.factories中注册处理器：

org.springframework.boot.env.EnvironmentPostProcessor=com.yourpackage.LoggingPatternEnvironmentPostProcessor

方案二：通过LoggingSystem动态配置日志格式 #

创建自动配置类，在Spring上下文初始化完成后，借助LoggingSystem修改日志文件格式。

代码示例：

import org.springframework.boot.logging.LoggingSystem;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.ConfigurableEnvironment;
import javax.annotation.PostConstruct;
import java.util.Map;

@Configuration
public class TraceIdLoggingAutoConfiguration {
    private static final String LOG_PATTERN_FILE_KEY = "logging.pattern.file";
    private final LoggingSystem loggingSystem;
    private final ConfigurableEnvironment environment;

    public TraceIdLoggingAutoConfiguration(LoggingSystem loggingSystem, ConfigurableEnvironment environment) {
        this.loggingSystem = loggingSystem;
        this.environment = environment;
    }

    @PostConstruct
    public void configureLoggingPattern() {
        // 应用未配置时使用自定义格式
        if (!environment.containsProperty(LOG_PATTERN_FILE_KEY)) {
            String tracePattern = "-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %X{TRACE_ID}%m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}";
            loggingSystem.setSystemProperties(Map.of(LOG_PATTERN_FILE_KEY, tracePattern));
        }
    }
}

在spring.factories中注册自动配置类：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.yourpackage.TraceIdLoggingAutoConfiguration

方案三：自定义Logback配置文件（推荐） #

如果项目使用Spring Boot默认的Logback日志框架，直接在Starter的resources目录下创建logback-spring.xml，内置带TraceId的日志格式：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
    
    <!-- 自定义文件Appender，包含TraceId -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %X{TRACE_ID}%m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz</fileNamePattern>
            <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
            <maxHistory>${LOG_FILE_MAX_HISTORY:-7}</maxHistory>
            <totalSizeCap>${LOG_FILE_TOTAL_SIZE_CAP:-0}</totalSizeCap>
        </rollingPolicy>
        <file>${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}</file>
    </appender>

    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

该方式直接利用Logback原生配置，Spring Boot会自动加载Starter中的配置；若应用自身存在同名配置文件，则优先使用应用配置，符合预期逻辑。

注意事项 #

• 确保Starter已通过自动配置类或拦截器实现MDC TraceId注入逻辑（MDC.put("TRACE_ID", ...)），保证每个请求能正确设置TraceId。
• 所有方案均遵循Spring Boot配置优先级：应用自身配置 > Starter配置，用户可按需覆盖日志格式。

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