本系列文章介绍在 Linux Bash shell 中使用函数的一些实例,包括下面的内容:
- 定义函数的格式
- 从函数中返回内容
- 使用函数名作为函数指针
- 函数内执行cd命令的影响
- 声明函数内的变量为局部变量
- 获取传入函数的所有参数
声明函数内的变量为局部变量
在 bash 中,没有使用 local 命令来声明的变量都是全局变量,在函数内部定义的变量也是全局变量。如果没有注意到这一点,在函数内操作变量可能会影响到的外部同名变量,造成不预期的结果。
为了避免对外部同名变量造成影响,函数内的变量最好声明为局部变量,使用 local 命令来声明。查看 man bash 里面对 local 命令的说明如下:
local [option] [name[=value] ...]
For each argument, a local variable named name is created, and assigned value. The option can be any of the options accepted by declare.
When local is used within a function, it causes the variable name to have a visible scope restricted to that function and its children. With no operands, local writes a list of local variables to the standard output.
It is an error to use local when not within a function.
The return status is 0 unless local is used outside a function, an invalid name is supplied, or name is a readonly variable.
即,在函数内,使用 local 命令声明的变量是局部变量,这些变量在函数外不可见。在函数外,不能使用 local 命令声明变量,否则会报错。
注意:如上面说明,local 命令本身会返回一个值,正常的返回值是 0。假设有个 testlocal.sh 脚本,内容如下:
#!/bin/bashfoo() { return 1; }bar() { ret=$(foo); echo first: $? local var=$(foo); echo second: $?}foobar() { return 0; }barlocal out=$(foobar); echo third: $?
则执行 ./testlocal.sh 脚本,会输出:
first: 1second: 0./testlocal.sh: 第 x 行:local: 只能在函数中使用third: 1
可以看到,ret=$(foo); 语句没有使用 local 命令来定义 ret 变量,执行 foo 函数,该函数的返回值是 1,所以得到的 $? 是 1。
而 local var=$(foo); 语句使用 local 命令来定义 var 变量,执行 foo 函数,得到的 $? 却是 0,而foo 函数明明返回的是 1。原因就是该语句先通过 $(foo) 执行 foo 函数,然后用 local var 来定义 var 变量为局部变量,所以该语句对应的 $? 是 local 命令的返回值,而不是 foo 函数的返回值。
当在函数外执行 local 命令时,它会报错,可以看到虽然 foobar 函数返回是 0,但是第三个 echo 语句打印的 $?是 1,正好是 local 命令执行出错时的返回值。
即,对于 local var=$(func); 这种语句来说,它对应的 $? 不是所调用函数的返回值,而是local 命令的返回值。所以执行函数后,想用 $? 来判断函数的 return 返回值时,注意不要用这种写法。
为了避免这种情况,最好在函数开头就用 local 命令声明所有局部变量。
使用 local 声明多个变量时,变量之间用空格隔开,不要加逗号。举例如下:
local a b c;
总的来说,在函数内使用 local 命令来声明局部变量是一个好的编程习惯,避免变量同名造成的干扰。
PS:未完待续,下篇文章会继续说明,敬请期待~