快捷導(dǎo)航

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

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

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

shell腳本在運(yùn)行異常時(shí)會(huì)受到非常大的影響。

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

使用set -u

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

也可以使用可讀性更強(qiáng)一點(diǎn)的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

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

使用-e把從檢查錯(cuò)誤中解放出來(lái)。如果忘記了檢查，bash會(huì)替做這件事。不過也沒有辦法使用$?來(lái)獲取命令執(zhí)行狀態(tài)了，因?yàn)閎ash無(wú)法獲得任何非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值的命令，或者對(duì)返回值并不感興趣呢？可以使用 command || true ，或者有一段很長(zhǎng)的代碼，可以暫時(shí)關(guān)閉錯(cuò)誤檢查功能，不過我建議謹(jǐn)慎使用。

set +e

command1

command2

set -e

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

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

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

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

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

if [ $filename = "foo" ];

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

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

使用$@變量時(shí)，也需要使用引號(hào)，因?yàn)榭崭窀糸_的兩個(gè)參數(shù)會(huì)被解釋成兩個(gè)部分。

復(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

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

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

復(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)、臨時(shí)文件狀態(tài)或者更新了一個(gè)文件后在更新下一個(gè)文件前掛掉。如果能解決這些問題，無(wú)論是刪除鎖文件，又或者在腳本遇到問題時(shí)回滾到已知狀態(tài)，都是非常棒的。幸運(yùn)的是，bash提供了一種方法，當(dāng)bash接收到一個(gè)UNIX信號(hào)時(shí)，運(yùn)行一個(gè) 命令或者一個(gè)函數(shù)?？梢允褂胻rap命令。

trap command signal [signal ...]

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

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

EXIT
Exit - 這是一個(gè)偽信號(hào)，當(dāng)腳本正常退出或者set -e后因?yàn)槌鲥e(cuò)而退出時(shí)被觸發(fā)

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

復(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)

在上面鎖文件的例子中，有一個(gè)竟態(tài)條件是不得不指出的，它存在于判斷鎖文件和創(chuàng)建鎖文件之間。一個(gè)可行的解決方法是使用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ù)雜一點(diǎn)兒的問題是要更新一大堆文件，當(dāng)它們更新過程中出現(xiàn)問題時(shí)，是否能讓腳本掛得更加優(yōu)雅一些。想確認(rèn)那些正確更新了，哪些根本沒有變化。比如需要一個(gè)添加用戶的腳本。

復(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)腳本正常退出的時(shí)候rollback將會(huì)被調(diào)用，那么腳本等于什么都沒做。

保持原子化

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

復(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?？梢允褂脗浞莺蛅rap解決，但在升級(jí)過程中的網(wǎng)站URL是不一致的。

解決方法：

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

復(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)不會(huì)受影響。線上系統(tǒng)受影響的時(shí)間降低為兩次mv操作的時(shí)間，這個(gè)時(shí)間非常短，因?yàn)槲募到y(tǒng)僅更新inode而不用真正的復(fù)制所有的數(shù)據(jù)。

缺點(diǎn)：

需要兩倍的磁盤空間，而且那些長(zhǎng)時(shí)間打開文件的進(jìn)程需要比較長(zhǎng)的時(shí)間才能升級(jí)到新文件版本，建議更新完成后重新啟動(dòng)這些進(jìn)程。
對(duì)于 apache服務(wù)器來(lái)說(shuō)這不是問題，因?yàn)樗看味贾匦麓蜷_文件。
可以使用lsof命令查看當(dāng)前正打開的文件。優(yōu)勢(shì)是有了一個(gè)先前的備份，當(dāng)需要還原時(shí)，它就派上用場(chǎng)了。