如何編寫健壯的Bash指令碼(經驗分享)_linux shell

shell指令碼在運行異常時會受到非常大的影響。

本文介紹一些讓bash指令碼變得健壯的技術。

使用set -u

因為沒有對變數初始化而使指令碼崩潰過多少次？對於我來說，很多次。
chroot=$1
...
rm -rf $chroot/usr/share/doc
如果上面的代碼沒有給參數就運行，不會僅僅刪除掉chroot中的文檔，而是將系統的所有文檔都刪除。那應該做些什麼呢？好在bash提供了set -u，當使用未初始化的變數時，讓bash自動結束。

也可以使用可讀性更強一點的set -o nounset。

複製代碼 代碼如下:

david% bash /tmp/shrink-chroot.sh
$chroot=
david% bash -u /tmp/shrink-chroot.sh
/tmp/shrink-chroot.sh: line 3: $1: unbound variable
david%

使用set -e

寫的每一個指令碼的開始都應該包含set -e。這告訴bash一但有任何一個語句返回非真的值，則退出bash。使用-e的好處是避免錯誤滾雪球般的變成嚴重錯誤，能儘早的捕獲錯誤。更加可讀的版本：set -o errexit

使用-e把從檢查錯誤中解放出來。如果忘記了檢查，bash會替做這件事。不過也沒有辦法使用$?來擷取命令執行狀態了，因為bash無法獲得任何非0的傳回值。可以使用另一種結構：

command

if [ "$?"-ne 0]; then echo "command failed"; exit 1; fi

可以替換成：

command || { echo "command failed"; exit 1; }

或者使用：

if ! command; then echo "command failed"; exit 1; fi

如果必須使用返回非0值的命令，或者對傳回值並不感興趣呢？可以使用 command || true ，或者有一段很長的代碼，可以暫時關閉錯誤檢查功能，不過我建議謹慎使用。

set +e

command1

command2

set -e

相關文檔指出，bash預設返回管道中最後一個命令的值，也許是不想要的那個。比如執行 false | true 將會被認為命令成功執行。如果想讓這樣的命令被認為是執行失敗，可以使用 set -o pipefail

程式防禦 - 考慮意料之外的事

的指令碼也許會被放到“意外”的賬戶下運行，像缺少檔案或者目錄沒有被建立等情況。可以做一些預防這些錯誤事情。比如，當建立一個目錄後，如果父目錄不存在，mkdir 命令會返回一個錯誤。如果建立目錄時給mkdir命令加上-p選項，它會在建立需要的目錄前，把需要的父目錄建立出來。另一個例子是rm 命令。如果要刪除一個不存在的檔案，它會“吐槽”並且的指令碼會停止工作。（因為使用了-e選項，對吧？）可以使用-f選項來解決這個問題，在檔案不存在的時候讓指令碼繼續工作。

準備好處理檔案名稱中的空格

有些人從在檔案名稱或者命令列參數中使用空格，需要在編寫指令碼時時刻記得這件事。需要時刻記得用引號包圍變數。

if [ $filename = "foo" ];

當$filename變數包含空格時就會掛掉。可以這樣解決：

if [ "$filename" = "foo" ];

使用$@變數時，也需要使用引號，因為空白格隔開的兩個參數會被解釋成兩個獨立的部分。

複製代碼 代碼如下:

david% foo() { for i in $@; do echo $i; done }; foo bar "baz quux"
bar
baz
quux
david% foo() { for i in "$@"; do echo $i; done }; foo bar "baz quux"
bar
baz quux

我沒有想到任何不能使用"$@"的時候，所以當有疑問的時候，使用引號就沒有錯誤。

如果同時使用find和xargs，應該使用 -print0 來讓字元分割檔案名稱，而不是分行符號分割。

複製代碼 代碼如下:

david% touch "foo bar"
david% find | xargs ls
ls: ./foo: No such file or directory
ls: bar: No such file or directory
david% find -print0 | xargs -0 ls
./foo bar

設定的陷阱

當編寫的指令碼掛掉後，檔案系統處於未知狀態。比如鎖檔案狀態、臨時檔案狀態或者更新了一個檔案後在更新下一個檔案前掛掉。如果能解決這些問題，無論是 刪除鎖檔案，又或者在指令碼遇到問題時復原到已知狀態，都是非常棒的。幸運的是，bash提供了一種方法，當bash接收到一個UNIX訊號時，運行一個 命令或者一個函數。可以使用trap命令。

trap command signal [signal ...]

可以連結多個訊號（列表可以使用kill -l獲得），但是為了清理殘局，我們只使用其中的三個：INT，TERM和EXIT。可以使用-as來讓traps恢複到初始狀態。

