快捷導(dǎo)航

如何編寫健壯的Bash腳本(經(jīng)驗分享)

更新時間：2013年11月20日 18:58:23 投稿：mdxy-dxy

本文介紹下，編寫出健壯的bash shell腳本的方法，感興趣的朋友參考學(xué)習(xí)下

shell腳本在運行異常時會受到非常大的影響。

本文介紹一些讓bash腳本變得健壯的技術(shù)。

使用set -u

因為沒有對變量初始化而使腳本崩潰過多少次？對于我來說，很多次。
chroot=$1
...
rm -rf $chroot/usr/share/doc
如果上面的代碼沒有給參數(shù)就運行，不會僅僅刪除掉chroot中的文檔，而是將系統(tǒng)的所有文檔都刪除。那應(yīng)該做些什么呢？好在bash提供了set -u，當(dāng)使用未初始化的變量時，讓bash自動退出。

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

復(fù)制代碼代碼如下:

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

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

使用-e把從檢查錯誤中解放出來。如果忘記了檢查，bash會替做這件事。不過也沒有辦法使用$?來獲取命令執(zhí)行狀態(tài)了，因為bash無法獲得任何非0的返回值?？梢允褂昧硪环N結(jié)構(gòu)：

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 ，或者有一段很長的代碼，可以暫時關(guān)閉錯誤檢查功能，不過我建議謹慎使用。

set +e

command1

command2

set -e

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

程序防御 - 考慮意料之外的事

的腳本也許會被放到“意外”的賬戶下運行，像缺少文件或者目錄沒有被創(chuàng)建等情況?？梢宰鲆恍╊A(yù)防這些錯誤事情。比如，當(dāng)創(chuàng)建一個目錄后，如果父目錄不存在，mkdir 命令會返回一個錯誤。如果創(chuàng)建目錄時給mkdir命令加上-p選項，它會在創(chuàng)建需要的目錄前，把需要的父目錄創(chuàng)建出來。另一個例子是rm 命令。如果要刪除一個不存在的文件，它會“吐槽”并且的腳本會停止工作。（因為使用了-e選項，對吧？）可以使用-f選項來解決這個問題，在文件不存在的時候讓腳本繼續(xù)工作。

準(zhǔn)備好處理文件名中的空格

有些人從在文件名或者命令行參數(shù)中使用空格，需要在編寫腳本時時刻記得這件事。需要時刻記得用引號包圍變量。

if [ $filename = "foo" ];

當(dāng)$filename變量包含空格時就會掛掉?？梢赃@樣解決：

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

使用$@變量時，也需要使用引號，因為空格隔開的兩個參數(shù)會被解釋成兩個部分。

復(fù)制代碼代碼如下:

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

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

如果同時使用find和xargs，應(yīng)該使用 -print0 來讓字符分割文件名，而不是換行符分割。

復(fù)制代碼代碼如下:

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

設(shè)置的陷阱

當(dāng)編寫的腳本掛掉后，文件系統(tǒng)處于未知狀態(tài)。比如鎖文件狀態(tài)、臨時文件狀態(tài)或者更新了一個文件后在更新下一個文件前掛掉。如果能解決這些問題，無論是刪除鎖文件，又或者在腳本遇到問題時回滾到已知狀態(tài)，都是非常棒的。幸運的是，bash提供了一種方法，當(dāng)bash接收到一個UNIX信號時，運行一個命令或者一個函數(shù)?？梢允褂胻rap命令。

trap command signal [signal ...]

可以鏈接多個信號（列表可以使用kill -l獲得），但是為了清理殘局，我們只使用其中的三個：INT，TERM和EXIT。可以使用-as來讓traps恢復(fù)到初始狀態(tài)。

信號描述
INT
Interrupt - 當(dāng)有人使用Ctrl-C終止腳本時被觸發(fā)

EXIT
Exit - 這是一個偽信號，當(dāng)腳本正常退出或者set -e后因為出錯而退出時被觸發(fā)

當(dāng)使用鎖文件時，可以這樣寫：

復(fù)制代碼代碼如下:

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

解決方法：

復(fù)制代碼代碼如下:

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

竟態(tài)條件 (wikipedia)

在上面鎖文件的例子中，有一個竟態(tài)條件是不得不指出的，它存在于判斷鎖文件和創(chuàng)建鎖文件之間。一個可行的解決方法是使用IO重定向和bash的noclobber(wikipedia)模式，重定向到不存在的文件。

可以這么做：

復(fù)制代碼代碼如下:

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

更復(fù)雜一點兒的問題是要更新一大堆文件，當(dāng)它們更新過程中出現(xiàn)問題時，是否能讓腳本掛得更加優(yōu)雅一些。想確認那些正確更新了，哪些根本沒有變化。比如需要一個添加用戶的腳本。

復(fù)制代碼代碼如下:

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

復(fù)制代碼代碼如下:

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關(guān)閉rollback調(diào)用，否則當(dāng)腳本正常退出的時候rollback將會被調(diào)用，那么腳本等于什么都沒做。

保持原子化

又是需要一次更新目錄中的一大堆文件，比如需要將URL重寫到另一個網(wǎng)站的域名。
也許會寫：

復(fù)制代碼代碼如下:

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

如果修改到一半是腳本出現(xiàn)問題，一部分使用www.example.com，而另一部分使用www.example.net。可以使用備份和trap解決，但在升級過程中的網(wǎng)站URL是不一致的。

解決方法：

將這個改變做成一個原子操作。先對數(shù)據(jù)做一個副本，在副本中更新URL，再用副本替換掉現(xiàn)在工作的版本。
需要確認副本和工作版本目錄在同一個磁盤分區(qū)上，這樣就可以利用Linux系統(tǒng)的優(yōu)勢，它移動目錄僅僅是更新目錄指向的inode節(jié)點。

復(fù)制代碼代碼如下:

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

這意味著如果更新過程出問題，線上系統(tǒng)不會受影響。線上系統(tǒng)受影響的時間降低為兩次mv操作的時間，這個時間非常短，因為文件系統(tǒng)僅更新inode而不用真正的復(fù)制所有的數(shù)據(jù)。

缺點：

需要兩倍的磁盤空間，而且那些長時間打開文件的進程需要比較長的時間才能升級到新文件版本，建議更新完成后重新啟動這些進程。
對于 apache服務(wù)器來說這不是問題，因為它每次都重新打開文件。
可以使用lsof命令查看當(dāng)前正打開的文件。優(yōu)勢是有了一個先前的備份，當(dāng)需要還原時，它就派上用場了。