Bash 中的 getopts 參數解析

在撰寫 Bash 腳本時，如何優雅且可靠地處理使用者輸入的選項（Options）與引數（Arguments），是決定腳本專業度的關鍵。雖然我們可以直接透過 $1, $2 等位置變數來獲取輸入，但當選項增多、順序混亂或需要處理複雜的旗標組合時，手動解析不僅容易出錯，程式碼也會變得難以維護。

這時，Bash 內建的 getopts 指令便派上用場了。它專門用於解析短格式選項（如 -v, -f），能大幅簡化參數處理邏輯。本文將帶領讀者深入理解 getopts 的工作原理，並提供一個實用的範例腳本。

getopts 的核心機制

getopts 的工作流程可以簡單歸納為「定義選項字串」與「迴圈解析」兩個步驟。

首先，我們需要定義一個選項字串（Option String）。這個字串由代表選項的字母組成。如果某個選項需要接受引數（例如 -f filename），則在該字母後加上冒號 :。例如，字串 "vf:" 表示 -v 是一個旗標（無需引數），而 -f 需要一個引數。

接著，我們使用 while 迴圈搭配 getopts 進行解析。每次呼叫 getopts 時，它會將目前解析到的選項字母存入變數 OPTARG（若該選項需要引數），並將選項字母存入 OPTIND（目前選項索引）或透過 getopts 的第二個參數指定變數名（通常命名為 opt）。當所有選項解析完畢，getopts 會回傳非零值，結束迴圈。

值得注意的是，getopts 不會自動處理 --（雙橫線），這通常用於分隔選項與非選項引數。此外，若使用者輸入了未定義的選項，getopts 會將 OPT 設為 ?，此時我們需要額外處理錯誤訊息。

實戰範例：建立一個檔案壓縮工具

讓我們透過一個具體的範例來展示 getopts 的應用。假設我們要撰寫一個腳本 backup.sh，用於壓縮目錄。它支援以下選項：

-d <dir>：指定要壓縮的目錄路徑（必填）。
-o <file>：指定輸出檔案名稱（預設為 backup.tar.gz）。
-v：啟用詳細模式（Verbose），在執行時顯示進度。
-h：顯示幫助資訊。

以下是完整的腳本程式碼：

#!/bin/bash

# 預設值
TARGET_DIR=""
OUTPUT_FILE="backup.tar.gz"
VERBOSE=0

# 顯示幫助函數
usage() {
    echo "用法: $0 [選項]"
    echo "選項:"
    echo "  -d <dir>   指定要壓縮的目錄路徑 (必填)"
    echo "  -o <file>  指定輸出檔案名稱 (預設: backup.tar.gz)"
    echo "  -v         啟用詳細模式"
    echo "  -h         顯示此幫助資訊"
    exit 1
}

# 錯誤處理函數
error_msg() {
    echo "錯誤: $1" >&2
    exit 1
}

# 解析選項
while getopts "d:o:vh" opt; do
    case $opt in
        d)
            TARGET_DIR="$OPTARG"
            ;;
        o)
            OUTPUT_FILE="$OPTARG"
            ;;
        v)
            VERBOSE=1
            ;;
        h)
            usage
            ;;
        \?)
            error_msg "無效的選項: -$OPTARG"
            ;;
        :)
            error_msg "選項 -$OPTARG 需要引數"
            ;;
    esac
done

# 移除已解析的選項，剩下的為非選項引數
shift $((OPTIND - 1))

# 基本驗證
if [[ -z "$TARGET_DIR" ]]; then
    error_msg "必須指定目錄路徑 (-d)"
fi

if [[ ! -d "$TARGET_DIR" ]]; then
    error_msg "目錄不存在: $TARGET_DIR"
fi

# 執行壓縮動作
if [[ $VERBOSE -eq 1 ]]; then
    echo "正在壓縮目錄: $TARGET_DIR"
    echo "輸出檔案: $OUTPUT_FILE"
    tar -czvf "$OUTPUT_FILE" "$TARGET_DIR"
else
    tar -czf "$OUTPUT_FILE" "$TARGET_DIR"
    echo "壓縮完成: $OUTPUT_FILE"
fi

如何使用

將上述程式碼儲存為 backup.sh。
賦予執行權限：chmod +x backup.sh。

執行測試：

./backup.sh -d /etc -o etc_backup.tar.gz -v

在這個範例中，我們特別處理了 : 和 \? 的情況。當選項缺少引數時（例如只輸入 -o 而沒給檔案名），getopts 會將 OPT 設為 :，我們藉此彈出明確的錯誤訊息。

常見問題與注意事項

1. getopts 無法解析長選項（Long Options）

這是 getopts 最明顯的限制。它只能處理短格式選項（如 -f），無法直接解析 --file 這類長選項。若腳本需要支援長選項，建議改用 getopt（注意少了一個 's'）外掛指令，或手動處理 case 中的 -- 開頭變數。對於大多數系統管理腳本，短選項已足夠使用且更為簡潔。

2. OPTIND 的初始值與重置

OPTIND 變數記錄了下一個要處理的參數索引。在腳本開頭，OPTIND 通常為 1。若在腳本中多次呼叫 getopts 或需要重新解析參數，必須手動將 OPTIND 重置為 1，否則 getopts 會從上一次結束的位置繼續，導致邏輯錯誤。此外，shift $((OPTIND - 1)) 這行指令非常重要，它能移除已解析的選項，讓後續程式碼能專注於處理剩餘的非選項引數（如檔案名稱列表）。

小結

getopts 是 Bash 腳本中處理短選項的標準工具。雖然它功能相對單純，不支援長選項，但其內建於 Shell 的特性使其執行效率高且無需額外依賴。透過熟練掌握選項字串的定義、case 分支的對應以及錯誤訊息的處理，我們可以撰寫出既專業又易於維護的 Shell 腳本。對於更複雜的參數解析需求，則可考慮結合 getopt 指令或外部工具如 argbash。