訊號描述
INT
Interrupt - 當有人使用Ctrl-C終止指令碼時被觸發

TERM
Terminate - 當有人使用kill殺死指令碼進程時被觸發

EXIT
Exit - 這是一個偽訊號，當指令碼正常退出或者set -e後因為出錯而退出時被觸發

當使用鎖檔案時，可以這樣寫：

複製代碼 代碼如下:

if [ ! -e $lockfile ]; then
touch $lockfile
critical-section
rm $lockfile
else
echo "critical-section is already running"
fi

當最重要的部分(critical-section)正在運行時，如果殺死了指令碼進程，會發生什麼呢？
鎖檔案會被扔在那，而且的指令碼在它被刪除以前再也不會運行了。

解決方案：

複製代碼 代碼如下:

if [ ! -e $lockfile ]; then
trap " rm -f $lockfile; exit" INT TERM EXIT
touch $lockfile
critical-section
rm $lockfile
trap - INT TERM EXIT
else
echo "critical-section is already running"
fi

現在當殺死進程時，鎖檔案一同被刪除。注意在trap命令中明確地退出了指令碼，否則指令碼會繼續執行trap後面的命令。

竟態條件 (wikipedia)

在上面鎖檔案的例子中，有一個竟態條件是不得不指出的，它存在於判斷鎖檔案和建立鎖檔案之間。一個可行的解決方案是使用IO重新導向和bash的noclobber(wikipedia)模式，重新導向到不存在的檔案。

可以這麼做：

複製代碼 代碼如下:

if ( set -o noclobber; echo "$$" > "$lockfile") 2> /dev/null;
then
trap 'rm -f "$lockfile"; exit $?' INT TERM EXIT
critical-section
rm -f "$lockfile"
trap - INT TERM EXIT
else
echo "Failed to acquire lockfile: $lockfile"
echo "held by $(cat $lockfile)"
fi

更複雜一點兒的問題是要更新一大堆檔案，當它們更新過程中出現問題時，是否能讓指令碼掛得更加優雅一些。想確認那些正確更新了，哪些根本沒有變化。比如需要一個添加使用者的指令碼。

複製代碼 代碼如下:

add_to_passwd $user
cp -a /etc/skel /home/$user
chown $user /home/$user -R

當磁碟空間不足或者進程中途被殺死，這個指令碼就會出現問題。在這種情況下，也許希望使用者賬戶不存在，而且他的檔案也應該被刪除。

複製代碼 代碼如下:

rollback() {
del_from_passwd $user
if [ -e /home/$user ]; then
rm -rf /home/$user
fi
exit
}

trap rollback INT TERM EXIT
add_to_passwd $user

cp -a /etc/skel /home/$user
chown $user /home/$user -R

trap - INT TERM EXIT

在指令碼最後需要使用trap關閉rollback調用，否則當指令碼正常退出的時候rollback將會被調用，那麼指令碼等於什麼都沒做。

保持原子化

又是需要一次更新目錄中的一大堆檔案，比如需要將URL重寫到另一個網站的網域名稱。
也許會寫：

複製代碼 代碼如下:

for file in $(find /var/www -type f -name "*.html"); do
perl -pi -e 's/www.example.net/www.example.com/' $file
done

如果修改到一半是指令碼出現問題，一部分使用www.example.com，而另一部分使用www.example.net。可以使用備份和trap解決，但在升級過程中的網站URL是不一致的。

解決方案：

將這個改變做成一個原子操作。先對資料做一個副本，在副本中更新URL，再用副本替換掉現在工作的版本。
需要確認副本和工作版本目錄在同一個磁碟分割上，這樣就可以利用Linux系統的優勢，它移動目錄僅僅是更新目錄指向的inode節點。

複製代碼 代碼如下:

cp -a /var/www /var/www-tmp
for file in $(find /var/www-tmp -type -f -name "*.html"); do
perl -pi -e 's/www.example.net/www.example.com/' $file
done
mv /var/www /var/www-old
mv /var/www-tmp /var/www

這意味著如果更新過程出問題，線上系統不會受影響。線上系統受影響的時間降低為兩次mv操作的時間，這個時間非常短，因為檔案系統僅更新inode而不用真正的複製所有的資料。

缺點：

需要兩倍的磁碟空間，而且那些長時間開啟檔案的進程需要比較長的時間才能升級到新檔案版本，建議更新完成後重新啟動這些進程。
對於 apache伺服器來說這不是問題，因為它每次都重新開啟檔案。
可以使用lsof命令查看當前正開啟的檔案。優勢是有了一個先前的備份，當需要還原 時，它就派上用場了。