BASH 的調試技巧

平時在寫 BASH 腳本時，老是會碰到讓人抓狂的 BUG。和 C/C++ 這麼豐富的調試工具相比，BASH 又有什麼調試手段呢？

1 echo/print (普通技)

打印一些變量，或者提示信息。這應該是一個通用的方法了。在 BASH 裏，咱們能夠簡單的用 echo，或者 print 來輸出一些 log，或者加一些 loglevel 來過濾一些 log。這裏貼一下我日常用的函數：

1. _loglevel=2
2.  
3. DIE() {
4. echo "Critical: $1" >&2
5. exit 1
6. }
7.  
8. INFO() {
9. [ $_loglevel -ge 2 ] && echo "INFO: $1" >&2
10. }
11.  
12. ERROR() {
13. [ $_loglevel -ge 1 ] && echo "ERROR: $1" >&2
14. }

這裏的實現只是簡單的加了一個 loglevel，其實能夠把 log 輸出到一個文件中，或者給 log 加上顏色。好比：

1. # add color
2. [ $_loglevel -ge 1 ] && echo -e "\033[31m ERROR:\033[0m $1" >&2
3. # redirect to file
4. [ $_loglevel -ge 1 ] && echo "ERROR: $1" > /var/log/xxx_log.$BASHPID
5.  

2 set -x (稀有技)

-x(xtrace) 選項會致使 BASH 在執行命令以前，先把要執行的命令打印出來。這個選項對調試一些命令錯誤頗有幫助。

有的時候，因爲傳進來的參數帶有一些特殊字符，致使 BASH 解析時不是按照咱們預想的進行。這個時候，把 -x 打開，就能在命令執行前，把擴展後的命令打印出來。好比基於前面寫的函數：

1. set -x
2. INFO "this is a info log"
3. ERROR "this is a error log"
4. set +x

而後就能夠看到以下輸出：

1. + INFO 'this is a info log'
2. + '[' 2 -ge 2 ']'
3. + echo -e '\033[32m INFO:\033[0m this is a info log'
4. INFO: this is a info log
5. + ERROR 'this is a error log'
6. + '[' 2 -ge 1 ']'
7. + echo -e '\033[33m ERR:\033[0m this is a error log'
8. ERR: this is a error log
9. + set +x

若是想全程打開 xtrace，能夠在執行腳本的時候加 -x 參數。

3 trap/bashdb (史詩技)

爲了方便調試，BASH 也提供了陷阱機制。這跟以前介紹的兩種方法高級很多。咱們能夠利用 trap 這個內置命令來指定各個 sigspec 應該執行的命令。trap 的具體用法以下：

1. trap [-lp] [[arg] sigspec ...]

sigspec 包括 <signal.h> 中定義的各個 signal， EXIT，ERR，RETURN 和 DEBUG。

各個 signal 這裏就不介紹了。EXIT 會在 shell 退出時執行指定的命令。若當前 shell 中有命令執行返回非零值，則會執行與 ERR 相關聯的命令。而 RETURN 是針對 source 和 . ，每次執行都會觸發 RETURN 陷阱。若綁定一個命令到 DEBUG，則會在每個命令執行以前，都會先執行 DEBUG 這個 trap。這裏要注意的是，ERR 和 DEBUG 只在當前 shell 有效。若想函數和子 shell 自動繼承這些 trap，則能夠設置 -T(DEBUG/RETURN) 和 -E(ERR)。

好比，下面的腳本會在退出時，執行echo：

1. #!/bin/bash
2.  
3. trap "echo this is a exit echo" EXIT
4.  
5. echo "this is a normal echo"

或者，讓腳本中命令出錯時，把相應的命令打印出來：

1. #!/bin/bash
2.  
3. trap 'echo $BASH_COMMAND return err' ERR
4.  
5. echo this is a normal test
6. UnknownCmd

這個腳本的輸出以下：

1. this is a normal test
2. tt.sh: line 6: UnknownCmd: command not found
3. UnknownCmd return err

亦或者，讓腳本的命令單步執行：

1. #!/bin/bash
2.  
3. trap '(read -p "[$0 : $LINENO] $BASH_COMMAND ?")' DEBUG
4.  
5. echo this is a test
6.  
7. i=0
8. while [ true ]
9. do
10. echo $i
11. ((i++))
12. done

其輸出以下：

1. [tt.sh : 5] echo this is a test ?
2. this is a test
3. [tt.sh : 7] i=0 ?
4. [tt.sh : 8] [ true ] ?
5. [tt.sh : 10] echo $i ?
6. 0
7. [tt.sh : 11] ((i++)) ?
8. [tt.sh : 8] [ true ] ?
9. [tt.sh : 10] echo $i ?
10. 1
11. [tt.sh : 11] ((i++)) ?
12. [tt.sh : 8] [ true ] ?
13. [tt.sh : 10] echo $i ?
14. 2
15. [tt.sh : 11] ((i++)) ?

是否是有點意思了？其實有一個 bashdb 的開源項目，也是利用 trap 機制，模擬 gdb 作了一個 bash 腳本的調試器。它自己也是一個 bash 腳本。在加載要調試的腳本後，能夠用和 gdb 相似的命令，甚至縮寫也是同樣的，你們能夠嘗試一下:)

(上個月沉迷於 Diablo3，最後發現本身臉不行，悴！仍是回來寫點東西吧！)