使用Spring引导泽西启动器部署为WAR时映射冲突

Question

我们将Spring Boot与其泽西Starter一起使用，并将其部署为WAR，以编程方式部署到另一个应用程序的嵌入式Tomcat中。

在我们的应用程序启动后，在某些环境中，会发生映射冲突并记录如下：

o.g.j.s.i.JerseyServletContainerInitializer : Mapping conflict. A Servlet registration exists with same mapping as the Jersey servlet application, named com.vidal.pmsi.config.PmsiResourceConfiguration, at the servlet mapping, /*.

资源配置如下：

@ApplicationPath("/")
@ExposedApplication
@Component
public class PmsiResourceConfiguration extends ResourceConfig {

   public PmsiResourceConfiguration() {
      packages("com.vidal.pmsi.api");
      packages("com.vidal.pmsi.config");
      property(ServerProperties.BV_DISABLE_VALIDATE_ON_EXECUTABLE_OVERRIDE_CHECK, true);
      property(ServerProperties.BV_SEND_ERROR_IN_RESPONSE, true);
   }
}

据我所知，Spring Boot泽西Starter将注册一个名为“jerseyServlet”的servlet映射到“/*”。

在某些环境中，泽西自己的JerseyServletContainerLaunalizer将在SpringApplication启动后触发，由于现有的jerseyServlet映射，无法注册PmsiResourceConfiguration。

这是一个问题，因为我们自己的开源库在启动时尝试（并崩溃）获取上下文路径：

// compile-time generated Linkers.java
@WebListener
@Generated("fr.vidal.oss.jax_rs_linker.LinkerAnnotationProcessor")
public final class Linkers implements ServletContextListener {
    private static String contextPath = "";
    private static String applicationName = ApplicationName.get();

    @Override
    public void contextInitialized(ServletContextEvent sce) {
         //applicationName = FQCN of PmsiResourceConfiguration
        contextPath = ContextPaths.contextPath(sce.getServletContext(), applicationName);
    }

    // [...]
}
// ContextPaths.java
public static String contextPath(ServletContext servletContext, String registeredKey) {
    // registeredKey is therefore the FQCN of PmsiResourceConfiguration
    String mappedPath = stripWildcard(servletContext.getServletRegistration(registeredKey).getMappings().iterator().next());
    return servletContext.getContextPath() + mappedPath;
}

最后一段代码将失败，因为注册的资源配置类没有映射（只有一个映射用于“jerseyServlet”键）。

当没有报告任何映射冲突时，这不会失败。为什么？

Answer 1

我遇到了一个类似的问题，我有一个带有泽西JAX-RS Webservice的Spring Boot应用程序。使用嵌入式Tomcat时一切正常，但当我尝试在相同版本的常规Tomcat（Tomcat8）上部署战争时，一切都变得一团糟。

问题在于，默认情况下，嵌入式Tomcat不会在jar文件中扫描ServletContainerInitializer，但常规的Tomcat会扫描，并且与Spring设置的ServletContainer/Config冲突。

除了排除包含 JerseyServletContainerInitializer 的 jar 之外，我还找到了一个选项来告诉 tomcat 过滤掉这个特定的 ServletContainerInitializer （SCI）。在上下文中设置 containerSciFilter 属性有助于：

<Context containerSciFilter="JerseyServletContainerInitializer">
...
</Context>

我没有在我的META-INF/services中定义任何SCI，但是包含JerseySCI的jar已经定义了它，并且它位于Tomcat可以找到的正确路径上。

考虑到这是最接近matchinb的问题，如果没有答案，我不会重新发布我的问题，并试图回答这个问题，因为我相信原因是一样的。