如何在 Linux 或者 UNIX 下調試 Bash Shell 腳本

讓我們看看如何使用各種方法調試 Linux 和 UNIX 上運行的腳本。

-x 選項來調試腳本

用 -x 選項來運行腳本：

$ bash -x script-name
$ bash -x domains.sh

使用 set 內置命令

bash shell 提供調試選項，可以打開或關閉使用 set 命令：

• set -x : 顯示命令及其執行時的參數。
• set -v : 顯示 shell 輸入行作為它們讀取的

可以在 shell 腳本本身中使用上面的兩個命令：

#!/bin/bash
clear

# turn on debug mode
set -x
for f in *
do
   file $f
done
# turn OFF debug mode
set +x
ls
# more commands

你可以代替 標準釋伴 行：

#!/bin/bash

用以下代碼（用於調試）：

#!/bin/bash -xv

使用智能調試功能

首先添加一個叫做 _DEBUG 的特殊變數。當你需要調試腳本的時候，設置 _DEBUG 為 on：

_DEBUG="on"

在腳本的開頭放置以下函數：

function DEBUG()
{
 [ "$_DEBUG" == "on" ] &&  $@
}

現在，只要你需要調試，只需使用 DEBUG 函數如下：

DEBUG echo "File is $filename"

或者：

DEBUG set -x
Cmd1
Cmd2
DEBUG set +x

當調試完（在移動你的腳本到生產環境之前）設置 _DEBUG 為 off。不需要刪除調試行。

_DEBUG="off" # 設置為非 'on' 的任何字元

示例腳本：

#!/bin/bash
_DEBUG="on"
function DEBUG()
{
 [ "$_DEBUG" == "on" ] &&  $@
}

DEBUG echo 'Reading files'
for i in *
do
  grep 'something' $i > /dev/null
  [ $? -eq 0 ] && echo "Found in $i file"
done
DEBUG set -x
a=2
b=3
c=$(( $a + $b ))
DEBUG set +x
echo "$a + $b = $c"

保存並關閉文件。運行腳本如下：

$ ./script.sh

輸出：

Reading files
Found in xyz.txt file
+ a=2
+ b=3
+ c=5
+ DEBUG set +x
+ '[' on == on ']'
+ set +x
2 + 3 = 5

現在設置 _DEBUG 為 off（你需要編輯該文件）：

_DEBUG="off"

運行腳本：

$ ./script.sh

輸出：

Found in xyz.txt file
2 + 3 = 5

以上是一個簡單但非常有效的技術。還可以嘗試使用 DEBUG 作為別名而不是函數。

調試 Bash Shell 的常見錯誤

Bash 或者 sh 或者 ksh 在屏幕上給出各種錯誤信息，在很多情況下，錯誤信息可能不提供詳細的信息。

跳過在文件上應用執行許可權

當你 編寫你的第一個 hello world 腳本,您可能會得到一個錯誤，如下所示：

bash: ./hello.sh: Permission denied

設置許可權使用 chmod 命令:

$ chmod +x hello.sh
$ ./hello.sh
$ bash hello.sh

文件結束時發生意外的錯誤

如果您收到文件結束意外錯誤消息，請打開腳本文件，並確保它有打開和關閉引號。在這個例子中，echo 語句有一個開頭引號，但沒有結束引號：

#!/bin/bash

...
....

echo 'Error: File not found
                           ^^^^^^^
                           missing quote

還要確保你檢查缺少的括弧和大括弧 {}：

#!/bin/bash
.....
[ ! -d $DIRNAME ] && { echo "Error: Chroot dir not found"; exit 1;
                                                                    ^^^^^^^^^^^^^
                                                                    missing brace }
...

丟失像 fi，esac，;; 等關鍵字。

如果你缺少了結尾的關鍵字，如 fi 或 ;; 你會得到一個錯誤，如 「XXX 意外」。因此，確保所有嵌套的 if 和 case 語句以適當的關鍵字結束。有關語法要求的頁面。在本例中，缺少 fi：

#!/bin/bash
echo "Starting..."
....
if [ $1 -eq 10 ]
then
   if [ $2 -eq 100 ]
   then
      echo "Do something"
fi

for f in $files
do
  echo $f
done

# 注意 fi 丟失了

在 Windows 或 UNIX 框中移動或編輯 shell 腳本

不要在 Linux 上創建腳本並移動到 Windows。另一個問題是編輯 Windows 10上的 shell 腳本並將其移動到 UNIX 伺服器上。這將由於換行符不同而導致命令沒有發現的錯誤。你可以使用下列命令 將 DOS 換行轉換為 CR-LF 的Unix/Linux 格式 ：

dos2unix my-script.sh

技巧

技巧 1 - 發送調試信息輸出到標準錯誤

[標準錯誤] 是默認錯誤輸出設備，用於寫所有系統錯誤信息。因此，將消息發送到默認的錯誤設備是個好主意：

# 寫錯誤到標準輸出
echo "Error: $1 file not found"
#
# 寫錯誤到標準錯誤（注意 1>&2 在 echo 命令末尾）
#
echo "Error: $1 file not found" 1>&2

技巧 2 - 在使用 vim 文本編輯器時，打開語法高亮

大多數現代文本編輯器允許設置語法高亮選項。這對於檢測語法和防止常見錯誤如打開或關閉引號非常有用。你可以在不同的顏色中看到。這個特性簡化了 shell 腳本結構中的編寫，語法錯誤在視覺上截然不同。高亮不影響文本本身的意義，它只為你提示而已。在這個例子中，我的腳本使用了 vim 語法高亮：

!如何調試 Bash Shell 腳本，在 Linux 或者 UNIX 使用 Vim 語法高亮特性]7

技巧 3 - 使用 shellcheck 檢查腳本

shellcheck 是一個用於靜態分析 shell 腳本的工具。可以使用它來查找 shell 腳本中的錯誤。這是用 Haskell 編寫的。您可以使用這個工具找到警告和建議。你可以看看如何在 Linux 或 類UNIX 系統上安裝和使用 shellcheck 來改善你的 shell 腳本，避免錯誤和高效。

作者：Vivek Gite

作者是 nixCraft 創造者，一個經驗豐富的系統管理員和一個練習 Linux 操作系統/ UNIX shell 腳本的教練。他曾與全球客戶和各種行業，包括 IT，教育，國防和空間研究，以及非營利部門。關注他的 推特，臉譜網，谷歌+ 。

via: https://www.cyberciti.biz/tips/debugging-shell-script.html

作者：Vivek Gite 譯者：zjon 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive