「SpringBoot」如何优雅地启动管理SpringBoot项目

时间:2024-01-26 17:06:25

本文主要讲述一下如何优雅地管理SpringBoot项目。

背景

课堂上,当小明形如流水地回答完沐芳老师提出来的问题时,却被至今没有对象的胖虎无情嘲讽了?

沐芳老师:小明,你平时是如何启动、停止你的SpringBoot项目的?

小明(自信满满):启动时使用java -jar xxxx.jar命令启动,停止服务时,使用ps -ef找到服务的pid,然后再kill掉停止。

胖虎:就这?

这让小明很有挫败感,原计划按时放学回去陪隔壁小花打王者荣耀的小明,毅然决然留在教室潜心研究一番到底什么是SpringBoot优雅启动的正确姿势?经过几番挫折,小明终于搜集整理出两种优雅启动SpringBoot项目的方式分享给小明的小伙伴们。

第一种方式:使用SHELL脚本

As we known 作为一个后端程序猿,每天的工作除了与前端妹子一块连调接口(拌几嘴)以外,就是终日沉浸在黑压压的Linux服务器之中,部署服务、监控服务器状态、分析日志(找bug)……因此,掌握一些常用的SHEEL脚本命令是自然而然地(迫不得已)。

大胆胡说:什么是SHELL脚本?故名思议,她乐了(她乐你也乐)。

因此,小明站在巨人的肩膀上,参考了一些圈内资深高级JAVA开发工程师的经验,整理了一份防嘲讽必备的SHELL脚本(Github地址见文末),只是为了自己的SpringBoot服务,只是为了不被单身的胖虎嘲讽。

这一份SHELL脚本很神奇,有多神奇呢?

你只要把这个脚本放到你的SpringBoot项目打好的jar包同级目录下:

在该目录下,简单粗暴地执行下面这个命令,赋予该脚本相应执行权限

chmod 777 app.sh

就能完成如下功能:

命令 作用
./app.sh start 启动应用
./app.sh stop 停止应用
./app.sh restart 重启应用
./app.sh status 查看应用状态
./app.sh stop -f 强制kill应用进程

注意:如果一个目录下有多个jar包我们执行一个文件,那就需要指定jar包,比如./app.sh start coder-xiaoming-0.0.1-SNAPSHOT.jar

惊不惊喜?让大家看一下小明实操预览图,过过眼瘾先。

我们可以看到,通过运行启动命令,控制台输出提示:正在启动……并且该目录下会根据jar包名称和日期输出一个日志文件(调试bug使用)。

为了走一个流程,我们再查看一下应用状态,并停止应用

篇幅有限,其他几个命令大家可以自己尝试一下。

当然,我们还可以尝试自定义脚本中的内容:

比如,gcXmsXmx等针对当前服务器的实际配置进行修改;

不同大小的项目,正常停止项目的时间也不同,因此我们还可以设置restart应用时的等待时间,确保应用正常停止后再启动,如下所示将等待时间设为5s。

for i in {5..1}
do
	echo -n "$i "
  sleep 1
done

是不是感觉已经很规范很优雅了?但,故事还要继续,远没有完,小明又继续探索下去,发现如果你使用的是SpringBoot 2.0及以上的版本,那小明的小伙伴们便有福了,不需要以上的脚本就可以很优雅。接下来,看一下第二种方式。

第二种方式:把SpringBoot以服务形式启动

英文名字:Spring Boot Application as a Service Deploying .

搁在平时,小明在Linux服务器上启动Springboot项目,都是通过nohup命令让程序作为后台进程执行的,但是这样,程序并不好管理维护,反而显得小明和小明的伙伴们都很不专业,更好的方法是将SpringBoot作为Service启动。

首先需要更改打包方式,如果你使用的是maven构建的SpringBoot项目,首先将SpringBoot项目中的pom.xml中增加一个plugin

<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<executable>true</executable>
				</configuration>
			</plugin>
		</plugins>
</build>

其中“true”一定要加,标示该jar为可执行,否则机器启动SpringBoot服务会报错。

如果你使用的是gradle构建的SpringBoot项目,则相应地需要增加如下配置

bootJar {
     launchScript()
}

接下来拿主要拿maven打包举例:

首先通过package命令打jar包:

mvn clean package

接着,我们需要在Linux服务器上,如下所示,增加一个软连接,就可以将应用注册到Service

sudo ln -s /opt/coder-xiaoming.jar /etc/init.d/coder-xiaoming

其中/opt/coder-xiaoming.jar为你上传至服务器jar的绝对路径,一定要写全哦。
/etc/init.d/coder-xiaoming里面的coder-xiaoming可以修改为你自己中意的名字,执行相关命令时会用到。

接下来,就是见证奇迹的时刻,我们通过如下命令来操作应用(和操作汤姆猫一样):

启动服务

sudo service coder-xiaoming start

停止服务

sudo service coder-xiaoming stop

查看服务状态

sudo service coder-xiaoming status

有些小伙伴可能注意到了,这样快捷操作省去很多配置,固然很方便,那启动服务时如何自定义参数呢?接着往下看。

自定义JVM参数

我们只需在jar包所在的同级目录下添加与jar包同名的配置文件,比如添加一个叫coder-xiaoming.conf的配置文件(名字要和jar的名字相同哦),然后在文件里面自定义JVM参数JAVA_OPTS

export JAVA_OPTS="-Xmx4096m -Xms4096m"

这样启动时,就会读取该文件中的配置,我们查看一下进程状态

ps -ef | grep java

你一定可以看到,对应的Java进程启动参数上会多了“-Xmx4096m -Xms4096m”,如果要增加其他启动参数配置同理哈。

总结

自从小明掌握以上两个骚操作之后,在日常开发中也可以目中无人地启动/停止SpringBoot应用,极大地提高了日常工作效率,这让身旁的胖虎也呆若木鸡。这样操作的意义很大,以当前眼光来看,小明可以多陪小花打几把王者荣耀;以长远来看,这对于之后的CICD或者Docker化应用都有很大的帮助。小明的小伙伴们,你们还不赶紧应用起来?保证今晚不加班~

sheel脚本Github地址:https://github.com/WhenCoding/coder-xiaoming/blob/master/deploy/app.sh

搜索微信公众号“程序员小明”,获取更多精彩。