萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 伺服器教學

Linux Shell 腳本進階教學(七):內建除錯與自訂除錯模式實戰

除錯是腳本開發不可或缺的環節。Bash 提供內建 set -x 追蹤模式,亦可透過環境變數 _DEBUG 實作自訂格式、條件式除錯。本文示範區塊級追蹤、整腳本追蹤、自訂 DEBUG() 函式三種層級的除錯技巧。

一、Bash 內建除錯

1. 區塊級追蹤 set -x / set +x

#!/bin/bash
for i in {1..6}; do
  set -x          # 開啟追蹤
  echo $i         # 要除錯的語句
  set +x          # 關閉追蹤
done
echo "Script executed."

輸出範例:

+ echo 1
1
+ echo 2
2
...

優點:精確鎖定區塊、不汙染其他輸出。缺點:格式固定(+ 開頭)、無法自訂訊息。

2. 整腳本追蹤 bash -x script.sh

bash -x script.sh
# 等價於 sh -x script.sh

適用於快速檢視完整執行流程,但輸出龐大難閱讀。

二、自訂除錯函式 DEBUG()

核心邏輯

function DEBUG() {
  [ "$_DEBUG" == "on" ] && "$@" || :
}
# : 為空命令,永遠回傳 0,不執行任何操作

使用方式

for i in {1..3}; do
  DEBUG echo "Processing item $i"
  DEBUG sleep 1
done

啟用除錯模式執行

_DEBUG=on bash script.sh
# 或
export _DEBUG=on
bash script.sh

輸出效果

Processing item 1
Processing item 2
Processing item 3
# 未啟用 _DEBUG 時:無任何輸出

三、進階自訂除錯模板

DEBUG() {
  [ "$_DEBUG" == "on" ] || return 0
  local ts=$(date '+%H:%M:%S')
  local caller=${FUNCNAME[1]:-main}
  echo "[$ts] [DEBUG] [$caller] $*" >&2
  "$@"
}

# 使用
DEBUG cp src dest
DEBUG mysqldump -u root db > backup.sql

特點:

  • 時間戳、呼叫函式名、引數原樣輸出至 stderr(>&2)。
  • 執行實際命令("$@"),不僅印訊息。
  • 可擴充 _DEBUG_LEVEL 分級(info/debug/trace)。

四、除錯最佳實踐

場景推薦方式
快速檢視變數值、流程分支set -x 區塊包裹
完整執行流程記錄bash -x script.sh 2>&1 | tee debug.log
生產環境可切換的詳細日誌_DEBUG=on + 自訂 DEBUG()
效能分析(耗時統計)自訂 DEBUG() 加入 date +%s.%N

五、注意事項

  • set -x 會展開變數、命令替換,敏感資訊(密碼、Token)會明文顯示,生產環境慎用。
  • 自訂除錯函式建議命名為 dbg 或 debug,避免與系統命令衝突。
  • 結合 set -euo pipefail 嚴格模式,盡早暴露潛在錯誤。

靈活運用內建與自訂除錯,讓腳本從「能跑」進化到「可觀測、可維護、可信任」。

copyright © 萬盛學電腦網 all rights reserved