本笔记内容是 2018 年 ~ 2020 年的一个实际产物，如今有场景需要再次用到这里的部署方案，就找了下之前的脚本总结成了该文章 该脚本参考资料：

  1. 基础知识：鸟哥私房菜-基础版- 学习笔记
  2. 有了基础知识之后，按照流程逻辑，遇到不会的就需要去百度查询写法，比如 awk 如何提取文本信息成数组显示之类的

推荐一个 IDEA 的 shell 检查插件，Shell Script强烈推荐，idea 官方出品，里面有一个扩展 shellcheck，在你打开 sh 脚本的时候会提示你是否安装它，这个很有用，会告诉你一些写法可能是有问题的，然后可以根据提示（一般有问题的会有黄色的背景）你可以去看看为什么会有提示，要如何修改。这个功能还挺不错的，强烈推荐

该方案前提：

  1. jar 包运行机器和 jar 包打包的机器可以是同一个，也可以是不同的机器（不同机器使用 ssh 命令去执行命令，提前配置好 ssh 免密登录 ）
  2. 需要在打包机器上安装 git、gradle 环境；因为需要使用命令来模拟人工打包部署的流程

功能描述：

  1. 使用 git pull 更新代码
  2. gradle 打包脚本
  3. 将打包好的 jar 包复制到指定位置
  4. 按 jar 包名称查找进程，并使用 kill -9 暴力杀掉进程
  5. 运行 jar 包

java 启动 jar 包命令

  1. nohup java -jar 微服务j.jar --eureka.instance.hostname=内网ip --spring.profiles.active=prod > ./catalina.out 2>&1 &
  3. # 服务注册中心需要额外指定一个参数
  4. --eureka.environment=eureka-client-prod
  6. # 如果有日志框架输出了日志文件，可以将后面控制台输出到 /dev/null 中
  7. nohup java -jar 微服务j.jar > /dev/null 2>&1 &

打包脚本 - v1 基础版

