如何将多Servlet上下文的Web应用转为Spring Boot嵌入式Tomcat应用？

可行性说明 #

• 完全可以将传统Tomcat server.xml 中定义的多上下文迁移到Spring Boot嵌入式Tomcat中，完整复刻原有Web应用的多上下文结构。
• 重写/定制 TomcatServletWebServerFactory 是实现该需求的标准且推荐方案，能精准控制每个上下文的配置细节。

具体实现方案 #

方式一：通过WebServerFactoryCustomizer定制上下文 #

创建配置类，实现WebServerFactoryCustomizer接口，在回调方法中批量添加自定义上下文：

import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.apache.catalina.Context;

@Configuration
public class TomcatMultiContextConfig {

    @Bean
    public WebServerFactoryCustomizer<TomcatServletWebServerFactory> tomcatContextCustomizer() {
        return factory -> {
            // 添加第一个上下文（对应原server.xml中的/app1）
            Context app1Context = factory.createContext("/app1", "/usr/local/webapps/app1");
            // 可添加上下文参数、资源配置等
            app1Context.addParameter("env", "prod");
            factory.getContexts().add(app1Context);

            // 添加第二个上下文（对应原server.xml中的/app2）
            Context app2Context = factory.createContext("/app2", "classpath:/webapps/app2");
            app2Context.setResourceBase("classpath:/webapps/app2");
            factory.getContexts().add(app2Context);
        };
    }
}

方式二：重写TomcatServletWebServerFactory实现深度定制 #

如果需要更底层的Tomcat配置控制，可以直接自定义TomcatServletWebServerFactory Bean：

import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.apache.catalina.Context;
import org.apache.catalina.startup.Tomcat;

@Configuration
public class CustomTomcatFactoryConfig {

    @Bean
    public TomcatServletWebServerFactory tomcatServletWebServerFactory() {
        return new TomcatServletWebServerFactory() {
            @Override
            protected void prepareContext(Tomcat tomcat, Context defaultContext) {
                // 自定义第一个上下文
                Context app1Context = createContext("/app1", "/usr/local/webapps/app1");
                tomcat.getHost().addChild(app1Context);

                // 自定义第二个上下文
                Context app2Context = createContext("/app2", "classpath:/webapps/app2");
                // 配置类加载器隔离（如需）
                app2Context.setLoader(new org.apache.catalina.loader.WebappLoader(Thread.currentThread().getContextClassLoader()));
                tomcat.getHost().addChild(app2Context);

                super.prepareContext(tomcat, defaultContext);
            }
        };
    }
}

注意事项 #

• 上下文的资源路径可使用绝对路径或类路径前缀（classpath:），确保指向正确的Web应用根目录。
• 原有server.xml中的Realm、Valve等组件，可通过context.setRealm()、context.addValve()方法添加到对应上下文。
• 多上下文存在类冲突风险时，可通过配置独立的类加载器实现隔离。

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