自定义Spring Boot Starter的Logback默认配置问题及解决方法咨询

问题概述 #

你正在开发一个自定义Spring Boot Starter，目标是提供默认的Logback XML配置和默认的logging.pattern.level（将spring.application.name追加到日志级别）。当前实现遇到两个问题：

• spring.application.name无法被解析，日志中显示为spring.application.name_IS_UNDEFINED；
• 应用配置文件中对logging.pattern.level的配置无法覆盖Starter提供的默认值。

你的当前实现：

• 默认Logback配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
    <include resource="org/springframework/boot/logging/logback/file-appender.xml"/>

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

• 通过EnvironmentPostProcessor加载默认属性：

logging.pattern.level=%5p [${spring.application.name}]

你通过以下代码验证配置覆盖情况：

@Bean
public String test(@Value("${logging.pattern.level}") String loggingPattern) {
  Logger logger = Logger.getLogger("LogDemo");
  logger.info(loggingPattern);
  return loggingPattern;
}

结果显示注入的值是应用配置的新值，但日志输出仍使用Starter的默认格式：

2023-02-07 09:57:50.124 INFO [spring.application.name_IS_UNDEFINED] 70880 --- [ main] LogDemo : %5p stackoverflow

问题原因 #

你的推测完全正确：当通过EnvironmentPostProcessor设置logging.pattern.level时，Logback的初始化会发生在应用配置文件加载之前。这导致：

• 此时spring.application.name还未被加载到Spring环境中，Logback无法解析该占位符；
• 后续应用配置文件中的覆盖配置无法作用于已经初始化完成的Logback上下文。

解决方案 #

1. 使用<springProperty>解析Spring环境属性 #

修改Logback配置文件，用Spring Boot提供的<springProperty>标签绑定spring.application.name，代替Logback原生的属性解析。这样Logback会在Spring环境完全加载后再获取该属性：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
    
    <!-- 绑定Spring环境中的spring.application.name，默认值为unknown-app -->
    <springProperty name="APP_NAME" source="spring.application.name" defaultValue="unknown-app"/>
    <!-- 自定义日志级别格式，使用绑定后的属性 -->
    <property name="LOG_LEVEL_PATTERN" value="%5p [${APP_NAME}]"/>
    
    <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
    <include resource="org/springframework/boot/logging/logback/file-appender.xml"/>

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

注：Spring Boot的默认console-appender和file-appender会使用LOG_LEVEL_PATTERN作为日志级别格式，所以直接定义这个属性即可生效，无需修改appender配置。

2. 用spring-boot-defaults.properties提供默认值 #

放弃使用EnvironmentPostProcessor，改为在Starter的META-INF目录下创建spring-boot-defaults.properties文件，写入默认的logging.pattern.level：

logging.pattern.level=%5p [${spring.application.name}]

Spring Boot的配置优先级规则中，spring-boot-defaults.properties的优先级低于应用自身的application.properties，因此用户的配置可以正常覆盖Starter的默认值。

3. 组合方案（推荐） #

将上述两种方式结合：

• 在Logback配置中用<springProperty>确保spring.application.name能被正确解析；
• 在spring-boot-defaults.properties中定义默认的logging.pattern.level，保证用户可以通过应用配置文件覆盖。

这样既解决了属性解析的时机问题，又保留了配置的可覆盖性。

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