2. 程式人生 > >編寫一個可複用的SpringBoot應用運維指令碼

編寫一個可複用的SpringBoot應用運維指令碼

阿新 • • 發佈：2020-03-02

前提

作為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命令編寫了一個可複用的應用運維指令碼，目前已經應用在測試和生產環境中，在一定程度上節省了運維成本。

參考資料：

  • Nohup Invocation

附錄

下面是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 $?

個人部落格

  • Throwable's Blog

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

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

相關推薦

編寫一個可複用的SpringBoot應用運維指令碼

前提 作為Java開發者，很多場景下會使用SpringBoot開發Web應用，目前微服務主流SpringCloud全家桶也是基於SpringBoot搭建的。SpringBoot應用部署到伺服器上，需要編寫運維管理指令碼。本文嘗試基於經驗，總結之前生產使用的Shell指令碼，編寫一個可以複用的SpringBoo

做一個可複用的 echarts-vue 元件（延遲動畫載入）

在 vue 專案使用 echarts 的場景中，以下三點不容忽視：1. 視覺化的資料往往是非同步載入的；2. 若一個頁面存在大量的圖表（ 尤其當存在關係圖和地圖時 ），往往會導致該頁面的渲染速度很慢並可能在幾秒內卡死，產生極差的使用者體驗。3. 引入 echarts 元件導致編譯後的檔案過大從而使得首次訪

一個可供借鑑的中小企業運維管理平臺架構樣本

作者介紹 戰學超，青島航空運維經理、高階架構師。曾任職於NEC軟體、海爾B2B平臺鉅商匯，負責企業資料平臺構建、B2B電商平臺數據管理與搭建、企業運維管理平臺搭建。擁有豐富DBA、系統運維架構經驗，熟悉運維管理、資料庫架構、資料平臺搭建、虛擬化、私有云部署、自動化運維等。 我今天要跟大家分享的主題

Unity應用架構設計(4)——設計可複用的SubView和SubViewModel(Part 1)

『可複用』這個詞相信大家都熟悉，通過『可複用』的元件，可以大大提高軟體開發效率。 值得注意的事，當我們設計一個可複用的面向物件元件時，需要保證其獨立性，也就是我們熟知的『高內聚，低耦合』原則。 元件化設計的思路 不管是開發客戶端應用程式還是開發伺服器端應用程式，『元件』這個詞我們並不陌生。不管是在iOS中

Unity應用架構設計(4)——設計可複用的SubView和SubViewModel(Part 2)

在我們設計和開發應用程式時，經常要用到控制元件。比如開發一個客戶端WinForm應用程式時，微軟就為我們提供了若干控制元件，這些控制元件為我們提供了可被定製的屬性和事件。屬性可以更改它的外觀，比如背景色，標題等，而事件可以豐富控制元件的行為，比如最常見的『按鈕點選』，誰也不能確定點選之後將發生什麼事，是連線

Django教程之九-----高階教程：如何編寫複用的應用

這個教程緊接（7）,我們將我們的網頁問卷調查變成一個單獨的python包，你可以在新專案中重用它，也可以和其他人分享。 如果你沒有完成教程1-7，我們鼓勵你來複習這些所以你的例子專案符合下面的描述。 1. 可重用性很重要 設計，建立，測試和維護一個web應用有很多工作要

一個基於RabbitMQ的可複用的事務訊息方案

前提 分散式事務是微服務實踐中一個比較棘手的問題，在筆者所實施的微服務實踐方案中，都採用了折中或者規避強一致性的方案。參考Ebay多年前提出的本地訊息表方案，基於RabbitMQ和MySQL（JDBC）做了輕量級的封裝，實現了低入侵性的事務訊息模組。本文的內容就是詳細分析整個方案的設計思路和實施。環境依賴如下

使用php寫出一個驗證碼圖片，由於寬度被定死了，所以操作起來不太方便，之後盡量寫靈活，成為一個可調用的函數。

新手 put 由於 -type draw cat 驗證 font 寬度 <?php // Due to the height and width of the captcha image is fixed, not so easy to use, change

如何編寫一個可升級的智能合約

