Spring Boot：如何向嵌入式Tomcat添加另一个WAR文件？

Question

Spring Boot的嵌入式tomcat对于开发和部署都非常方便。

但是，如果应该添加另一个（第三方）WAR文件（例如，GeoServer）怎么办？

1. 安装普通Tomcat服务器。
2. 将Spring Boot应用程序构建为WAR文件，并将其添加到Tomcat的webapps文件夹中。
3. 还要向webapps文件夹中添加另一个（第三方）WAR文件。

但如果有以下配置可能就好了。

1. 将Spring Boot应用程序构建为独立的Jar，其中包括嵌入式Tomcat。
2. 部署Spring Boot应用程序JAR。
3. 将另一个（第三方）WAR文件添加到嵌入的Tomcat可以识别的文件夹中。
4. 使用嵌入式Tomcat为Spring boot应用程序内容和另一个WAR的内容提供服务。

怎么做呢？

更新

当Spring Boot应用程序由fat jar(=可执行jar)制成时，答案中的代码是不够的。修改后的内容如下：

@Bean
public EmbeddedServletContainerFactory servletContainerFactory() {
    return new TomcatEmbeddedServletContainerFactory() {

        @Override
        protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(
                Tomcat tomcat) {
            try {
                Context context = tomcat.addWebapp("/foo", "/path/to/foo.war");
                WebappLoader loader =
                    new WebappLoader(Thread.currentThread().getContextClassLoader());
                context.setLoader(loader);
            } catch (ServletException ex) {
                throw new IllegalStateException("Failed to add webapp", ex);
            }
            return super.getTomcatEmbeddedServletContainer(tomcat);
        }

    };
}

Answer 1

您可以使用Tomcat.addwebapp向嵌入式Tomcat添加war文件。正如其javadoc所说，它“相当于将一个web应用程序添加到Tomcat的web apps目录中”。要在Spring Boot中使用此API，需要使用自定义的TomCatEmbeddedServletContainerFactory子类：

@Bean
public EmbeddedServletContainerFactory servletContainerFactory() {
    return new TomcatEmbeddedServletContainerFactory() {

        @Override
        protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(
                Tomcat tomcat) {
            // Ensure that the webapps directory exists
            new File(tomcat.getServer().getCatalinaBase(), "webapps").mkdirs();

            try {
                Context context = tomcat.addWebapp("/foo", "/path/to/foo.war");
                // Allow the webapp to load classes from your fat jar
                context.setParentClassLoader(getClass().getClassLoader());
            } catch (ServletException ex) {
                throw new IllegalStateException("Failed to add webapp", ex);
            }
            return super.getTomcatEmbeddedServletContainer(tomcat);
        }

    };
}