SpringBoot2.x基础篇:将应用程序打包为可执行Jar


应用程序在编写完成后,有一个重要的阶段就是发布,当我们发布时需要将应用程序进行打包,那通过SpringBoot编写的应用程序该如何打包呢?

推荐阅读

打包方式

应用程序的发布一般有两种形式。

比较传统的方式是外置Tomcat,将应用程序打包成一个xx.war文件,该文件内只有应用程序源码编译后的.class以及配置文件

SpringBoot还提供了另外一种高效率的打包方式,在pom.xml内通过配置maven plugin,执行mvn package打包命令时会将src/main/javasrc/main/resources目录下的全部文件进行打包,最终生成一个xx.jar的文件,由于SpringBoot打包时默认会将Tomcat的相关依赖一并放入到xx.jar内,所以通过java -jar xx.jar命令行的方式可以直接运行。

打包插件

我们通过IDEA创建SpringBoot项目时,一般在pom.xml文件内默认已经添加了打包maven plugin,如下所示:

1
2
3
4
5
6
7
8
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>

注意事项:如果你不是通过spring-boot-starter-parenter方式构建的SpringBoot应用程序,需要手动配置<executions>,有关插件的使用文档,详见 Spring Boot Maven Plugin

执行打包

使用Maven构建的SpringBoot应用程序打包方式很简单,我们只需要通过命令在应用程序的根目录下执行mvn package即可,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
➜  developing-first-application git:(2.x) mvn package           
[INFO] Scanning for projects...
[INFO]
[INFO] ----------< org.minbox.chapter:developing-first-application >-----------
[INFO] Building developing-first-application 0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
省略部分编译日志......
[INFO] --- maven-jar-plugin:3.1.2:jar (default-jar) @ developing-first-application ---
[INFO] Building jar: /Users/yuqiyu/study/article-source-code/spring-boot-chapter/developing-first-application/target/developing-first-application-0.0.1-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:2.2.4.RELEASE:repackage (repackage) @ developing-first-application ---
[INFO] Replacing main artifact with repackaged archive
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4.711 s
[INFO] Finished at: 2020-02-20T15:02:24+08:00
[INFO] ------------------------------------------------------------------------

当控制台出现BUILD SUCCESS时,证明我们本次package已经成功了,当前应用程序的可执行Jar也已经生成,位于target目录下。

打包文件命名

spring-boot-maven-plugin插件打包完成后生成的文件名默认的格式为:<artifactId> + <version>.jar,如:developing-first-application-0.0.1-SNAPSHOT.jar,如果这并不是你想要的格式化,可以通过如下方式进行自定义:

1
2
3
<build>
<finalName>service-application-${version}</finalName>
</build>

注意事项:<finalName><plugins>是同级的配置,可以使用占位符属性${属性名}的方式来进行格式化命名内容,这只是文件的名称,在打包完成后后缀名.jar会自动追加。

跳过测试

项目在打包过程中会自动运行测试,来检查项目是否可以通过运行测试以及测试脚本的执行是否有效,一般这个过程是需要一定时间的,项目内容越多需要的时间就会越久,如果你想跳过这个测试过程,只需要添加一个很简单的<properties>属性配置即可,如下所示:

1
2
3
<properties>
<maven.test.skip>true</maven.test.skip>
</properties>

这样我们再运行mvn package时,就会跳过测试步骤。

运行Jar

要运行该应用程序,可以使用java -jar命令,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
➜  developing-first-application git:(2.x) ✗ java -jar target/service-application-0.0.1-SNAPSHOT.jar 

. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.2.4.RELEASE)

2020-02-20 15:29:39.615 INFO 3208 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8080 (http)
2020-02-20 15:29:39.626 INFO 3208 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2020-02-20 15:29:39.626 INFO 3208 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/9.0.30]
2020-02-20 15:29:39.953 INFO 3208 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2020-02-20 15:29:39.955 INFO 3208 --- [ main] o.m.c.d.f.a.DevelopingFirstApplication : Started DevelopingFirstApplication in 1.539 seconds (JVM running for 1.868)

如果想要退出该应用程序,请按Ctrl + C

SpringBoot2.x基础篇:将应用程序打包为可执行Jar

https://blog.minbox.org/spring-boot-basic-packaging-executable-jar.html

作者

恒宇少年 - 于起宇

发布于

2020-02-20

更新于

2022-10-26

许可协议

评论