區塊鏈 智能合約 區塊鏈信任基礎的數據不可修改的特性，讓它傳統應用程序有一個很大的不同的地方是一經發布於區塊鏈上就無法修改（不能直接在原有的合約上直接修改再重新發布）。 寫在前面 閱讀本文前，你應該對以太坊、智能合約及Solidity語言有所了解，如果你還不了解，建議你先看以太坊是什麽 當智能合約出現

編寫一個模擬註冊用戶和驗證用戶登陸的程序

一個 input bsp BE 不存在 == code AS ges import hashlib import loggin User_pass = {‘11‘:‘ e1942a04175fdbe80e7fea0c40f7bf54‘} def get_md5(self):

老司機告訴你應用運維如何系統高效的接手一個新業務？

運維體系 應用運維 先聲明下，老司機不是自己封的，是老東家新浪的同事給封的，哈哈萬事皆有道，運維亦然，尋到規律，事辦功倍，今天跟大家分享下應用運維如何高效的接手一個新業務。很多同學接到新業務時是茫然的，不知道從哪下手，被動等待交接者交接的東西，交接完畢後依然迷糊，究其本質沒有框架和思維結構的接手是茫然

Algs4-1.2.1編寫一個Point2D的用例-分治法

\n into class divide 治法 命令 完美 out stdout 1.2.1編寫一個Point2D的用例，從命令行接受一個整數N。在單位正方形中生成N個隨機點，然後計算兩點之間的最近距離。解：采用分治法。參考資料《算法導論》中文版第三版。代碼實現過程中不太好

Algs4-1.2.2編寫一個Interval1D的用例

接受 photo generate 令行 -i emp 相交 isempty integer 1.2.2編寫一個Interval1D的用例，從命令行接受一個整數N。從標準輸入中讀取N個間隔（每個間隔由一對double值定義）並打印出所有相交的間隔對。 解：public cl

在vue中封裝可複用的元件

本次封裝的元件以toast元件為例 以前使用移動端ui外掛時，通過一句程式碼比如 $.toast( ‘ 需要顯示的內容 ’ )，從而在頁面上展示這段文字，並在一定時間後消失。 現在我們也嘗試自己封裝toast元件。 準備工作：vue-cli腳手架工程 先看一下涉及到的檔案目錄截圖：

Vue可複用性&組合

  二、自定義指令 除了核心功能預設內建的指令（v-model和v-show），Vue也允許註冊自定義指令。在Vue2.0中，程式碼複用和抽象的主要形式是元件，然而有的情況下，你仍然需要對普通DOM元素進行底層操作，這時會用到自定義指令。如當頁面載入時，輸入框將獲得焦點，只要你

封裝高可複用的服務端響應物件 --ServerResponse、ResponseCode

在平時的編碼過程中，返回給前端的資料都會統一規範起來，用一個泛型來作為響應物件 ServerResponse類 @JsonSerialize(include =  JsonSerialize.Inclusion.NON_NULL)//保證序列化json的時候,如果是nul

分析模式:可複用的物件模型中文版 pdf下載

第1章 緒論 1.1 概念模型 1.2 模式世界 1.2.1 Christopher Alexander 1.2.2 描述格式 1.2.3 關於模式的抽象程度 1.3 本書中的模式 1.3.1 建模例項 1.3.2 模式的來源 1.3.3 跨領域的模式 1.4 概念模型與

Vue可複用性&組合

二、自定義指令 除了核心功能預設內建的指令（v-model和v-show），Vue也允許註冊自定義指令。在Vue2.0中，程式碼複用和抽象的主要形式是元件，然而有的情況下，你仍然需要對普通DOM元素進行底層操作，這時會用到自定義指令。如當頁面載入時，輸入框將獲得焦點，只

angular中 modal模態框（可複用）

可複用的 （普通的在function中找） ： 點選事件之後的函式 $rootScope.confirm = function(content, okFn, cancelFn) { var

條款4~5：GotW#16 具有最大可複用的通用Containers

問題： 為下面的定長（fixed-length）vector class實現拷貝構造和拷貝賦值操作，以提供最大的可用性（usability）。提示：請考慮使用者程式碼可能會用它做哪些事情。 template<typename T,size_t size> class fixed_