怎么正經的實現Shell腳本單例運行？
作者:守望，linux應用開發者，目前在公眾號【編程珠璣】 分享Linux/C/C++/數據結構與算法/工具等原創技術文章和學習資源。
假設你的一個腳本已經在運行了，如果避免再次被執行呢?也就是如何實現單例運行?
看起來可行的方法
一個非常簡單的思路就是，新的腳本被執行時，先檢測當前腳本是否有其他實例正在運行，如果有則直接退出。
- #!/usr/bin/env bash
- #test.sh 來源：公眾號編程珠璣
- #獲取當前運行的test.sh腳本數
- runCount=$(ps -ef|grep test.sh | grep -v grep -c)
- if [ "${runCount}" -ge 1 ]
- then
- echo -e "test.sh already running,num:${runCount}"
- exit 1;
- fi
- while true
- do
- echo "test.sh run"
- sleep 1
- done
這里通過ps獲取到當前在運行的test.sh腳本數，如果大于1，說明已經有在運行的了。
但是你運行會發現，其程序數量不只是一個。
- $ ./test.sh
- test.sh already running,num:2
驚不驚喜?為什么為這樣呢?原因在于，shell腳本中一個命令執行相當于fork了一個進程執行，這里執行的是查找tesh.sh并grep的程序，另外還有一個就是當前運行的腳本程序，這樣的方式自然就會出現每次都有兩個了。
當然判斷條件這里你可以換一下，例如數量大于2，但終歸不太好。
文件鎖
實際上這種方法你已經在《如何讓你的程序同時只有一個在運行》介紹過了，只不過之前是用于編寫C/C++程序，而這里是用于shell腳本。
我們來回顧一下，這是一個怎樣的過程：
- 1.運行前檢查是否有該鎖文件，并且文件中的進程正在運行
- 2.如果有并且程序正在運行，則已經有實例在運行
- 3.否則，無實例，創建鎖文件，寫入進程id
- 4.退出時，刪除鎖文件
解釋一下第一條，為什么一定要確定鎖文件中的進程正在運行，因為，有些情況下如果運行的時候退出沒有刪除該文件，則會導致新的實例永遠無法運行。
- #!/usr/bin/env bash
- #來源：公眾號編程珠璣
- LOCKFILE=/tmp/test.lock
- if [ -e ${LOCKFILE} ] && kill -0 `cat ${LOCKFILE}`; then
- echo " $0 already running"
- exit
- fi
- # 確保退出時，鎖文件被刪除
- trap "rm -f ${LOCKFILE}; exit" INT TERM EXIT
- #將當前程序進程id寫入鎖文件
- echo $$ > ${LOCKFILE}
- # 做你需要的事情
- sleep 1000
- # 刪除鎖文件
- rm -f ${LOCKFILE}
我們試著運行其中一個，然后另外一個窗口嘗試運行：
- $ ./test.sh
- ./test.sh already running
由于已經有實例在運行，發現新的程序無法運行了。而等舊的腳本運行完之后，新的就可以運行了。
實際上這里面有幾個點非常巧妙：
- kill -0 `cat \${LOCKFILE}` 這里用于檢測該進程是否存在，避免進程不在了，但是鎖文件還在，導致后面的腳本無法運行。
- trap "rm -f \${LOCKFILE}; exit" INT TERM EXIT 用于確保腳本退出時，鎖文件會被刪除。
- rm -f {LOCKFILE} 腳本最后需要刪除鎖文件
flock
說到鎖文件，這里就不得不提flock命令了。沒有前面的一些巧妙處理，我們很多時候會很難刪除原先創建的鎖文件，比如：
- 腳本被意外中斷，沒來得及執行刪除
- 多個腳本產生競爭，導致判斷異常，比如前面有一個腳本運行，判斷沒有鎖文件，下一步準備創建，但是另外一個腳本又先創建了，就會導致異常了。
因此我們可以考慮使用flock：
- #!/usr/bin/env bash
- #來源：公眾號編程珠璣
- LOCK_FILE=/tmp/test.lock
- exec 99>"$LOCK_FILE"
- flock -n 99
- if [ "$?" != 0 ]; then
- echo "$0 already running"
- exit 1
- fi
- #腳本要做的其他事情
- sleep 1024
解釋一下：
- exec 99>"$LOCK_FILE" 表示創建文件描述符99，指向鎖文件，為何是99?110其實也是可以的，只是為了和當前腳本可能打開的文件描述符沖突(例如和0,1,2沖突)。
- flock -n 99 嘗試對該文件描述符加鎖，由操作系統保證原子性
- 一旦flock失敗了，我們這里可以退出
- 而即使鎖定了，腳本退出后，也會自動釋放
因此這里避免了鎖沒有釋放的情況。
另一種做法
查看flock的man手冊，我們發現它還有一個例子是這么做的：
- [ "${FLOCKER}" != "$0" ] && exec env FLOCKER="$0" flock -en "$0" "$0" "$@" || :
在腳本開頭加上上面這么一行就可以了。例如：
- #!/usr/bin/env bash
- #來源：公眾號編程珠璣
- [ "${FLOCKER}" != "$0" ] && exec env FLOCKER="$0" flock -en "$0" "$0" "$@" || :
- #腳本要做的其他事情
- sleep 1024
解釋一下：
- 如果${FLOCKER}環境變量沒有設置，則嘗試將腳本本身加鎖，如果加鎖成功，則運行當前腳本，(并且帶上原有的參數)，否則的話靜默退出。
總結
單例運行本身思路是很簡單的，就是探測當前是否有實例在運行，如果有，則退出，但是這里如何判斷，卻并不是那么容易。
最后，總結一下本文出現的一些該掌握的信息
- $0 腳本名稱
- $@ 腳本參數
- $$ 當前腳本進程id
- $? 上一條命令執行結果
- 描述符0 標準輸入
- 描述符1 標準輸出
- 描述符2 標準錯誤
- > 重定向
本文轉載自微信公眾號「 編程珠璣」，可以通過以下二維碼關注。轉載本文請聯系 編程珠璣公眾號。
