shell 語句出錯自動退出

許多人用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" ];
使用

[email protected]變數時，你也需要使用引號，因為空格隔開的兩個引數會被解釋成兩個獨立的部分。

david% foo() { for i in [email protected]; do echo $i; done }; foo bar "baz quux"
bar
baz
quux
david% foo() { for i in "[email protected]"; do echo $i; done }; foo bar "baz quux"
bar
baz quux

我沒有想到任何不能使用"[email protected]"的時候，所以當你有疑問的時候，使用引號就沒有錯誤。
如果你同時使用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恢復到初始狀態。
訊號描述
INTInterrupt - 當有人使用Ctrl-C終止指令碼時被觸發
TERMTerminate - 當有人使用kill殺死指令碼程序時被觸發
EXITExit - 這是一個偽訊號，當指令碼正常退出或者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