HOWTO · Bash
在 Bash 函式中傳遞引數
本教程演示如何在 bash 函式中傳遞引數
本頁內容
呼叫 Bash 函式時,函式名稱後面提供的各個字詞會成為函式本體中的位置參數。本指南說明如何傳入一個值、對應多個值、在省略第一個引數時選用預設值,以及在保留各引數邊界的情況下處理所有引數。Bash 引數是 shell 字詞,可以是文字、數字、路徑或其他值;Bash 不會為它們指定不同的資料型別。
Bash 函式參數的運作方式
函式會以可重複使用的名稱將一組命令組合在一起。定義函式時,先寫名稱、括號和命令本體;呼叫時則寫函式名稱及任何引數。函式沒有自己的命令列選項;呼叫端提供引數,函式則透過位置參數讀取這些引數。在函式中,$1 代表第一個引數,$2 代表第二個引數,後續依序為 $3、$4 等。這些值屬於目前函式呼叫的位置參數環境。
例如,行內寫法 show() { printf '%s\n' "$1"; } 可定義函式,而 show "hello" 則以一個引數呼叫它。以下各節會使用完整的 Bash 程式碼片段。
將單一引數傳給 Bash 函式
在函式名稱後面放入要傳遞的值。若字串包含空格,請加上引號,讓 shell 將它作為單一引數傳入。在函式內,$1 會取得完整字串。在呼叫處加上引號,才能讓它保留為一個 shell 字詞;如果沒有引號,含空格的字串會在函式執行前拆成多個引數。
執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
#!/usr/bin/env bash
greet() {
printf 'Hello, %s!\n' "$1"
}
greet "Ada Lovelace"
Hello, Ada Lovelace!
格式字串是固定的,而使用 "$1" 時會保留引數的完整內容。這種寫法適用於單一名稱、路徑或其他值。
將多個引數傳給 Bash 函式
呼叫函式時以空格分隔各個引數;若其中某個值含有空格,請為該值加上引號。第一個引數會對應到 $1,第二個對應到 $2,後續引數也依此編號。將參數傳給另一個函式時,請為展開結果加上引號,例如 another_function "$1",以確保內容仍作為單一引數傳遞。
執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
#!/usr/bin/env bash
describe_pair() {
printf 'first=<%s>; second=<%s>\n' "$1" "$2"
}
describe_pair "red apple" blue
first=<red apple>; second=<blue>
此處第一個參數是由兩個字詞組成的文字 red apple,但仍算一個引數;blue 則是第二個引數。進行算術運算前,請先確認輸入是數字;位置參數本身可以包含任意文字。
為函式引數設定預設值
參數展開可以在省略第一個引數時選用備用值。在 ${1:-Guest} 中,若 $1 未設定或為空,便會使用 Guest。如果明確傳入空字串時也應視為已提供值,請改用 ${1-Guest};這種寫法只會在 $1 未設定時使用備用值。請依照空值在函式中的意義選擇寫法。
執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
#!/usr/bin/env bash
greet() {
local name=${1:-Guest}
printf 'Hello, %s!\n' "$name"
}
greet "Mina"
greet
Hello, Mina!
Hello, Guest!
第一次呼叫使用提供的名稱;第二次沒有第一個引數,因此使用備用值。將選定的值指定給區域變數,能讓這項選擇更清楚,也可避免更動函式外名稱相同的變數。
存取傳給函式的所有引數
若要轉傳或逐一處理所有引數,同時保留各自的邊界,請使用 "$@"。在有引號的情境中,"$@" 會將每個原始引數展開成一個 shell 字詞。相較之下,未加引號的 $@ 可能會經過字詞分割和檔名展開;"$*" 則會使用 IFS 的第一個字元,將所有引數合併成一個字詞。
執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
#!/usr/bin/env bash
print_arguments() {
local argument
for argument in "$@"; do
printf '<%s>\n' "$argument"
done
}
print_arguments "red apple" blue "green pear"
<red apple>
<blue>
<green pear>
迴圈會分別處理每個傳入的引數,包括含有空格的值。將所有引數轉傳給另一個命令或函式時,也適用相同的引號規則:寫成 next_step "$@"。這樣會保留呼叫端原先的引數切分方式,讓下一個操作能逐一處理各個值。