springcloud项目war包部署总结

Bertha 。 2021-12-15 17:27 1147阅读 0赞

springcloud项目默认使用内嵌tomcat的jar直接运行，但最近想在外部tomcat埋探针进行APM监控，要求全部改成war包部署，过程中遇到了很多问题，现在把自己遇到的问题记录下。

一般修改步骤：

一、修改pom.xml文件将默认的jar方式改为war：

<groupId>com.example</groupId>
    <artifactId>application</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    
    
    
    <packaging>war</packaging>

**二、排除内置的Tomcat容器（两种方式都可）：**

1.排除spring-boot-starter-web中的Tomcat

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

2.添加依赖

dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-tomcat</artifactId>
        
        <scope>provided</scope>
    </dependency>

三、继承org.springframework.boot.web.servlet.support.SpringBootServletInitializer，实现configure方法：

为什么继承该类，SpringBootServletInitializer源码注释：

Note that a WebApplicationInitializer is only needed if you are building a war file and deploying it.

If you prefer to run an embedded web server then you won't need this at all.

注意，如果您正在构建WAR文件并部署它，则需要WebApplicationInitializer。

如果你喜欢运行一个嵌入式Web服务器，那么你根本不需要这个。

1.方式一，启动类继承SpringBootServletInitializer实现configure：

@SpringBootApplication
    public class Application extends SpringBootServletInitializer {
    
        public static void main(String[] args) {
            SpringApplication.run(Application.class, args);
        }
    
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
            return builder.sources(Application.class);
        }
    }

2.方式二，新增加一个类继承SpringBootServletInitializer实现configure：

public class ServletInitializer extends SpringBootServletInitializer {
    
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
            //此处的Application.class为带有@SpringBootApplication注解的启动类
            return builder.sources(Application.class);
        }
    
    }

注意事项：

使用外部Tomcat部署访问的时候，application.properties(或者application.yml)中配置的

server.port=

server.servlet.context-path=

将失效，请使用tomcat的端口，tomcat，webapps下项目名进行访问。

为了防止应用上下文所导致的项目访问资源加载不到的问题，

建议pom.xml文件中<build></build>标签下添加<finalName></finalName>标签：

<build>  
      
    <finalName>war包名称</finalName>  
    <plugins>  
        <plugin>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-maven-plugin</artifactId>  
        </plugin>  
    </plugins>  
</build>  
使用mvn命令行打包，运行：

clean是清除之前的包，-Dmaven.test.skip=true是忽略测试代码

jar 方式打包，使用内置Tomcat：mvn clean install -Dmaven.test.skip=true

运行：java -jar 包名.jar

war方式打包，使用外置Tomcat：mvn clean package -Dmaven.test.skip=true

运行：$\{Tomcat\_home\}/bin/目录下执行startup.bat(windows)或者startup.sh(linux)

**到这里就是一般流程结束了，如果你是简单的项目，可能成功了，但我遇到了很多的问题：**

1、打包后放tomcat启动不起来，缺少一些依赖，查找问题后发现项目所依赖的另一个项目里本地lib文件夹里的jar没打进来，打成jar的时候明明就引进来了，为什么war包就不行，因为springboot内置的maven插件只支持多模块依赖的父子工程把本地jar打入jar包：

<dependencies>  
            <dependency>
    			<groupId>com.example.webService</groupId>
    			<artifactId>INewSeatService</artifactId>
    			<version>1.0.0</version>
    			<scope>system</scope>
    			<systemPath>${basedir}/lib/newSeatPro.jar</systemPath>
    		</dependency> 
    </dependencies>
    <build>
        <plugins>
            <plugin>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-maven-plugin</artifactId>
    			<configuration>
    			    <includeSystemScope>true</includeSystemScope>
    			</configuration>
    		</plugin>
        </plugins>
    </build>

如果想在war包也打入依赖的父工程里的本地jar包，需要引入新的插件，在pom文件里添加：

<plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-dependency-plugin</artifactId>
                    <version>2.10</version>
                    <executions>
                        <execution>
                            <id>copy-dependencies</id>
                            <phase>compile</phase>
                            <goals>
                                <goal>copy-dependencies</goal>
                            </goals>
                            <configuration>
                                <outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/lib</outputDirectory>
                                <includeScope>system</includeScope>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>

这个是参考了另一个博客写的，这里附上链接：[https://blog.csdn.net/qq\_34918776/article/details/85104300][https_blog.csdn.net_qq_34918776_article_details_85104300]

2 、上面问题解决后，依赖包进来了，但是又报了一些jar包冲突，这个比较简单，找到冲突的包把他排除出去就行了

3、 项目终于跑起来了，因为是springcloud，要注册到consul中心，项目启动之后consul中心却找不到该项目，手动添加一个文件才能注册，以下为文件代码：

import org.springframework.beans.BeansException;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.autoconfigure.AutoConfigureAfter;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    import org.springframework.cloud.consul.ConditionalOnConsulEnabled;
    import org.springframework.cloud.consul.serviceregistry.ConsulAutoServiceRegistration;
    import org.springframework.cloud.consul.serviceregistry.ConsulAutoServiceRegistrationAutoConfiguration;
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.ApplicationContextAware;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    @ConditionalOnConsulEnabled
    @ConditionalOnMissingBean(type= "org.springframework.cloud.consul.discovery.ConsulLifecycle")
    @AutoConfigureAfter(ConsulAutoServiceRegistrationAutoConfiguration.class)
    public class MyConsulLifecycle implements ApplicationContextAware {
         //这个端口是配置文件里原先配置的内置tomcat访问端口
         @Value("${server.port}")
         private int port;
         @Autowired(required=false)
         private ConsulAutoServiceRegistration registration;
    
    
        public void setApplicationContext(ApplicationContext context) throws BeansException {
           if (registration !=null){
              registration.setPort(port);
              registration.start();
           }
        }
    }

然后tomcat的server.xml 的http端口要改成跟项目里配置的端口一致

![201907031041569.png][]

4、接下来重新打包后再启动，consul注册中心注册上来了，可是却没通过健康检查，服务之间调不通，因为war包放tomcat的webapps目录下启动后，项目访问路径会比原来jar包多一个项目名，所以要在tomcat的server.xml文件下配置，去掉访问路径的项目名前缀：

![20190703104326295.png][]

最后还有一个问题，项目现在本地启动会报错，如果要本地启动调试哦，可修稿pom文件，把红色框这个注释掉，就可以正常启动调试了：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ExMDI3ODA1Mzgw_size_16_color_FFFFFF_t_70][]

但是下次要发布war包打包时记得修改回来

[https_blog.csdn.net_qq_34918776_article_details_85104300]: https://blog.csdn.net/qq_34918776/article/details/85104300
[201907031041569.png]: /images/20211215/71978accc49840969abfd13e8ba8d463.png
[20190703104326295.png]: /images/20211215/217e2809fc4f41039fea7e804cde635a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ExMDI3ODA1Mzgw_size_16_color_FFFFFF_t_70]: /images/20211215/bd9d562786634c5b82b446db422edea9.png