SpringBoot项目打成War包部署的方法步骤
作者:欧阳啸天
简介
一般情况下,在SpringBoot项目开发完成进行服务器部署时,都是打成JAR包进行部署运行的。但是在有些情况下也需要将其打成War包使用Tomcat进行部署。本篇文章就简单介绍一下SpringBoot如何打成War包。
注意: 测试Demo的SpringBoot版本为2.7.17,根据SpringBoot官网,对应的Servlet容器版本如下图所示:
因此,部署War包时请注意使用Tomcat9.0版本!!!
操作步骤
1、修改pom文件
首先,要将SpringBoot项目打成War包,我们要在pom文件中添加如下配置,以标识要将项目打成War包:
<packaging>war</packaging>
如下图所示:
接下来,我们需要配置最终打成的War的名称,该配置需要在pom文件中build标签中,添加如下配置项:
<build> # 或者直接改成需要的名称 <finalName>${artifactId}</finalName> </build>
如果不配置这一项,包的名称会带有版本号,而且会比较长,因此还是推荐进行此项配置。
然后,就是在pom文件中添加Tomcat的依赖项,如下所示:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-tomcat</artifactId> <!-- scope 各配置简单介绍 1.test范围是指测试范围有效,在编译和打包时都不会使用这个依赖 2.compile范围是指编译范围内有效,在编译和打包时都会将依赖存储进去 3.provided依赖,在编译和测试过程中有效,最后生成的war包时不会加入 例如: servlet-api,因为servlet-api在tomcat服务器已经存在了,如果再打包会冲突 4.runtime在运行时候依赖,在编译时候不依赖 5.system表示此依赖来自于外部jar, 而不是maven仓库 如果引入依赖未指定,默认依赖范围是compile --> <scope>provided</scope> </dependency>
以上配置完成后,pom文件的修改就算完成。
2、配置SpringBootServletInitializer
修改SpringBoot项目的启动类,使其继承 SpringBootServletInitializer
@SpringBootApplication public class DemoApplication extends SpringBootServletInitializer { public static void main(String[] args) { SpringApplication.run(DuanlinApplication.class, args); } }
也可以继承之后重写 configure方法,如下所示,不过根据我的测试,该方法是否重写并不影响最终效果。
@SpringBootApplication public class DemoApplication extends SpringBootServletInitializer { public static void main(String[] args) { SpringApplication.run(DemoApplication .class, args); } @Override protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) { return builder.sources(DemoApplication.class); } }
修改完成之后,就可以使用Maven进行打包了,可以使用Maven命令打包,当然也可以使用Idea的Maven面板直接打包,如下图所示:
命令执行完毕之后即可在target目录下看到项目打成War包。此时将War包放入到Tomcat的webapps目录下启动Tomcat即可。
外部依赖包问题
在SpringBoot项目中,有些依赖包无法通过Maven进行依赖,而是需要新建libs目录进行依赖添加。比如本人在项目开发中使用了人大金仓数据库,该数据库的驱动包就是通过libs目录进行添加的,如下图所示:
POM文件中添加配置如下:
<!--人大金仓驱动--> <dependency> <groupId>com.kingbase8.jdbc</groupId> <artifactId>kingbase8</artifactId> <version>8.6.0</version> <scope>system</scope> <systemPath>${pom.basedir}/libs/kingbase8-8.6.0.jar</systemPath> </dependency>
1、外部依赖打进SpringBoot JAR包中
如果将上述的外部依赖打进JAR包呢?我们只需要在POM文件中的spring-boot-maven-plugin插件中添加如下配置即可:
<!--设置为true,把本地system的jar包括进来--> <includeSystemScope>true</includeSystemScope>
完整的spring-boot-maven-plugin插件配置如下所示:
<plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <!--设置为true,以便把本地的system的jar也包括进来--> <includeSystemScope>true</includeSystemScope> <excludes> <exclude> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </exclude> </excludes> </configuration> </plugin>
此时,再进行打包,人大金仓的依赖包就会打进JAR包中。
2、外部依赖打进SpringBoot War包中
那么如何将外部依赖打进War包呢?其实也很简单,需要在POM文件中添加maven-war-plugin 插件,完整配置如下:
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>3.3.2</version> <configuration> <!--failOnMissingWebXml设置为false,让系统忽略缺少WEB-INF的错误--> <failOnMissingWebXml>false</failOnMissingWebXml> <!--外部依赖jar包打进到当前项目增加以下属性配置即可--> <webResources> <webResource> <directory>${pom.basedir}/libs/</directory> <targetPath>WEB-INF/lib/</targetPath> <includes> <include>**/*.jar</include> </includes> </webResource> </webResources> </configuration> </plugin>
配置之后,再次打包,就可以将外部依赖打进War包中。
总结
到此这篇关于SpringBoot项目打成War包部署的文章就介绍到这了,更多相关SpringBoot打成War包部署内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!