我正在尝试搜索如何在 Bash 函数中传递参数，但出现的总是如何从 命令行 传递参数。
我想在我的脚本中传递参数。我试过了：
myBackupFunction("..", "...", "xx")
function myBackupFunction($directory, $options, $rootPassword) {
...
}
但是语法不正确。如何将参数传递给我的函数？
【问题讨论】：
标签： bash function parameters arguments
有两种典型的声明函数的方式。我更喜欢第二种方法。
function function_name {
command...
}
或
function_name () {
command...
}
使用参数调用函数：
function_name "$arg1" "$arg2"
函数通过位置（而不是名称）引用传递的参数，即$1、$2，等等。 $0 是脚本本身的名称。
例子：
function_name () {
echo "Parameter #1 is $1"
}
此外，您需要在声明函数之后调用它。
#!/usr/bin/env sh
foo 1 # this will fail because foo has not been declared yet.
foo() {
echo "Parameter #1 is $1"
}
foo 2 # this will work.
输出：
./myScript.sh: line 2: foo: command not found
Parameter #1 is 2
【讨论】：
function name() {}。在{} 之前可能有一个“输入”
function 关键字和()。我的目标（在文件中，而不是命令行中）是提高清晰度，而不是减少键入的字符数，即function myBackupFunction() compound-statement。
function 关键字版本是扩展；另一种形式适用于所有 POSIX 兼容的 shell。
function 关键字在引入它的旧 ksh 系列 shell 中也有保证，现代 bash 不支持（在这样的 shell 中） , function 使变量默认为本地；在 bash 中，它没有）。因此，对于任何了解并可能期望 ksh 行为的人来说，它的使用降低清晰度。见wiki.bash-hackers.org/scripting/obsolete
了解高级编程语言（C/C++、Java、PHP、Python、Perl 等）会向外行人建议 Bourne Again Shell (Bash) 函数应该像在其他语言中一样工作。
取而代之的是，Bash 函数的工作方式与 shell 命令类似，并期望将参数传递给它们，就像将选项传递给 shell 命令一样（例如 ls -l）。实际上，Bash 中的函数参数被视为位置参数（$1, $2..$9, ${10}, ${11}，等等）。考虑到getopts 的工作原理，这并不奇怪。不要使用括号来调用 Bash 中的函数。
（注意：我目前正在处理OpenSolaris。）
# Bash style declaration for all you PHP/JavaScript junkies. :-)
# $1 is the directory to archive
# $2 is the name of the tar and zipped file when all is done.
function backupWebRoot ()
{
tar -cvf - "$1" | zip -n .jpg:.gif:.png "$2" - 2>> $errorlog &&
echo -e "\nTarball created!\n"
}
# sh style declaration for the purist in you. ;-)
# $1 is the directory to archive
# $2 is the name of the tar and zipped file when all is done.
backupWebRoot ()
{
tar -cvf - "$1" | zip -n .jpg:.gif:.png "$2" - 2>> $errorlog &&
echo -e "\nTarball created!\n"
}
# In the actual shell script
# $0 $1 $2
backupWebRoot ~/public/www/ webSite.tar.zip
想要为变量使用名称？就这样做吧。
local filename=$1 # The keyword declare can be used, but local is semantically more specific.
不过要小心。如果函数的参数中有空格，您可能想要这样做！否则，$1 可能不是你想的那样。
local filename="$1" # Just to be on the safe side. Although, if $1 was an integer, then what? Is that even possible? Humm.
想要将数组按值传递给函数吗？
callingSomeFunction "${someArray[@]}" # Expands to all array elements.
在函数内部，像这样处理参数。
function callingSomeFunction ()
{
for value in "$@" # You want to use "$@" here, not "$*" !!!!!
do
:
done
}
需要传递一个值和一个数组，但在函数内部仍然使用“$@”？
function linearSearch ()
{
local myVar="$1"
shift 1 # Removes $1 from the parameter list
for value in "$@" # Represents the remaining parameters.
do
if [[ $value == $myVar ]]
then
echo -e "Found it!\t... after a while."
return 0
fi
done
return 1
}
linearSearch $someStringValue "${someArray[@]}"
在 Bash 4.3 及更高版本中，您可以通过使用 -n 选项定义函数的参数，通过引用将数组传递给函数。
function callingSomeFunction ()
{
local -n someArray=$1 # also ${1:?} to make the parameter mandatory.
for value in "${someArray[@]}" # Nice!
do
:
done
}
callingSomeFunction myArray # No $ in front of the argument. You pass by name, not expansion / value.
【讨论】：
如果您更喜欢命名参数，则可以（通过一些技巧）将命名参数实际传递给函数（也可以传递数组和引用）。
我开发的方法允许您定义传递给函数的命名参数，如下所示：
function example { args : string firstName , string lastName , integer age } {
echo "My name is ${firstName} ${lastName} and I am ${age} years old."
}
您还可以将参数注释为 @required 或 @readonly、创建 ...rest 参数、从顺序参数创建数组（使用例如 string[4]）并可选择在多行中列出参数：
function example {
args
: @required string firstName
: string lastName
: integer age
: string[] ...favoriteHobbies
echo "My name is ${firstName} ${lastName} and I am ${age} years old."
echo "My favorite hobbies include: ${favoriteHobbies[*]}"
}
换句话说，您不仅可以通过参数名称来调用参数（这构成了更易读的核心），您实际上还可以传递数组（以及对变量的引用——这个功能只在 Bash 4.3 中有效）！另外，映射的变量都在本地范围内，就像$1（和其他）一样。
使这项工作的代码非常简单，并且可以在 Bash 3 和 Bash 4 中工作（这是我测试过的唯一版本）。如果您对更多类似这样的技巧感兴趣，这些技巧可以让使用 bash 进行开发变得更好、更轻松，您可以查看我的 Bash Infinity Framework，下面的代码是它的功能之一。
shopt -s expand_aliases
function assignTrap {
local evalString
local -i paramIndex=${__paramIndex-0}
local initialCommand="${1-}"
if [[ "$initialCommand" != ":" ]]
then
echo "trap - DEBUG; eval \"${__previousTrap}\"; unset __previousTrap; unset __paramIndex;"
return
fi
while [[ "${1-}" == "," || "${1-}" == "${initialCommand}" ]] || [[ "${#@}" -gt 0 && "$paramIndex" -eq 0 ]]
do
shift # First colon ":" or next parameter's comma ","
paramIndex+=1
local -a decorators=()
while [[ "${1-}" == "@"* ]]
do
decorators+=( "$1" )
shift
done
local declaration=
local wrapLeft='"'
local wrapRight='"'
local nextType="$1"
local length=1
case ${nextType} in
string | boolean) declaration="local " ;;
integer) declaration="local -i" ;;
reference) declaration="local -n" ;;
arrayDeclaration) declaration="local -a"; wrapLeft= ; wrapRight= ;;
assocDeclaration) declaration="local -A"; wrapLeft= ; wrapRight= ;;
"string["*"]") declaration="local -a"; length="${nextType//[a-z\[\]]}" ;;
"integer["*"]") declaration="local -ai"; length="${nextType//[a-z\[\]]}" ;;
esac
if [[ "${declaration}" != "" ]]
then
shift
local nextName="$1"
for decorator in "${decorators[@]}"
do
case ${decorator} in
@readonly) declaration+="r" ;;
@required) evalString+="[[ ! -z \$${paramIndex} ]] || echo \"Parameter '$nextName' ($nextType) is marked as required by '${FUNCNAME[1]}' function.\"; " >&2 ;;
@global) declaration+="g" ;;
esac
done
local paramRange="$paramIndex"
if [[ -z "$length" ]]
then
# ...rest
paramRange="{@:$paramIndex}"
# trim leading ...
nextName="${nextName//\./}"
if [[ "${#@}" -gt 1 ]]
then
echo "Unexpected arguments after a rest array ($nextName) in '${FUNCNAME[1]}' function." >&2
fi
elif [[ "$length" -gt 1 ]]
then
paramRange="{@:$paramIndex:$length}"
paramIndex+=$((length - 1))
fi
evalString+="${declaration} ${nextName}=${wrapLeft}\$${paramRange}${wrapRight}; "
# Continue to the next parameter:
shift
fi
done
echo "${evalString} local -i __paramIndex=${paramIndex};"
}
alias args='local __previousTrap=$(trap -p DEBUG); trap "eval \"\$(assignTrap \$BASH_COMMAND)\";" DEBUG;'
【讨论】：
@var、@reference、@params 变量是什么？我应该在互联网上查找什么以了解更多信息？
ucommon 和我的代码之间没有关系。可能您安装了一些工具导致您提到的问题，不知道是什么。
local filename=$1 这样的东西对大多数人来说已经足够好了。此外，在 bash 中，可以选择使用声明 -A 来创建关联数组。您已经可以将数组作为列表传递！ callingSomeFunction "${someArray[@]}"
去掉括号和逗号：
myBackupFunction ".." "..." "xx"
函数应该是这样的：
function myBackupFunction() {
# Here $1 is the first parameter, $2 the second, etc.
}
【讨论】：
一个简单的例子，将在执行脚本期间或调用函数时清除脚本内部。
#!/bin/bash
echo "parameterized function example"
function print_param_value(){
value1="${1}" # $1 represent first argument
value2="${2}" # $2 represent second argument
echo "param 1 is ${value1}" # As string
echo "param 2 is ${value2}"
sum=$(($value1+$value2)) # Process them as number
echo "The sum of two value is ${sum}"
}
print_param_value "6" "4" # Space-separated value
# You can also pass parameters during executing the script
print_param_value "$1" "$2" # Parameter $1 and $2 during execution
# Suppose our script name is "param_example".
# Call it like this:
#
# ./param_example 5 5
#
# Now the parameters will be $1=5 and $2=5
【讨论】：
它从用户那里获取两个数字，将它们提供给名为 add 的函数（在代码的最后一行），add 会将它们汇总并打印出来。
#!/bin/bash
read -p "Enter the first value: " x
read -p "Enter the second value: " y
add(){
arg1=$1 # arg1 gets to be the first assigned argument (note there are no spaces)
arg2=$2 # arg2 gets to be the second assigned argument (note there are no spaces)
echo $(($arg1 + $arg2))
}
add x y # Feeding the arguments
【讨论】：
将命名参数传递给 Bash 的另一种方法是通过引用传递。从 Bash 4.0 开始支持此功能
#!/bin/bash
function myBackupFunction(){ # directory options destination filename
local directory="$1" options="$2" destination="$3" filename="$4";
echo "tar cz ${!options} ${!directory} | ssh root@backupserver \"cat > /mnt/${!destination}/${!filename}.tgz\"";
}
declare -A backup=([directory]=".." [options]="..." [destination]="backups" [filename]="backup" );
myBackupFunction backup[directory] backup[options] backup[destination] backup[filename];
Bash 4.3 的另一种语法是使用nameref。
虽然 nameref 更加方便，因为它可以无缝取消引用，但一些较旧的受支持发行版仍然提供 older version，所以我暂时不推荐它。
【讨论】：