Bash 最佳實踐和技巧

bash · 發表 2019-02-09 13:02:27

摘要： progrium/bashstyle (中文翻譯 yujiaao) Bash 是系統程式設計的 JavaScript. 但有時使用系統程式語言如 C 或 Go 會更好, Bash 是理想的面向 POSIX 標準的小任務或命令列級系統程式語言, 下面是三個顯見的原因: 它無處不...

progrium/bashstyle (中文翻譯 yujiaao)

Bash 是系統程式設計的 JavaScript. 但有時使用系統程式語言如 C 或 Go 會更好, Bash 是理想的面向 POSIX 標準的小任務或命令列級系統程式語言, 下面是三個顯見的原因:

本文件描述了我怎麼寫 Bash 以及我希望如何與合作者一起在我的開源專案裡寫 Bash. 本文基於大量經驗和花了大量時間收集最佳實踐. 多數來自這

但此處整合, 略有修改, 並聚焦在最值錢的點上. 加上一些新東西!

記住本文不是講一般的 shell 指令碼程式設計, 這裡是專門針對 Bash 和 Bash 作為直譯器的規則.

總是用雙引號括起變數, 包括子shell. 不要裸體的$ 符號.
- 這規則會帶你走老遠了. 詳見http://mywiki.wooledge.org/Qu...
全部程式碼進函式. 即使只有一個函式,main .
```
main
readonly
```
可執行指令碼總有main 函式, 呼叫時用main 或main "$@"
- 如果指令碼也用作庫, 呼叫時用[[ "$0" == "$BASH_SOURCE" ]] && main "$@" 判斷
設定變數時總是用local 修飾, 除非有理由用declare
- 少數例外情況是當你故意想在外層空間設定一個變數.
變數都用小寫, 除非想輸出到環境中.
總用set -eo pipefail . 快速失敗並檢查退出狀態(exit codes).
- 在那些你有意讓退出狀態不為零的程式裡使用|| true .
切勿使用棄用的樣式. 最值得注意的:
- 函式定義成myfunc() { ... } , 而不是function myfunc { ... }
- 判斷條件總是用[[ 替代[ 或test
- 從不使用反引號, 使用$( ... )
- 更多詳見http://wiki.bash-hackers.org/...
優先使用絕對路徑 (藉助 $PWD), 總用./ 來修飾相對路徑.
兩行以上的函式總是在頂部用declare 聲名變數和為引數命名
```
declare arg1="$1" arg2="$2"
```
使用mktemp 建立臨時檔案, 總是用trap 來清理.
警告和錯誤應該傳送到 STDERR, 任何可解析的內容都應該轉到 STDOUT.
完成後嘗試本地化shopt 使用和禁用選項.

如果你知道你在做什麼，你可以曲解或破壞其中的一些規則，但通常它們是正確的並且非常有幫助。

使用引數定義函式

regular_func() {
declare arg1="$1" arg2="$2" arg3="$3"

# ...
}

使用最終的可變引數定義函式

variadic_func() {
local arg1="$1"; shift
local arg2="$1"; shift
local rest="$@"

# ...
}

# 測試退出程式碼（-q靜音輸出）
if grep -q 'foo' somefile; then
...
fi

# 測試輸出（ -m1 限制一個結果）
if [[ "$(grep -m1 'foo' somefile)" ]]; then
...
fi