解决Spring Boot应用在Payara Server上重复启动的问题

本文旨在帮助开发者解决Spring Boot应用在Payara Server等Java EE服务器上部署时,出现应用重复启动的问题。通过排除内嵌Tomcat服务器依赖,可以避免冲突,确保应用正常运行。本文将提供详细步骤和代码示例,助你顺利解决此问题。

在将Spring Boot应用部署到Payara Server或其他Java EE容器时,可能会遇到应用启动多次的问题,这通常是由于Spring Boot内嵌的Tomcat服务器与Payara Server自带的Servlet容器冲突导致的。解决此问题的关键在于排除Spring Boot应用中内嵌的Tomcat服务器依赖。

排除内嵌Tomcat依赖

Spring Boot的spring-boot-starter-web依赖默认包含了内嵌的Tomcat服务器。当部署到Payara Server等已经提供Servlet容器的环境时,就需要排除这个内嵌的Tomcat,避免冲突。

在pom.xml文件中,找到spring-boot-starter-web依赖,并添加标签,排除spring-boot-starter-tomcat依赖。


    org.springframework.boot
    spring-boot-starter-web
    
        
            org.springframework.boot
  

spring-boot-starter-tomcat

这段配置告诉Maven,在引入spring-boot-starter-web时,不要引入spring-boot-starter-tomcat及其传递依赖。

依赖范围(Scope)注意事项

确保你的javax.servlet依赖的scope设置为provided。这意味着容器(Payara Server)会在运行时提供这个依赖,你的应用不需要打包它。


    javax.servlet
    servlet-api
    2.3 
    provided

SpringBootServletInitializer

如果你的Spring Boot应用需要部署为WAR包,你需要继承SpringBootServletInitializer类,并重写configure方法。这允许Spring Boot应用在Servlet容器中正确启动。

@SpringBootApplication
public class Application extends SpringBootServletInitializer {

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

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

打包方式

确保你的pom.xml文件中配置了正确的打包方式。如果需要部署为WAR包,则配置为war。

war

同时,确保在pom.xml中配置了maven-war-plugin插件,以便正确构建WAR包。


    
        
            org.apache.maven.plugins
            maven-war-plugin
            
                false
            
        
    

failOnMissingWebXml设置为false可以避免在没有web.xml文件时构建失败。

总结

通过排除内嵌Tomcat服务器依赖,并正确配置javax.servlet的scope为provided,以及确保继承了SpringBootServletInitializer类,可以有效地解决Spring Boot应用在Payara Server上重复启动的问题。 请务必仔细检查以上步骤,并根据你的具体项目配置进行调整。 如果问题仍然存在,请检查Payara Server的日志,以便获取更详细的错误信息。