Shell 腳本的除錯技巧

在 Linux 系統管理與自動化運維中，Shell 腳本無疑是最強大的工具之一。然而，隨著腳本邏輯變得複雜，排錯（Debugging）往往成為最耗時的環節。許多初學者習慣使用 echo 來列印變數值，但這在大型專案中不僅混亂，還可能因引數處理不當而導致輸出錯誤。今天，我們將深入探討 Shell 內建的除錯機制，讓你的腳本開發過程更加順暢。

開啟全域除錯模式

Shell 提供了一個非常直觀的除錯開關：set -x。當你在腳本中加入這行指令後，Shell 會將每一個即將執行的命令及其參數列印到標準錯誤輸出（stderr）。這對於追蹤命令執行順序和參數展開結果極為有效。

除了手動加入指令，更推薦在腳本開頭直接設定。以下是一個簡單的範例，展示如何觀察變數展開與命令執行過程：

#!/bin/bash

# 開啟全域除錯模式
set -x

# 定義變數
name="Ubuntu"
version="22.04"

# 執行命令，你會看到 shell 先展開變數，再執行
echo "Hello, ${name} ${version}!"

# 結束除錯模式（可選，避免後續無關輸出干擾）
set +x

echo "除錯模式已關閉，這是正常輸出。"

執行此腳本後，你會發現輸出中多出了帶有 + 號的資訊，例如 + echo "Hello, Ubuntu 22.04!"。這能清楚告訴你變數是否正確展開，以及命令是否被正確解析。

使用 `set -e` 確保腳本在錯誤時立即停止

另一個極其重要的除錯與穩定性技巧是 set -e（errexit）。預設情況下，即使腳本中的某個命令失敗（回傳非零狀態碼），Shell 仍會繼續執行下一行指令。這在資料處理或系統配置腳本中是危險的，因為錯誤可能會被忽略並導致後續步驟基於錯誤狀態繼續運行。

加入 set -e 後，任何命令若回傳非零值，腳本將立即終止。為了讓除錯資訊更清晰，我們常將 set -e 與 set -u（未定義變數視為錯誤）搭配使用。

#!/bin/bash

# 啟用嚴格模式：遇到錯誤立即停止，且未定義變數視為錯誤
set -euo pipefail

# 模擬一個會失敗的命令
# 在 Ubuntu/Debian 上，假設 /nonexistent 目錄不存在
ls /nonexistent

# 這行程式碼永遠不會執行到
echo "如果上面失敗了，我不會顯示"

注意：在管道（pipe）中，set -o pipefail 確保只要管道中任何一個命令失敗，整個管道的回傳值即為失敗，這對於資料處理流程至關重要。

自訂錯誤訊息與狀態碼

除了依賴 Shell 內建機制，主動拋出錯誤能讓除錯更直觀。你可以使用 echo 將錯誤訊息寫入標準錯誤輸出（>&2），並搭配 exit 結束腳本。

#!/bin/bash

set -e

check_config() {
    local config_file="$1"

    if [[ ! -f "$config_file" ]]; then
        # 將錯誤訊息輸出到 stderr
        echo "錯誤：找不到設定檔 $config_file" >&2
        return 1
    fi
}

# 測試呼叫
check_config "/etc/nginx/nginx.conf"
echo "設定檔檢查通過"

常見問題

1. 除錯輸出干擾了正常輸出？ 當使用 set -x 時，除錯資訊會混在標準錯誤中。若你的腳本輸出需要被重導向或管道處理，建議將除錯輸出分離。例如，在開發階段保留 set -x，在生產環境中移除或改為記錄到日誌檔：exec 2>debug.log。

2. 為什麼 set -e 有時失效？ set -e 在某些條件判斷中不會觸發錯誤。例如 if command; then ... 或 command || true，這些結構明確預期命令可能失敗，因此 set -e 會在這些上下文中暫時失效。若需強制檢查，應使用 $? 變數或 && 鏈式呼叫。

小結

掌握 set -x、set -e 以及標準錯誤輸出處理，能讓你的 Shell 腳本更具健壯性與可維護性。建議在開發新腳本時，直接在開頭加入 set -euo pipefail，並在關鍵邏輯處使用 set -x 進行局部除錯。這不僅能減少 Bug，更能讓你在面對複雜自動化任務時得心應手。