Shell 腳本中的函數最佳實踐
在 Shell 腳本開發中，隨著腳本規模的擴大，將重複或邏輯獨立的代碼片段封裝成「函數」（Function）是提升可讀性與維護性的關鍵。然而，許多初學者往往只將函數視為「避免重複寫程式碼」的工具，卻忽略了 Shell 函數在變數作用域、錯誤處理以及效能上的特殊行為。本文將探討在 Ubuntu 22.04 / Debian 12 環境下，撰寫高效能且健壯的 Shell 函數最佳實踐。
1. 明確的命名與參數傳遞
Shell 函數的命名應具備描述性，避免使用單一字母或模糊的名稱。在呼叫函數時，Shell 使用位置參數（$1, $2 等）來傳遞參數。為了提高代碼的可讀性與安全性，建議在函數內部使用 local 關鍵字宣告變數，以防止意外覆蓋全局變數。
以下是一個展示正確參數傳遞與局部變數使用的範例：
#!/bin/bash
# 定義函數：建立指定大小的測試檔案
create_test_file() {
# 使用 local 限制變數範圍，避免污染全局環境
local filename="$1"
local size_mb="${2:-10}" # 若第二個參數未提供，預設為 10 MB
# 檢查參數是否為空
if [[ -z "$filename" ]]; then
echo "錯誤：請提供檔案名稱" >&2
return 1
fi
# 使用 dd 命令建立檔案，-f 確保覆蓋現有檔案
dd if=/dev/zero of="$filename" bs=1M count="$size_mb" status=progress
echo "成功建立檔案：$filename ($size_mb MB)"
}
# 呼叫範例
create_test_file "test_data.bin" 52. 正確的錯誤處理與退出碼
在 Shell 腳本中，函數的執行結果通常透過「退出碼」（Exit Code）來傳遞。 convention 規定 0 代表成功，非 0 代表失敗。若函數內部發生錯誤，應明確使用 return 或 exit 並帶回錯誤碼。
值得注意的是，set -e（errexit）選項會導致腳本在遇到錯誤時立即終止。在函數內部使用 set -e 需格外小心，因為它可能導致非預期的行為。建議在函數內部手動檢查命令的退出狀態，或使用 set +e 暫時關閉該選項。
#!/bin/bash
# 檢查目錄是否存在並可寫入
check_directory() {
local dir_path="$1"
# 使用 || 進行錯誤處理
if ! [[ -d "$dir_path" ]]; then
echo "錯誤：目錄不存在：$dir_path" >&2
return 1
fi
if ! [[ -w "$dir_path" ]]; then
echo "錯誤：目錄不可寫入：$dir_path" >&2
return 2
fi
return 0
}
# 主程式邏輯
target_dir="/tmp/test_dir"
mkdir -p "$target_dir"
if check_directory "$target_dir"; then
echo "目錄檢查通過，繼續執行..."
else
echo "目錄檢查失敗，中止程式" >&2
exit 1
fi3. 避免子殼層（Subshell）效能陷阱
這是一個常被忽視的效能問題。在 Shell 中，使用 $(command) 或 (command) 會建立一個子殼層（Subshell）。如果在迴圈中頻繁呼叫外部命令或進行大量 I/O 操作，會造成顯著的效能損耗。
最佳實踐是盡量使用內建命令（Built-in Commands）或將輸出暫存於變數中，避免在迴圈內重複執行昂貴的操作。
#!/bin/bash
# 錯誤範例：在迴圈中頻繁呼叫外部命令，效能極差
echo "效能較差的寫法："
for i in {1..100}; do
# 每次迴圈都產生子殼層，效率低落
count=$(ls /usr/bin | wc -l)
done
echo "完成"
# 正確範例：將外部命令移出迴圈
echo "效能較佳的寫法："
# 先取得結果，再在迴圈中使用變數
file_count=$(ls /usr/bin | wc -l)
for i in {1..100}; do
# 僅操作記憶體中的變數，速度極快
echo "第 $i 次檢查，檔案數：$file_count"
done
echo "完成"常見問題與解決方案
Q1: 為什麼我在函數中修改變數，主程式中的變數值沒有改變？
這是因為 Shell 函數預設是在當前殼層中執行，但若使用了 export 或在子殼層中操作，行為會有所不同。然而，最常見的問題是「變數作用域」。如果未在函數內使用 local，變數會成為全局變數，容易產生衝突。反之，若函數是在子殼層（如 $(func)）中被呼叫，其內部變數更改不會反映到父殼層。
解決方案： 對於需要回傳多個值的場景，建議使用全局變數（需謹慎管理）或將結果輸出到 stdout，由呼叫端透過命令替換接收。
Q2: 如何讓函數支援可選參數？
Shell 本身不支援預設參數語法（如 Python 的 def func(a, b=10)）。
解決方案： 使用 ${parameter:-default} 語法。若 $parameter 為空或未設定，則使用 default 值。例如：local verbose="${2:-false}"。這是最標準且兼容 POSIX shell 的做法。
小結
撰寫高品質的 Shell 腳本函數，核心在於「隔離性」與「明確性」。透過使用 local 變數確保作用域隔離，明確檢查退出碼以處理錯誤，並避免不必要的子殼層開銷，我們可以編寫出既高效又易於維護的腳本。在 Ubuntu 或 Debian 系統上進行系統管理或自動化部署時，這些最佳實踐將顯著提升腳本的穩定性與執行效率。建議在實際開發中，始終遵循 set -euo pipefail 的嚴格模式，並配合上述函數設計原則，以達到專業級別的腳本品質。