深入Spring Boot :打包解决方案

最近有位网友私信我咨询一个SpringBoot项目打包的问题。

深入Spring Boot :打包解决方案_第1张图片

这位朋友说网络上有很多重复、不可用的技术文章,这个倒是事实,更糟糕的一些自媒体为了流量抄来抄去,增加我们查找解决方案的时间成本,我也尝试去搜索了一下“SpringBoot打包”,结果不尽人意,所以,总结了这篇打包解决方案。

基于SpringBoot开发的项目代码可以打包成可执行jar,也可以打包成war,这个视不同需求而定,下面以SpringBoot2.4.0版本为例,分别列举了不同使用方式下的jar和war打包操作。

构建可执行jar包

SpringBoot推荐将应用系统构建成可执行jar包,使用内置应用服务器运行项目代码。

继承 spring-boot-starter-parent

如果项目配置了pom继承spring-boot-starter-parent,就像下面这样:

深入Spring Boot :打包解决方案_第2张图片

此时要把项目代码打包成jar,需要在pom中配置packaging=jar,就是下面这样:

接着,使用finalName标签配置最终jar包的名字,然后配置spring-boot-maven-plugin插件,例如如下配置:

深入Spring Boot :打包解决方案_第3张图片

以上就是pom中的配置了,接下来执行jar打包操作,如果使用IDEA图形化工具打包,双击执行Maven窗口下Lifecycle中的package,即执行打jar包。

深入Spring Boot :打包解决方案_第4张图片

如果想通过执行mvn指令打jar,需要cd到源码根目录,即pom.xml所在的目录,然后执行mvn clean package,即执行打jar包。

不继承 spring-boot-starter-parent

如果项目pom文件没有继承spring-boot-starter-parent,要想将项目代码构建成可执行jar包,同样需要在pom中配置packaging=jar,就是下面这样:

接着,使用finalName标签配置最终jar包的名字,然后配置spring-boot-maven-plugin插件,这里不一样的是需要配置goal=repackage,例如如下配置:

深入Spring Boot :打包解决方案_第5张图片

以上就是pom中的配置了,接下来执行jar打包操作,如果使用IDEA图形化工具打包,双击执行Maven窗口下Lifecycle中的package,即执行打jar包;如果想通过执行mvn指令打jar,需要cd到源码根目录,即pom.xml所在的目录,然后执行mvn clean package,即执行打jar包。

构建可部署war包

如果需要将项目代码构建成war包,可参考如下两个不同的方式。不过需要注意,对于web应用,SpringBoot2.4使用Servlet3,所以war包需要部署在支持Servlet3的应用服务器上,例如tomcat8.0及以上版本。

继承 spring-boot-starter-parent

如果配置了项目pom继承spring-boot-starter-parent,就像下面这样:

深入Spring Boot :打包解决方案_第6张图片

此时要把项目代码打包成jar,需要在pom中配置packaging=war,就是下面这样:

接着,使用finalName标签配置最终war包的名字,然后配置spring-boot-maven-plugin插件,例如如下配置:

深入Spring Boot :打包解决方案_第7张图片

以上就是pom中的配置了,接下来执行war打包操作,如果使用IDEA图形化工具打包,双击执行Maven窗口下Lifecycle中的package,即执行打war包;如果想通过执行mvn指令打war,需要cd到源码根目录,即pom.xml所在的目录,然后执行mvn clean package,即执行打war包。

不继承 spring-boot-starter-parent

如果项目pom文件没有继承spring-boot-starter-parent,要想将项目代码构建成war包,同样需要在pom中配置packaging=war,就是下面这样:

接着,使用finalName标签配置最终war包的名字,然后配置构建war包需要使用到的插件,spring-boot-maven-plugin中同样需要配置goal=repackage,例如如下配置:

 
  
 
  
 
	demo
	
		
			org.apache.maven.plugins
			maven-antrun-plugin
			1.8
		
		
			org.apache.maven.plugins
			maven-assembly-plugin
			3.3.0
		
		
			org.apache.maven.plugins
			maven-clean-plugin
			3.1.0
		
		
			org.apache.maven.plugins
			maven-compiler-plugin
			3.8.1
		
		
			org.apache.maven.plugins
			maven-dependency-plugin
			3.1.2
		
		
			org.apache.maven.plugins
			maven-deploy-plugin
			2.8.2
		
		
			org.apache.maven.plugins
			maven-enforcer-plugin
			3.0.0-M3
		
		
			org.apache.maven.plugins
			maven-failsafe-plugin
			2.22.2
		
		
			org.apache.maven.plugins
			maven-help-plugin
			3.2.0
		
		
			org.apache.maven.plugins
			maven-install-plugin
			2.5.2
		
		
			org.apache.maven.plugins
			maven-invoker-plugin
			3.2.1
		
		
			org.apache.maven.plugins
			maven-jar-plugin
			3.2.0
		
		
			org.apache.maven.plugins
			maven-javadoc-plugin
			3.2.0
		
		
			org.apache.maven.plugins
			maven-resources-plugin
			3.2.0
		
		
			org.apache.maven.plugins
			maven-shade-plugin
			3.2.4
		
		
			org.apache.maven.plugins
			maven-source-plugin
			3.2.1
		
		
			org.apache.maven.plugins
			maven-surefire-plugin
			2.22.2
		
		
			org.apache.maven.plugins
			maven-war-plugin
			3.3.1
		
		
			org.springframework.boot
			spring-boot-maven-plugin
			2.4.0
			
				
					
						repackage
					
				
			
		
	

以上配置中的插件版本号参考自SpringBoot2.4.0中的 spring-boot-dependencies-2.4.0.pom,它是spring-boot-starter-parent的父文件。

以上就是pom中的配置了,接下来执行war打包操作,如果使用IDEA图形化工具打包,双击执行Maven窗口下Lifecycle中的package,即执行打war包;如果想通过执行mvn指令打war,需要cd到源码根目录,即pom.xml所在的目录,然后执行mvn clean package,即执行打war包。

小结

从上述操作可以看到,是否继承spring-boot-starter-parent,打包配置还是有些不同的。因为spring-boot-starter-parent pom.xml中已经帮我们管理好了打包需要用到的spring-boot-maven-plugin插件和它需要依赖的其它插件,所以通过继承可以直接使用spring-boot-maven-plugin。有时,我们的项目有自己的parent pom.xml,此时没有继承spring-boot-starter-parent,那么如果还要想使用spring-boot-maven-plugin插件,就需要自定义管理它所依赖的maven插件。

你可能感兴趣的:(spring,boot,java,maven)