碼上歡樂
相關內容    簡體    繁體

編寫一個可復用的SpringBoot應用運維腳本

本文轉載自   查看原文   2020-03-01 22:07   1140    Java/ SpringBoot

前提

作為Java開發者，很多場景下會使用SpringBoot開發Web應用，目前微服務主流SpringCloud全家桶也是基於SpringBoot搭建的。SpringBoot應用部署到服務器上，需要編寫運維管理腳本。本文嘗試基於經驗，總結之前生產使用的Shell腳本，編寫一個可以復用的SpringBoot應用運維腳本，從而極大減輕SpringBoot應用啟動、狀態、重啟等管理的工作量。本文的Shell腳本在CentOS7中正常運行，其他操作系統不一定適合。如果對一些基礎或者原理不感興趣可以拖到最后，直接拷貝腳本使用。

依賴到的Shell相關的知識

編寫SpringBoot應用運維腳本除了基本的Shell語法要相對熟練之外，還需要解決兩個比較重要的問題（筆者個人認為）：

  • 正確獲取目標應用程序的進程ID，也就是獲取Process ID（下面稱PID）的問題。
  • kill命令的正確使用姿勢。
  • 命令nohup的正確使用方式。

獲取PID

一般而言，如果通過應用名稱能夠成功獲取PID，則可以確定應用進程正在運行，否則應用進程不處於運行狀態。應用進程的運行狀態是基於PID判斷的，因此在應用進程管理腳本中會多次調用獲取PID的命令。通常情況下會使用grep命令去查找PID，例如下面的命令是查詢Redis服務的PID：

ps -ef |grep redis |grep -v grep |awk '{print $2}'

其實這是一個復合命令，每個|后面都是一個完整獨立的命令，其中：

  • ps -ef是ps命令加上-ef參數，ps命令主要用於查看進程的相關狀態，-e代表顯示所有進程，而-f代表完整輸出顯示進程之間的父子關系，例如下面是筆者的虛擬機中的CentOS 7執行ps -ef后的結果：

  • grep XXX其實就是grep對應的目標參數，用於搜索目標參數的結果，復合命令中會從前一個命令的結果中進行搜索。
  • grep -v grep就是grep命令執行時候忽略grep自身的進程。
  • awk '{print $2}'就是對處理的結果取出第二列。

ps -ef |grep redis |grep -v grep |awk '{print $2}'復合命令執行過程就是：

  • <1>通過ps -ef獲取系統進程狀態。
  • <2>通過grep redis從<1>中的結果搜索redis關鍵字，得出redis進程信息。
  • <3>通過grep -v grep從<2>中的結果過濾掉grep自身的進程。
  • <4>通過awk '{print $2}'從<3>中的結果獲取第二列。

在Shell腳本中，可以使用這種方式獲取PID：

PID=`ps -ef |grep redis-server |grep -v grep |awk '{print $2}'`
echo $PID

但是這樣會存在一個問題，就是每次想獲取PID都必須使用這串非常長的命令，顯得有些笨拙。可以使用eval簡化這個過程：

PID_CMD="ps -ef |grep docker |grep -v grep |awk '{print \$2}'"
PID=$(eval $PID_CMD)
echo $PID

獲取PID的問題解決，然后可以基於PID是否存在，決定一下步怎么操作。

理解kill命令

kill命令的一般形式是kill -N PID，本質功能是向對應PID的進程發送一個信號，然后對應的進程需要對這個信號作出響應，信號的編號就是N，這個N的可選值如下（系統是CentOS 7）：

其中開發者常見的就是9) SIGKILL和15) SIGTERM，它們的一般描述如下：

