用程序在编写完成后,有一个重要的阶段就是发布,当我们发布时需要将应用程序进行打包,那通过SpringBoot
编写的应用程序该如何打包呢?
打包方式
应用程序的发布一般有两种形式。
比较传统的方式是外置Tomcat
,将应用程序打包成一个xx.war
文件,该文件内只有应用程序源码编译后的.class
以及配置文件
。
而SpringBoot
还提供了另外一种高效率的打包方式,在pom.xml
内通过配置maven plugin
,执行mvn package
打包命令时会将src/main/java
、src/main/resources
目录下的全部文件进行打包,最终生成一个xx.jar
的文件,由于SpringBoot
打包时默认会将Tomcat
的相关依赖一并放入到xx.jar
内,所以通过java -jar xx.jar
命令行的方式可以直接运行。
打包插件
我们通过IDEA
创建SpringBoot
项目时,一般在pom.xml
文件内默认已经添加了打包maven plugin
,如下所示:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
**注意事项:**如果你不是通过
spring-boot-starter-parenter
方式构建的SpringBoot
应用程序,需要手动配置``,有关插件的使用文档,详见 Spring Boot Maven Plugin
执行打包
使用Maven
构建的SpringBoot
应用程序打包方式很简单,我们只需要通过命令在应用程序的根目录
下执行mvn package
即可,如下所示:
➜ 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
插件打包完成后生成的文件名默认的格式为:+ .jar
,如:developing-first-application-0.0.1-SNAPSHOT.jar
,如果这并不是你想要的格式化,可以通过如下方式进行自定义:
<build>
<finalName>service-application-${version}</finalName>
</build>
注意事项:
<finalName>
与<plugins>
是同级的配置,可以使用占位符属性${属性名}
的方式来进行格式化命名内容,这只是文件的名称,在打包完成后后缀名.jar
会自动追加。
跳过测试
项目在打包过程中会自动运行测试
,来检查项目是否可以通过运行测试以及测试脚本的执行是否有效,一般这个过程是需要一定时间的,项目内容越多需要的时间就会越久,如果你想跳过这个测试过程,只需要添加一个很简单的``属性配置即可,如下所示:
<properties>
<maven.test.skip>true</maven.test.skip>
</properties>
这样我们再运行mvn package
时,就会跳过测试步骤。
运行Jar
要运行该应用程序,可以使用java -jar
命令,如下所示:
➜ 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
。
Linux后台运行Jar以及Jvm参数调优
我们将编写的应用程序打包为Jar
可执行文件后,如果在Linux
服务器环境下,可直接使用java -jar xxx.jar
命令运行应用程序,不过当我们关闭命令窗口后启动中
的应用程序也会停止,那我们需要通过什么方式才可以成为后台服务方式运行呢?
Nohup命令
Linux
系统或者OS X
都提供了一个解决应用程序后台运行的命令,那就是nohup
,我们使用该命令可以直接将要执行的任务
放置在后台运行,想要停止运行时需要通过结束pid
的方式,使用方式如下所示:
➜ developing-first-application git:(2.x) ✗ nohup java -jar target/service-application-0.0.1-SNAPSHOT.jar &
[1] 2349
appending output to nohup.out
我们通过以上的命令执行后可以看到控制台输出了本次运行程序的PID
为 2349,我们可以使用kill
命令杀死这个PID
,从而达到了结束进程的效果。
注意事项:
appending output to nohup.out
这句话很有必要了解下,要知道我们之前通过java -jar xxx.jar
直接运行应用程序时会有运行日志输出到控制台的,我们通过nohup
方式运行时我们貌似并没有发现日志的输出,日志去了哪里呢?
运行日志
当你看到appending output to nohup.out
这句话在控制台打印时,应该可以猜测到了,日志的内容已经输出到了名为nohup.out
的文件内,该文件所处的位置就是我们运行nohup命令的同级目录(注意:不是jar文件的目录
),我们可以通过tail -1000f nohup.out
命令查看运行日志内容,如下所示:
➜ developing-first-application git:(2.x) ✗ tail -1000f nohup.out
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.2.4.RELEASE)
...
2020-02-21 14:31:42.614 INFO 2349 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2020-02-21 14:31:42.617 INFO 2349 --- [ main] o.m.c.d.f.a.DevelopingFirstApplication : Started DevelopingFirstApplication in 1.437 seconds (JVM running for 1.75)
通过
nohup
执行的命令所产生的日志都会输出到默认nohup.out
文件内。
指定日志文件
在同一台服务器上、同一个目录下可能会存在多个需要运行的Jar
文件,为了区分每个应用程序的日志输出,这时我们就需要指定日志输出的文件名,如下所示:
➜ developing-first-application git:(2.x) ✗ nohup java -jar target/service-application-0.0.1-SNAPSHOT.jar &> service-application-0.0.1.log &
[1] 2579
这时我们在nohup
命令执行的同级目录下就可以看到创建了一个名为service-application-0.0.1.log
的日志文件。
建议:日志文件的名称格式:
Service ID + Service Version
,相同ServiceID
的服务可能存在部署不同版本的情况。
JVM Server模式
在JVM
内有一个模式的概念,开发环境中一般使用的是client
模式,不过生产服务器上一般都是使用server
模式,我们要怎么选择呢?
推荐开发环境使用client
模式,因为它启动快,可以提高一部分开发效率
,节省每一次项目启动的时间,而生产环境则是推荐使用server
模式,内部使用了代号为C2
的重量级编译器,这样虽然导致应用程序启动时间有所提高
,不过编译的比较彻底
,服务在运行期间相对于client
性能高一些。
设置使用server
模式也比较简单,我们只需要执行java -server
命令即可,如下所示:
➜ developing-first-application git:(2.x) ✗ nohup java -server -jar target/service-application-0.0.1-SNAPSHOT.jar &> service-application-0.0.1.log &
[1] 2707
初始内存(-Xms)
JVM
在client
模式下运行,默认Xms
大小为1M
,而在server
模式下默认Xms
大小为128M
,可以根据实际情况进行修改分配,如下所示:
➜ developing-first-application git:(2.x) ✗ nohup java -server -Xms256M -jar target/service-application-0.0.1-SNAPSHOT.jar &> service-application-0.0.1.log &
[1] 2846
通过-Xms256M
,修改初始化分配的内存为256M
。
最大内存(-Xmx)
JVM
在client
模式下运行,默认Xmx
大小为64M
,而在server
模式下默认Xmx
大小为1024M
,可以根据实际情况进行修改分配,如下所示:
➜ developing-first-application git:(2.x) ✗ nohup java -server -Xms256M -Xmx2048M -jar target/service-application-0.0.1-SNAPSHOT.jar &> service-application-0.0.1.log &
[1] 2340
通过-Xmx2048M
,修改最大分配内存为2048M
。
JVM调优脚本
JVM
的调优尤为最重,服务器的配置有限,可使用的资源我们则是要珍惜,做出最大的贡献!!!
为了每次部署服务的便利性,我把启动服务的命令进行了封装,并命名为boot-jar.sh
,内容如下所示:
#!/bin/bash
# author 恒宇少年 - 于起宇
# http://blog.yuqiyu.com
nohup java -server -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=128m -Xms256m -Xmx1024m -Xmn256m -Xss256k -XX:SurvivorRatio=8 -XX:+UseConcMarkSweepGC -jar "$1" > "$1.log" 2>&1 &
tail -1000f "$1.log"
使用
touch boot-jar.sh
创建启动脚本,创建完成后将上面内容复制到脚本内,并通过chmod u+x boot-jar.sh
命令修改权限为可执行文件。
boot-jar.sh
脚本使用如下:
➜ developing-first-application git:(2.x) ✗ ./boot-jar.sh target/service-application-0.0.1-SNAPSHOT.jar
由于脚本内添加了tail
命令,应用程序启动后会自动输出运行日志。
建议:
boot-jar.sh
应用程序启动脚本位置尽量放在与Jar
同级目录下。