Spring Boot无法访问Servlet Context初始化参数问题求助

问题背景 #

将Spring Boot 3.1.0应用以WAR包部署在独立Tomcat 10.12中，已在/opt/tomcat/conf/Catalina/web1/ROOT.xml定义Context参数：

<?xml version="1.0" encoding="UTF-8"?>  
<Context path="" docBase="/var/www/web1">  
  <Valve className="org.apache.catalina.valves.rewrite.RewriteValve" resourcePath="rewrite.config"/>  
  <WatchedResource>WEB-INF/rewrite.config</WatchedResource>  
  <Parameter name="website" value="web1-dev" override="false"/>  
  <Parameter name="logging.file.name" value="web" override="false"/>  
  <Parameter name="log4j2.configurationFile" value="log4j2-dev.xml" override="false"/>  
</Context>

需要在@PropertySource中动态使用website参数：

@PropertySource(ignoreResourceNotFound = true, value =    {"classpath:/enviroment/default.properties",     "classpath:/enviroment/${website}.properties",

但启动阶段无法读取这些参数，尝试在application.yml添加server.servlet.context-parameters.log4j2.configurationFile=log4j2-dev.xml也无效。Actuator的/env端点显示参数存在于servletContextInitParams中，但主类继承SpringBootServletInitializer后重写的onStartup方法从未执行。服务器需并行运行web1、web2两个同代码库应用，至少logging.file.name需不同值。

解决方案 #

1. 修复onStartup方法不执行问题 #

确保主类正确重写onStartup并调用父类方法，否则Spring Boot初始化流程会中断：

@SpringBootApplication
public class Application extends SpringBootServletInitializer {

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        // 读取Context参数并设置为系统属性，让日志等早启动组件能读取
        Enumeration<String> paramNames = servletContext.getInitParameterNames();
        while (paramNames.hasMoreElements()) {
            String paramName = paramNames.nextElement();
            String paramValue = servletContext.getInitParameter(paramName);
            System.setProperty(paramName, paramValue);
        }
        // 必须调用父类方法，否则Spring Boot初始化不会执行
        super.onStartup(servletContext);
    }

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }

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

2. 提前将ServletContext参数导入Spring环境 #

通过ApplicationContextInitializer在Spring上下文初始化前将参数加入属性源，适配@PropertySource动态解析场景：

public class ServletContextPropertyInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {

    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        ServletContext servletContext = ((ServletWebServerApplicationContext) applicationContext).getServletContext();
        if (servletContext != null) {
            Map<String, Object> params = new HashMap<>();
            Enumeration<String> paramNames = servletContext.getInitParameterNames();
            while (paramNames.hasMoreElements()) {
                String paramName = paramNames.nextElement();
                params.put(paramName, servletContext.getInitParameter(paramName));
            }
            // 将参数设为高优先级属性源，确保覆盖默认配置
            applicationContext.getEnvironment().getPropertySources().addFirst(new MapPropertySource("servletContextParams", params));
        }
    }
}

在主类中注册初始化器：

@SpringBootApplication
public class Application extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class)
                .initializers(new ServletContextPropertyInitializer());
    }

    public static void main(String[] args) {
        new SpringApplicationBuilder(Application.class)
                .initializers(new ServletContextPropertyInitializer())
                .run(args);
    }
}

3. 日志参数的特殊处理 #

log4j2.configurationFile和logging.file.name属于早于Spring上下文启动的组件配置，必须通过系统属性传递，第一种方案的System.setProperty能完美适配这个场景，确保日志系统启动时就能读取到参数值。

4. 嵌入式Tomcat本地调试适配 #

本地调试时，可在application.yml中添加模拟参数，结合上述初始化器保证本地与部署环境逻辑一致：

server:
  servlet:
    context-parameters:
      website: web1-dev
      logging.file.name: web
      log4j2.configurationFile: log4j2-dev.xml

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