信號編號 信號名稱 描述 功能 影響
15 SIGTERM Termination (ANSI) 系統向對應的進程發送一個SIGTERM信號 進程立即停止，或者釋放資源后停止，或者由於等待IO繼續處於運行狀態，也就是一般會有一個阻塞過程，或者換一個角度來說就是進程可以阻塞、處理或者忽略SIGTERM信號
9 SIGKILL Kill(can't be caught or ignored) (POSIX) 系統向對應的進程發送一個SIGKILL信號 SIGKILL信號不能被忽略，一般表現為進程立即停止（當然也有額外的情況）

不帶-N參數的kill命令默認就是kill -15。一般而言，kill -9 PID是進程的必殺手段，但是它很有可能影響進程結束前釋放資源的過程或者中止I/O操作造成數據異常丟失等問題。

nohup命令

如果希望在退出賬號或者關閉終端后應用進程不退出，可以使用nohup命令運行對應的進程。

nohup就是no hang up的縮寫，翻譯過來就是"不掛起"的意思，nohup的作用就是不掛起地運行命令。

nohup命令的格式是：nohup Command [Arg...] [&]，功能是：基於命令Command和可選的附加參數Arg運行命令，忽略所有kill命令中的掛斷信號SIGHUP，&符號表示命令需要在后台運行。

這里注意一點，操作系統中有三種常用的標准流：
0：標准輸入流STDIN
1：標准輸出流STDOUT
2：標准錯誤流STDERR

直接運行nohup Command &的話，所有的標准輸出流和錯誤輸出流都會輸出到當前目錄nohup.out文件，時間長了有可能導致占用大量磁盤空間，所以一般需要把標准輸出流STDOUT和標准錯誤流STDERR重定向到其他文件，例如nohup Command 1>server.log 2>server.log &。但是由於標准錯誤流STDERR沒有緩沖區，所以這樣做會導致server.log會被打開兩次，導致標准輸出和錯誤輸出的內容會相互競爭和覆蓋，因此一般會把標准錯誤流STDERR重定向到已經打開的標准輸出流STDOUT中，也就是經常見到的2>&1，而標准輸出流STDOUT可以省略>前面的1，所以：

nohup Command 1>server.log 2>server.log &修改為nohup Command >server.log 2>&1 &

然而，更多時候部署Java應用的時候，應用會專門把日志打印到磁盤特定的目錄中便於ELK收集，如筆者前公司的運維規定日志必須打印在/data/log-center/${serverName}目錄下，那么這個時候必須把nohup的標准輸出流STDOUT和標准錯誤流STDERR完全忽略。一個比較可行的做法就是把這兩個標准流全部重定向到"黑洞/dev/null"中。例如：

nohup Command >/dev/null 2>&1 &

編寫SpringBoot應用運維腳本

SpringBoot應用本質就是一個Java應用，但是會有可能添加特定的SpringBoot允許的參數，下面會一步一步分析怎么編寫一個可復用的運維腳本。

全局變量

考慮到盡可能復用變量和提高腳本的簡潔性，這里先提取可復用的全局變量。先是定義JDK的位置JDK_HOME：

JDK_HOME="/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.242.b08-0.el7_7.x86_64/bin/java"

接着定義應用的位置APP_LOCATION：

APP_LOCATION="/data/shell/app.jar"

接着定義應用名稱APP_NAME（主要用於搜索和展示）：

APP_NAME="app"

然后定義獲取PID的命令臨時變量PID_CMD，用於后面獲取PID的臨時變量：

PID_CMD="ps -ef |grep $APP_LOCATION |grep -v grep |awk '{print \$2}'"
// PID = $(eval $PID_CMD)

定義虛擬機屬性VM_OPTS：

VM_OPTS="-Xms2048m -Xmx2048m"

定義SpringBoot屬性SPB_OPTS（一般用於配置啟動端口、應用Profile或者注冊中心地址等等）：

SPB_OPTS="--spring.profiles.active=dev"

主要是這些參數，具體可以按照實際的場景修改或者添加。

編寫核心方法

例如腳本的文件是server.sh，那么最后需要使用sh server.sh Command執行，其中Command列表如下：

  • start：啟動服務。
  • info：打印信息，主要是共享變量的內容。
  • status：打印服務狀態，用於判斷服務是否正在運行。
  • stop：停止服務進程。
  • restart：重啟服務。
  • help：幫助指南。

這里通過case關鍵字和命令執行時輸入的第一個參數確定具體的調用方法。

start() {
 echo "start: start server"
}

stop() {
 echo "stop: shutdown server"
}

restart() {
 echo "restart: restart server"
}

status() {
 echo "status: display status of server"
}

info() {
 echo "help: help info"
}

help() {
   echo "start: start server"
   echo "stop: shutdown server"
   echo "restart: restart server"
   echo "status: display status of server"
   echo "info: display info of server"
   echo "help: help info"
}

case $1 in
start)
    start
    ;;
stop)
    stop
    ;;
restart)
    restart
    ;;
status)
    status
    ;;
info)
    info
    ;;
help)
    help
    ;;
