Bash 腳本中的 set -euxo pipefail

有些開發人員會用Bash來實現很複雜的功能，就像使用別的高級語言一樣。他可能覺得自己很牛逼但其他人早就想錘爆他了，Bash的可讀性和可維護性遠遠低於任何高級語言。更要命的是，Bash並沒有方便的調試工具和防錯機制，出了問題你要排查半天。

在Ruby或者Python等高級語言裏，你很容易知道錯誤是哪行什麼類型的錯誤，還有IDE的Debugger加持。而Bash只能看源碼，通過打印log等非常低效的方式調試。

本文將介紹Bash中 set -euxo pipefail，它們可以幫助你寫出更容易維護也更安全的腳本。這也是Bash腳本的終極調試手段，希望你以後在自己的腳本中加上這麼一行，頭頂也能少禿一點。

set -e

set -e 選項可以讓你的腳本在出現異常時馬上退出，後續命令不再執行。默認情況下Shell腳本不會因爲錯誤而結束執行，但大多數情況是，我們希望出現異常時就不要再往下走了。假如你的if判斷條件裏會出現異常，這時腳本也會直接退出，但可能這並不是你期望的情況，這時你可以在判斷語句後加上 || true 來阻止退出。

Before

#!/bin/bash

# 'foo' is a non-existing command
foo
echo "bar"

# output
# ------
# line 4: foo: command not found
# bar

After

#!/bin/bash
set -e

# 'foo' is a non-existing command
foo
echo "bar"

# output
# ------
# line 5: foo: command not found

阻止立即退出的例子。

#!/bin/bash
set -e

# 'foo' is a non-existing command
foo || true
echo "bar"

# output
# ------
# line 5: foo: command not found
# bar

set -o pipefail

默認情況下Bash只會檢查管道（pipeline）操作最後一個命令的返回值，假如最右邊的命令成功那麼它就認爲這個語句沒問題。這個行爲其實是很不安全的，所以就有了set -o pipefail。這個特別的選項表示在管道連接的命令中，只要有任何一個命令失敗（返回值非0），則整個管道操作被視爲失敗。只有管道中所有命令都成功執行了這個管道纔算成功執行。

Before

#!/bin/bash
set -e

# 'foo' is a non-existing command
foo | echo "a"
echo "bar"

# output
# ------
# a
# line 5: foo: command not found
# bar

After

#!/bin/bash
set -eo pipefail

# 'foo' is a non-existing command
foo | echo "a"
echo "bar"

# output
# ------
# a
# line 5: foo: command not found

set -u

set -u 比較容易理解，Bash會把所有未定義的變量視爲錯誤。默認情況下Bash會將未定義的變量視爲空，不會報錯，這也是很多坑的來源。也許由於變量名的細微差別讓你查半天最後罵罵咧咧。

Before

#!/bin/bash
set -eo pipefail

echo $a
echo "bar"

# output
# ------
#
# bar

After

#!/bin/bash
set -euo pipefail

echo $a
echo "bar"

# output
# ------
# line 5: a: unbound variable

set -x

set -x 可以讓Bash把每個命令在執行前先打印出來，你可以認爲這就是Bash的Debug開關。它的好處當然顯而易見，方便你快速找到有問題的腳本位置，但是也壞處也有吧，就是Bash的log會格外的亂。另外，它在打印命令前會把變量先解析出來，所以你可以知道當前執行的語句的變量值是什麼。縱然log可能會亂一些，總比頭髮亂一些好，所以建議還是打開這個開關。

#!/bin/bash
set -euxo pipefail

a=5
echo $a
echo "bar"

# output
# ------
# + a=5
# + echo 5
# 5
# + echo bar
# bar

以上就是關於 set -euxo pipefail 的介紹，從Shell腳本的編寫角度看，我十分建議所有人都應該在自己的Shell腳本里加上這麼一行。但從實際情況看，如果你的Shell腳本已經超過200行，我更建議你換成高級語言來實現。比如Python或者Ruby甚至Perl，這些高級語言在Linux系統都是內置的，注意版本兼容性就好，寫起來比Shell舒服太多了。

關於作者：

Toby Qin, Python 技術愛好者，目前從事測試開發相關工作，轉載請註明原文出處。

歡迎關注我的博客 https://betacat.online，你可以到我的公衆號中去當吃瓜羣衆。