BASH 的調試手段

BASH 的調試手段

echo/print (普通技)

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

_loglevel=2

DIE() {

    echo "Critical: $1>" >&2

    exit 1

}

INFO() {

    [ $_loglevel -ge 2 ] && echo "INFO: $1>" >&2

}

ERROR() {

    [ $_loglevel -ge 1 ] && echo "ERROR: $1>" >&2

}

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

# add color

[ $_loglevel -ge 1 ] && echo -e "\033[31m ERROR:\033[0m $1>" >&2

# redirect to file

[ $_loglevel -ge 1 ] && echo "ERROR: $1>" > /var/log/xxx_log.$BASHPID

set -x (稀有技)

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

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

set -x

INFO "this is a info log>"

ERROR "this is a error log>"

set +x

如果想全程打開 xtrace，可以在執行腳本的時候加 -x參數。

trap/bashdb (史詩技)

為了方便調試，BASH 也提供了陷阱機制。這跟之前介紹的兩種方法高級不少。我們可以利用 trap 這個內置命令來指定各個 sigspec 應該執行的命令。trap 的具體用法如下：

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

sigspec 包括 中定義的各個 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：

#!/bin/bash

trap "echo this is a exit echo>" EXIT

echo "this is a normal echo>"

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

#!/bin/bash

trap 'echo $BASH_COMMAND return err' ERR

echo this is a normal test

UnknownCmd

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

#!/bin/bash

trap '(read -p "[$0 : $LINENO] $BASH_COMMAND ?>")' DEBUG

echo this is a test

i=0

while [ true ]

do

    echo $i

    ((i++))

done