*)
    help
    ;;
esac
exit $?

測試一下：

[root@localhost shell]# sh server.sh 
start: start server
stop: shutdown server
restart: restart server
status: display status of server
info: display info of server
help: help info
......
[root@localhost shell]# sh c.sh start
start: start server

接着需要編寫對應的方法實現。

info方法

info()主要用於打印當前服務的環境變量和服務的信息等等。

info() {
  echo "=============================info=============================="
  echo "APP_LOCATION: $APP_LOCATION"
  echo "APP_NAME: $APP_NAME"
  echo "JDK_HOME: $JDK_HOME"
  echo "VM_OPTS: $VM_OPTS"
  echo "SPB_OPTS: $SPB_OPTS"
  echo "=============================info=============================="
}

status方法

status()方法主要用於展示服務的運行狀態。

status() {
  echo "=============================status==============================" 
  PID=$(eval $PID_CMD)
  if [[ -n $PID ]]; then
       echo "$APP_NAME is running,PID is $PID"
  else
       echo "$APP_NAME is not running!!!"
  fi
  echo "=============================status=============================="
}

start方法

start()方法主要用於啟動服務，需要用到JDK和nohup等相關命令。

start() {
 echo "=============================start=============================="
 PID=$(eval $PID_CMD)
 if [[ -n $PID ]]; then
    echo "$APP_NAME is already running,PID is $PID"
 else
    nohup $JDK_HOME $VM_OPTS -jar $APP_LOCATION $SPB_OPTS >/dev/null 2>\$1 &
    echo "nohup $JDK_HOME $VM_OPTS -jar $APP_LOCATION $SPB_OPTS >/dev/null 2>\$1 &"
    PID=$(eval $PID_CMD)
    if [[ -n $PID ]]; then
       echo "Start $APP_NAME successfully,PID is $PID"
    else
       echo "Failed to start $APP_NAME !!!"
    fi
 fi  
 echo "=============================start=============================="
}
  • 先判斷應用是否已經運行，如果已經能獲取到應用進程PID，那么直接返回。
  • 使用nohup命令結合java -jar命令啟動應用程序jar包，基於PID判斷是否啟動成功。

stop方法

stop()方法用於終止應用程序進程，這里為了相對安全和優雅地kill掉進程，先采用kill -15方式，確定kill -15無法殺掉進程，再使用kill -9。

stop() {
 echo "=============================stop=============================="
 PID=$(eval $PID_CMD)
 if [[ -n $PID ]]; then
    kill -15 $PID
    sleep 5
    PID=$(eval $PID_CMD)
    if [[ -n $PID ]]; then
      echo "Stop $APP_NAME failed by kill -15 $PID,begin to kill -9 $PID"
      kill -9 $PID
      sleep 2
      echo "Stop $APP_NAME successfully by kill -9 $PID"
    else 
      echo "Stop $APP_NAME successfully by kill -15 $PID"
    fi 
 else
    echo "$APP_NAME is not running!!!"
 fi
 echo "=============================stop=============================="
}

restart方法

其實就是先stop()，再start()。

restart() {
  echo "=============================restart=============================="
  stop
  start
  echo "=============================restart=============================="
}

測試

筆者已經基於SpringBoot依賴只引入spring-boot-starter-web最簡依賴，打了一個Jar包app.jar放在虛擬機的/data/shell目錄下，同時上傳腳本server.sh到/data/shell目錄下：

/data/shell
  - app.jar
  - server.sh

某一次測試結果如下：

[root@localhost shell]# sh server.sh info
=============================info==============================
APP_LOCATION: /data/shell/app.jar
APP_NAME: app
JDK_HOME: /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.242.b08-0.el7_7.x86_64/bin/java
VM_OPTS: -Xms2048m -Xmx2048m
SPB_OPTS: --spring.profiles.active=dev
=============================info==============================
......
[root@localhost shell]# sh server.sh start
=============================start==============================
app is already running,PID is 26950
=============================start==============================
......
[root@localhost shell]# sh server.sh stop
=============================stop==============================
Stop app successfully by kill -15 
=============================stop==============================
......
[root@localhost shell]# sh server.sh restart
=============================restart==============================
=============================stop==============================
app is not running!!!
=============================stop==============================
=============================start==============================
Start app successfully,PID is 27559
=============================start==============================
=============================restart==============================
......
[root@localhost shell]# curl http://localhost:9091/ping -s
[root@localhost shell]# pong