这里分两个操作脚本：打包、杀掉进程和运行
脚本单独存放，比如存放在 /data/packaging/script
build.sh 打包脚本

  1. #!/bin/sh
  2. # 存放 git 代码的分类仓库，有多个项目的话，会放到同一个 目录下
  3. BASE_DIR=/data/packaging/git-code
  4. # git 仓库目录名称，在 BASE_DIR 下的目录名称
  5. PROJECT=app1
  6. # 要部署的 jar 包目录
  7. APP_DIR=/data/service/app1
  8. # 远程服务器的 ip,或则实现配置免密登录的 host 名称
  9. IP=config
  11. echo -e "bootjar ${PROJECT}"
  12. cd $BASE_DIR/${PROJECT}
  13. git pull
  15. # -PbuildProfile=prod 是 gradle 的环境变量方式，没有使用到该方式的可以不用这个
  16. # gradle -PbuildProfile=prod bootJar
  17. gradle bootJar
  19. # 如果目标机器上的部署目录不存在，就创建
  20. # 这里的 IP 如果登录目标机器是指定账户，这可以使用 用户名@IP 的方式执行
  21. if ssh $IP test -e $APP_DIR;
  22.     then echo $filePathexists
  23.     else ssh  $IP "mkdir ${APP_DIR}"
  24. fi
  26. # 将打包好的 jar 包复制到目标机器
  27. scp -r ./build/libs/*  $IP:$APP_DIR

kill-run.sh 杀掉进程和启动 jar 包

  1. #!/bin/sh
  2. APP_DIR=/data/service/app1
  3. APP_JAR=app-1.0.0-boot.jar
  4. IP_ADDRESS=192.168.3.76
  6. ssh config "ps -ef | grep root | grep ${APP_JAR} | grep -v grep | cut -c 9-15 | xargs kill -s 9"
  7. ssh config "cd ${APP_DIR}; source /etc/profile; nohup java -jar ${APP_JAR} --eureka.instance.ip-address=${IP_ADDRESS} --spring.profiles.active=prod > /dev/null 2>&1 &"

打包脚本 - v2 版

v1 版本经过一段使用之后，发现了一些不太方便的场景：

  1. 当 jar 包版本号发生改变的时候打包发布变得困难，需要修改发布脚本，手动执行 kill 命令等操作
  2. 多开实例一个 boot.jar 往多个服务器推送的时候，变得困难，需要 copy 多次代码

v2 脚本重构目的：脚本顶部提取变量，其他部分全部一样。维护变得简单

build.sh

  1. #!/bin/sh
  2. BASE_DIR=/data/packaging/git-code
  3. PROJECT=app1
  4. APP_DIR=/data/service/$PROJECT
  5. # 推送目标机器，多个空格隔开
  6. PUSH_TARGET_HOST_NAMES="cloud-04"
  8. echo -e "${PROJECT} ..."
  9. cd $BASE_DIR/${PROJECT}
  10. git pull
  11. rm -rf ./build/libs/*
  12. gradle -PbuildProfile=prod bootJar
  13. # 其他脚本中统一使用一个 jar 名称，防止版本升级脚本改动
  14. mv ./build/libs/*-boot.jar ./build/libs/$PROJECT-boot.jar
  16. for hostName in $PUSH_TARGET_HOST_NAMES ; do
  17.     if ssh $hostName test -e $APP_DIR;
  18.         then echo $filePathexists
  19.         else ssh $hostName "mkdir ${APP_DIR}"
  20.     fi
  21.     scp -r ./build/libs/*-boot.jar $hostName:$APP_DIR
  22. done

kill.sh

  1. #!/bin/sh
  2. APP_JAR=app-boot.jar
  3. TARGET_HOST_NAME=cloud-04
  5. ssh $TARGET_HOST_NAME "ps -ef | grep root | grep ${APP_JAR} | grep -v grep | cut -c 9-15 | xargs kill -s 9"

kill-run.sh

  1. #!/bin/sh
  2. APP_DIR=/data/service/app1
  3. APP_JAR=app1-boot.jar
  4. IP_ADDRESS=192.168.7.2
  5. TARGET_HOST_NAME=cloud-04
  7. ssh $TARGET_HOST_NAME "ps -ef | grep root | grep ${APP_JAR} | grep -v grep | cut -c 9-15 | xargs kill -s 9"
  8. ssh $TARGET_HOST_NAME "cd ${APP_DIR}; source /etc/profile; nohup java -jar ${APP_JAR} --eureka.instance.ip-address=${IP_ADDRESS} --spring.profiles.active=prod > /dev/null 2>&1 &"

如果有多个实例，kill 与 kill-run 脚本是分开写的。为什么呢？因为往往可能只是想重启其中一台的，而且这种几率非常大

打包脚本 - v3 交互版

该脚本比较复杂，先来看看交互界面，然后再看脚本
image.png
start.sh 交互脚本核心

  1. #!/bin/sh
  2. # Program:
  3. #   cloud 微服务统一部署，提供打包推送、kill、run、检查项目是否运行等功能
  4. # History:
  5. #   2020/02/18      mrcode      first relese
  6. #   2020/02/28      mrcode      修复多机器打包机器选择逻辑错误，函数内部变量跨域等问题
  7. SH_VERSION="v0.4"
  9. # 打包项目并推送到目标机器
  10. function f_pack() {
  11.   local _uiName=$uiName
  12.   local _BASE_DIR=$BASE_DIR
  13.   local _PROJECT=$PROJECT
  14.   local _APP_DIR=$APP_DIR
  15.   local _PUSH_TARGET_HOST_NAMES=$PUSH_TARGET_HOST_NAMES
  17.   echo -e "\n开始部署项目 ${_PROJECT} ..."
  18.   cd ${_BASE_DIR}/${_PROJECT}
  19.   git pull
  20.   rm -rf ./build/libs/*
  21.   gradle -PbuildProfile=prod bootJar
  22.   # 其他脚本中统一使用一个 jar 名称，防止版本升级脚本改动
  23.   mv ./build/libs/*-boot.jar ./build/libs/${_PROJECT}-boot.jar
  25.   for hostName in ${_PUSH_TARGET_HOST_NAMES} ; do
  26.       if ssh $hostName test -e ${_APP_DIR}; then
  27.         echo $filePathexists
  28.       else
  29.         ssh $hostName "mkdir ${_APP_DIR}"
  30.       fi
  31.       scp -r ./build/libs/*-boot.jar $hostName:${_APP_DIR}
  32.   done
  33. }
  35. function f_checkIsRun() {
  36.   local checkIsRunInfo=$(ssh $TARGET_HOST_NAME "ps -ef | grep root | grep $1")
  37.   if [ "$checkIsRunInfo" == "" ]; then
  38.     echo "未运行"
  39.    else
  40.      echo $checkIsRunInfo
  41.   fi
  42. }
  44. # 打印 host 待选菜单，并完成选择
  45. function f_selectHostName() {
  46.     local index=0
  47.     echo -e "\n当前项目有如下多个实例机器需要部署："
  48.     for i in ${hostNames[*]} ; do
  49.       index=$((index+1))
  50.       echo "$index. $i"
  51.     done
  52.     echo -e "\n"
  53.     read -p "请选择要操作的机器：" hostNameN
  54.     TARGET_HOST_NAME=${hostNames[$(($hostNameN-1))]}
  55.     echo -e "当前选择操作项目为 $PROJECT $TARGET_HOST_NAME \n"
  56. }
  58. # 检测是否有多台机器
  59. function f_checkSelectHostName() {
  60.     local hostNames=($PUSH_TARGET_HOST_NAMES)
  61.     if [ "${#hostNames[@]}" -gt 1 ]; then
  62.       # 选择哪一台机器
  63.       f_selectHostName
  64.     fi
  65. }
  67. # kill 掉项目
  68. function f_kill() {
  69.     ssh $TARGET_HOST_NAME "ps -ef | grep root | grep ${APP_JAR} | grep -v grep | cut -c 9-15 | xargs kill -s 9"
  70. }
  71. # run 项目
  72. function f_run() {
  73.     ssh $TARGET_HOST_NAME "cd ${APP_DIR}; source /etc/profile; nohup java -jar ${APP_JAR} --eureka.instance.ip-address=${IP_ADDRESS} --spring.profiles.active=prod ${LAUNCH_PARAMS} > /dev/null 2>&1 &"
  74. }
  76. # 匹配 IP 地址
  77. function f_matchIp() {
  78.   IP_ADDRESS=$(grep ${TARGET_HOST_NAME} ./ip | awk '{printf $2}')
  79. }
  81. echo -e "\n====================  微服务统一部署脚本 ${SH_VERSION} ==================== \n"
  82. #cat ./projectData | grep -v '^#' | awk -F '\t' '{print NR ". " $1}'
  83. # 一行两列格式化对齐输出
  84. cat ./projectData | grep -v '^#' | awk -F '\t' 'NR%2==1 {printf ("%s. %-20s \t\t",NR,$1)} NR%2==0 {print NR ". " $1}'
  85. echo -e "\n"
  86. read -p "请选择项目编号(输入 0 退出)：" projectDataN
  87. if [ "$projectDataN" == 0 ]; then
  88.   exit 1
  89. fi
  91. uiName=''
  92. BASE_DIR=''
  93. PROJECT=''
  94. APP_DIR=''
  95. PUSH_TARGET_HOST_NAMES=''
  96. LAUNCH_PARAMS=''  # 额外启动参数
  97. # 获取到该项目一行的配置数据
  98. eval $(cat ./projectData | grep -v '^#' | sed -n "${projectDataN}p" | awk -F '\t' '{ printf("uiName=%s;BASE_DIR=%s;PROJECT=%s;APP_DIR=%s;PUSH_TARGET_HOST_NAMES=%s;LAUNCH_PARAMS=%s",$1,$2,$3,$4,$5,$6)}')
  99. echo -e "\n当前操作项目为：${uiName}\n"
  100. echo "1. 打包并推送项目"
  101. echo "2. kill 项目"
  102. echo "3. run 项目"
  103. echo "4. kill & run 项目"
  104. echo "5. 检测项目是否运行"
  105. echo -e "\n"
  106. read -p "请选择：" optNu
  108. APP_JAR="${PROJECT}-boot.jar"
  109. TARGET_HOST_NAME=${PUSH_TARGET_HOST_NAMES}
  110. IP_ADDRESS=''   # ip 地址
  112. case $optNu in
  113.     1)
  114.         echo "已选择：打包并推送项目"
  115.         f_pack
  116.     ;;
  117.     2)
  118.         echo "已选择：kill 项目"
  119.         f_checkSelectHostName
  120.     f_matchIp
  121.         f_kill
  122.     ;;
  123.     3)
  124.         echo "已选择：run 项目"
  125.         f_checkSelectHostName
  126.     f_matchIp
  127.         f_run
  128.     ;;
  129.     4)
  130.       echo "已选择：kill & run 项目"
  131.         f_checkSelectHostName
  132.     f_matchIp
  133.       f_kill
  134.       f_run
  135.     ;;
  136.     5)
  137.         echo "已选择：检测项目是否运行"
  138.         f_checkSelectHostName
  139.     f_matchIp
  140.         f_checkIsRun $APP_JAR
  141.     ;;
  142.     *)
  143.         echo "选择错误，已退出"
  144. esac
  145. # function_print $uiName $BASE_DIR $PROJECT $APP_DIR $PUSH_TARGET_HOST_NAMES

projectData 微服务信息文件

  1. # ui界面显示名称    BASE_DIR源（码目录）    PROJECT（项目名称）    APP_DIR（部署目录）    PUSH_TARGET_HOST_NAMES（要部署的机器名称，多个用逗号隔开）    LAUNCH_PARAMS(其他启动参数)
  2. # 建议多实例相同启动参数，直接使用多 PUSH_TARGET_HOST_NAMES ，而不同启动参数，写多行
  3. "mrcode-cloud-sam"    "/data/packaging/git-code"    "mrcode-cloud-sam"    "/mnt/service/$PROJECT"    "cloud-05"    ""
  4. "mrcode-cloud-sam-agent-1"    "/data/packaging/git-code"    "mrcode-cloud-sam-agent"    "/mnt/service/$PROJECT"    "cloud-05"    "--spring.cloud.stream.instance-index=0"
  5. "mrcode-cloud-sam-agent-2"    "/data/packaging/git-code"    "mrcode-cloud-sam-agent"    "/mnt/service/$PROJECT"    "cloud-04"    "--spring.cloud.stream.instance-index=1"
  6. "mrcode-cloud-sem"    "/data/packaging/git-code"    "mrcode-cloud-sem"    "/mnt/service/$PROJECT"    "cloud-04"    ""
  7. "mrcode-cloud-sem-google"    "/data/packaging/git-code"    "mrcode-cloud-sem-google"    "/mnt/service/$PROJECT"    "cloud-05"    ""
  8. "mrcode-cloud-sem-facebook"    "/data/packaging/git-code"    "mrcode-cloud-sem-facebook"    "/mnt/service/$PROJECT"    "cloud-05"    ""
  9. "mrcode-cloud-product"    "/data/packaging/git-code"    "mrcode-cloud-product"    "/mnt/service/$PROJECT"    "cloud-05"    ""
  10. "mrcode-cloud-feed"    "/data/packaging/git-code"    "mrcode-cloud-feed"    "/mnt/service/$PROJECT"    "cloud-05"    ""
  11. "mrcode-cloud-site-group"    "/data/packaging/git-code"    "mrcode-cloud-site-group"    "/mnt/service/$PROJECT"    "cloud-04"    ""
  12. "mrcode-cloud-life-cycle"    "/data/packaging/git-code"    "mrcode-cloud-life-cycle"    "/mnt/service/$PROJECT"    "cloud-04 cloud-05"    ""
  13. "mrcode-cloud-notice"    "/data/packaging/git-code"    "mrcode-cloud-notice"    "/mnt/service/$PROJECT"    "cloud-05"    ""
  14. "mrcode-cloud-gateway"    "/data/packaging/git-code"    "mrcode-cloud-gateway"    "/mnt/service/$PROJECT"    "cloud-06"    ""

ip host 与 ip 映射, 这个其实不太需要，主要是为了传递内网 IP 给 --eureka.instance.ip-address参数

  1. cloud-02 192.168.7.70
  2. cloud-03 192.168.7.71
  3. cloud-04 192.168.7.72
  4. cloud-05 192.168.7.2
  5. cloud-06 192.168.7.73
  6. cloud-07 192.168.7.74