springboot项目启动运维通用脚本

springboot项目启动运维通用脚本

一.背景:

  我们在发布springboot项目到服务器运行,有很多种方式,常见的是将项目在本地打好jar包,然后上传至服务器

但往往jar有时候很大,加上网络条件不是很好的情况下,发布一次很耗时.

二.方案

1.    需要在此服务器上安装maven以及git.
2.   这里提供一个通用的脚本,只需放在项目根目录下,我的示例项目在/data/www/{项目目录}下,同学们可自行根据自己项目的路径更改一下脚本中的DATA_DIR字段值,就可以很方便完成代码拉取,更新,启动,停止,如果springboot开启了优雅停止(graceful)还可以优雅停止.

#!/bin/bash
#这里可替换为你自己的执行程序，其他代码无需更改
SERVICE_NAME=print
APP_NAME=${SERVICE_NAME}-0.0.1-SNAPSHOT.jar
JVM_Xms=1G
JVM_Xmx=1G
#指定环境
PROFILE=dev
CATALINA_OUT=/dev/null
DATA_DIR=/data/www/${SERVICE_NAME}/target/
#使用说明，用来提示输入参数
usage() {
    echo "Usage: sh 执行脚本.sh [update|start|stop|gracefulStop|restart|status]"
    echo "[update]复制target目录jar至当前目录"
    echo "[start]启动当前目录jar包"
    echo "[stop]停止已启动的jar"
    echo "[gracefulStop]优雅停止已启动的jar"
    echo "[restart]重启已启动的jar"
    echo "[status]查看服务运行状态"
    exit 1
}
 
#检查程序是否在运行
is_exist(){
  pid=`ps -ef|grep ${APP_NAME}|grep -v grep|awk '{print $2}' `
  #如果不存在返回1，存在返回0
  if [[ -z "${pid}" ]]; then
   return 1
  else
    return 0
  fi
}
#更新jar包
update(){
  date_name=$(date +%Y%m%d-%H%M%S)             #定义时间变量名和显示时间格式
  git pull
  mvn clean install
  if [[ -f "${APP_NAME}" ]];then
    mv  ${APP_NAME}  ${date_name}.jar   #备份old jar
    echo "jar包已备份至->"${date_name}
  else
    echo "没有需要备份的jar!"
  fi
  #将target目录中的jar复制到此目录（注意从git拉取最新代码，并用mvn打包，以确保是最新代码）
  echo "拉取target目录jar包至此目录...."
  cp ${DATA_DIR}${APP_NAME} ${APP_NAME}

} 
#启动方法
start(){
  is_exist
  if [[ $? -eq "0" ]]; then
    echo "${APP_NAME} is already running. pid=${pid} ."
  else
    nohup java -Xms${JVM_Xms} -Xmx${JVM_Xmx} -jar ${APP_NAME} --spring.profiles.active=${PROFILE}  >> ${CATALINA_OUT} 2>&1 &
    echo "${APP_NAME} is starting...see /data/logs/ for detail"
  fi
}
 
#停止方法
stop(){
  is_exist
  if [[ $? -eq "0" ]]; then
    kill -9 ${pid}
  else
    echo "${APP_NAME} is not running"
  fi
}

gracefulStop(){
  is_exist
  if [[ $? -eq "0" ]]; then
    kill -15 ${pid}
  else
    echo "${APP_NAME} is not running"
  fi
}
 
#输出运行状态
status(){
  is_exist
  if [[ $? -eq "0" ]]; then
    echo "${APP_NAME} is running. Pid is ${pid}"
  else
    echo "${APP_NAME} is NOT running."
  fi
}
 
#重启
restart(){
  echo "正在关闭...."
  stop
  sleep 3
  echo "正在启动...."
  start
}
 
#根据输入参数，选择执行对应方法，不输入则执行使用说明
case "$1" in
  "start")
    start
    ;;
  "stop")
    stop
    ;;
  "status")
    status
    ;;
  "update")
    update
    ;;
  "restart")
    restart
    ;;
   "gracefulStop")
    gracefulStop
    ;;
  *)
    usage
    ;;
esac

  三.命令示例

(命令文件名称取名叫run.sh):

#更新项目(执行git拉取以及maven打包)
sh run.sh update 
#启动项目
sh run.sh start
#停止项目
sh run.sh stop
#优雅停止
sh run.sh gracefulStop