Windows环境Tomcat部署Spring Boot如何优先读取application.properties的logback配置

根因说明 #

Spring Boot 日志系统初始化时机早于application.properties的加载时机，部署为外置Tomcat的WAR包时，容器启动阶段加载的JVM参数优先级更高。Windows版本的catalina.bat对LOGGING_CONFIG对应的JUL日志配置做了优先级强化处理，会抢占日志配置生效权；而Unix版本的catalina.sh没有做特殊限制，因此才会出现跨环境表现不一致的问题。

可行解决方案 #

方案1：通过Tomcat自定义环境变量配置（无代码侵入，优先推荐） #

在Tomcat的bin目录下新建setenv.bat文件（Windows环境专属，Unix环境对应创建setenv.sh即可实现跨环境兼容），添加如下配置，该配置优先级高于catalina.bat自带的默认参数：

set JAVA_OPTS=%JAVA_OPTS% -Dlogging.config=file:%CONFIG_HOME%apilogback.xml

Spring Boot会优先读取JVM启动参数中的logging.config配置，优先级高于application.properties和容器默认日志配置，无需修改原有业务代码。

方案2：硬编码提前加载Logback配置（无需修改容器配置） #

如果不希望改动Tomcat的配置，可以在Spring Boot启动类的静态代码块中提前手动加载指定的Logback配置文件，完全绕过容器的日志配置优先级规则：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.joran.JoranConfigurator;
import ch.qos.logback.core.joran.spi.JoranException;
import org.slf4j.LoggerFactory;
import java.io.File;

@SpringBootApplication
public class YourApplication extends SpringBootServletInitializer {
    static {
        try {
            String configHome = System.getenv("CONFIG_HOME");
            if (configHome != null && !configHome.isBlank()) {
                File logConfigFile = new File(configHome + "apilogback.xml");
                if (logConfigFile.exists() && logConfigFile.isFile()) {
                    LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
                    context.reset();
                    JoranConfigurator configurator = new JoranConfigurator();
                    configurator.setContext(context);
                    configurator.doConfigure(logConfigFile);
                }
            }
        } catch (JoranException e) {
            // 加载失败时自动降级使用默认日志配置即可
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

该方案在类加载阶段就完成日志配置加载，Windows和Unix环境表现完全一致。

方案3：修改catalina.bat默认配置（不推荐） #

直接注释或修改catalina.bat中自带的LOGGING_CONFIG配置项，取消容器默认的JUL日志配置强制加载，缺点是每个部署的Tomcat实例都需要单独修改，迁移性差。

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