測試腳本確認執行的結果是正確的。其中的=================是筆者故意加入，如果覺得礙眼可以去掉。

小結

SpringBoot是目前或者將來一段很長時間Web服務中的主流框架，筆者花了一點時間學習Shell相關的語法，結合nohup、ps等Linux命令編寫了一個可復用的應用運維腳本，目前已經應用在測試和生產環境中，在一定程度上節省了運維成本。

參考資料：

附錄

下面是server.sh腳本的所有內容：

#!/bin/bash
JDK_HOME="/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.242.b08-0.el7_7.x86_64/bin/java"
VM_OPTS="-Xms2048m -Xmx2048m"
SPB_OPTS="--spring.profiles.active=dev"
APP_LOCATION="/data/shell/app.jar"
APP_NAME="app"
PID_CMD="ps -ef |grep $APP_NAME |grep -v grep |awk '{print \$2}'"

start() {
 echo "=============================start=============================="
 PID=$(eval $PID_CMD)
 if [[ -n $PID ]]; then
    echo "$APP_NAME is already running,PID is $PID"
 else
    nohup $JDK_HOME $VM_OPTS -jar $APP_LOCATION $SPB_OPTS >/dev/null 2>\$1 &
    echo "nohup $JDK_HOME $VM_OPTS -jar $APP_LOCATION $SPB_OPTS >/dev/null 2>\$1 &"
    PID=$(eval $PID_CMD)
    if [[ -n $PID ]]; then
       echo "Start $APP_NAME successfully,PID is $PID"
    else
       echo "Failed to start $APP_NAME !!!"
    fi
 fi  
 echo "=============================start=============================="
}

stop() {
 echo "=============================stop=============================="
 PID=$(eval $PID_CMD)
 if [[ -n $PID ]]; then
    kill -15 $PID
    sleep 5
    PID=$(eval $PID_CMD)
    if [[ -n $PID ]]; then
      echo "Stop $APP_NAME failed by kill -15 $PID,begin to kill -9 $PID"
      kill -9 $PID
      sleep 2
      echo "Stop $APP_NAME successfully by kill -9 $PID"
    else 
      echo "Stop $APP_NAME successfully by kill -15 $PID"
    fi 
 else
    echo "$APP_NAME is not running!!!"
 fi
 echo "=============================stop=============================="
}

restart() {
  echo "=============================restart=============================="
  stop
  start
  echo "=============================restart=============================="
}

status() {
  echo "=============================status==============================" 
  PID=$(eval $PID_CMD)
  if [[ -n $PID ]]; then
       echo "$APP_NAME is running,PID is $PID"
  else
       echo "$APP_NAME is not running!!!"
  fi
  echo "=============================status=============================="
}

info() {
  echo "=============================info=============================="
  echo "APP_LOCATION: $APP_LOCATION"
  echo "APP_NAME: $APP_NAME"
  echo "JDK_HOME: $JDK_HOME"
  echo "VM_OPTS: $VM_OPTS"
  echo "SPB_OPTS: $SPB_OPTS"
  echo "=============================info=============================="
}

help() {
   echo "start: start server"
   echo "stop: shutdown server"
   echo "restart: restart server"
   echo "status: display status of server"
   echo "info: display info of server"
   echo "help: help info"
}

case $1 in
start)
    start
    ;;
stop)
    stop
    ;;
restart)
    restart
    ;;
status)
    status
    ;;
info)
    info
    ;;
help)
    help
    ;;
*)
    help
    ;;
esac
exit $?

個人博客

不定時更新，只寫原創，偏向於架構、並發。

（本文完 c-2-d e-a-2020-03-01）

技術公眾號（《Throwable文摘》），不定期推送筆者原創技術文章（絕不抄襲或者轉載）：

娛樂公眾號（《天天沙雕》），甄選奇趣沙雕圖文和視頻不定期推送，緩解生活工作壓力：


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 運維常用腳本 Linux腳本-自動運維部署腳本 【Python運維】簡單的Python運維腳本 python常用運維腳本實例 shell運維腳本案例 使用python實現的幾個運維腳本 【Python】神器：Streamlit，僅使用Python開發一個運維管理后台（不需要編寫html，js，css） 【SpringBoot】編寫一個自己的Starter 應用運維三部曲 集群應用及運維經驗小結
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM