06 shell函数

6.1  函数
函数几乎是学习所有的程序设计语言时都必须过的一关。对于学习过其他的程序语言的用户来说，函数可能并不陌生。但是Shell中的函数与其他的程序设计语言的函数有许多不同之处。为了使用户了解Shell中的函数，本节将介绍函数的相关基础知识。
6.1.1  什么是函数
通俗地将，所谓函数就是将一组功能相对独立的代码集中起来，形成一个代码块，这个代码可以完成某个具体的功能。从上面的定义可以看出，Shell中的函数的概念与其他的语言的函数的概念并没有太大的区别。从本质上讲，函数是一个函数名到某个代码块的映射。也就是说，用户在定义了函数之后，就可以通过函数名来调用其所对应的一组代码。
6.1.2  函数的定义方法
在Shell语言中，用户可以通过2种语法来定义函数，分别如下：
function_name ()
{
   statement1
   statement2
   ...
   statementn

}
或者
function function_name ()
{
   statement1
   statement2
   ...
   statementn

}

#! /bin/bash

#定义函数
function sayhello()
{
   echo "Hello, World!"

}
#调用函数
sayhello

6.1.3  函数的调用
在Shell中，函数调用的基本语法如下：
function_name param1 param2 …
在上面的语法中，function_name表示函数名称，其后面跟的param1、param2…表示函数的参数。

#! /bin/bash

#定义函数
getCurrentTime()
{
   current_time=`date`
   echo "$current_time"

}

#调用函数
getCurrentTime

6.1.4  函数链接
所谓函数链接，是指在某个Shell函数中调用另外一个函数的过程。与其他的程序设计语言一样，Shell允许用户函数的嵌套调用。

#! /bin/bash

#定义函数john()
john()
{
   echo "Hello, this is John."

}
#定义函数alice
alice()
{
   #调用函数john
   john
   echo "Hello, this is Alice."

}
#调用函数alice
alice

#! /bin/bash
#定义函数john()
john()
{
   echo "Hello, this is John."

}
#定义函数alice()
alice()
{
   echo "Hello, this is Alice."

}
#定义函数sayhello()
sayhello()
{
   john
   alice

}
#调用函数sayhello()
sayhello

6.1.5  函数的返回值
首先，用户可以使用return语句来返回某个数值，这与绝大部分的程序设计语言是相同的。但是，在Shell中，return语句只能返回某个0~255之间的整数值。

#! /bin/bash

#定义求和函数
sum()
{
   let "z = $1 + $2"
   #将和作为退出状态码返回
   return "$z"

}
#调用求和函数
sum 22 4
#输出和
echo "$?"

在Shell中，还有一种更加优雅的方法可以帮助用户获得函数执行后的某个结果，那就是使用echo语句。
在函数中，用户将需要返回的数据写入到标准输出（stdout），通常这个操作是使用echo语句来完成的。然后在调用程序中将函数的执行结果赋给一个变量。这种做法实际上就是命令替换的一个变种。

#! /bin/bash

#定义函数
length()
{
   #接收参数
   str=$1
   result=0
   if [ "$str" != ""  ]; then
      #计算字符串长度
      result=${#str}
   fi
   #将长度值写入标准输出
   echo "$result"

}
#调用函数
len=$(length "abc123")
#输出执行结果
echo "the string's length is $len"

6.1.6  函数和别名
一个别名是一个Shell命令的缩写或者其他容易记忆的名称。用户可以使用alias命令来设置别名，其基本语法如下：
alias name="command"
其中，name是要指定的别名，command则是原有的Shell命令，也就是真正要执行的命令。
[root@linux chapter6]# alias ls="ls -l"

当用户不再需要某个别名时，可以使用unalias命令将其删除，如下：
[root@linux chapter6]# unalias ls

6.1.7  再议全局变量和局部变量
默认情况下，除了与函数参数关联的特殊变量之外，其他所有的变量都有全局的有效范围。另外，在函数内部，如果没有使用local关键字进行修饰，那么函数中的变量也是全局变量。

演示如何通过echo语句来传递函数返回值
#! /bin/bash

#在函数外定义全局变量
var="Hello world"
func()
{
    #在函数内改变变量的值
    var="Orange Apple Banana"
    echo "$var"
    #在函数内定义全局变量
    var2="Hello John"
}
#输出变量值
echo "$var"
#调用函数
func
#重新输出变量的值
echo "$var"
#输出函数内定义的变量的值
echo "$var2"

#! /bin/bash

#全局变量
var="Hello world"
func()
{
   #局部变量
   local var="Orange Apple Banana"
   echo "$var"
   #局部变量
   local var2="Hello John"

}
echo "$var"
func
echo "$var"
echo "$var2"

6.2  函数参数
对于函数来说，参数非常重要。通过参数，用户可以将想要函数处理的数据传递给函数。Shell语言中，同样支持含有参数的函数。本节将介绍函数参数的使用方法。

6.2.1  含有参数的函数的调用方法
Shell的函数参数的语法比较特殊。实际上，Shell将脚本参数和函数参数做了统一地处理。也就是说，Shell采用了相同的方法来处理脚本的参数和函数参数。因此，对于含有参数的函数，用户可以使用以下语法来调用。
function_name arg1 arg2 ...
其中，function_name表示函数名称，arg1、arg2以及arg3等则表示函数参数，这些参数之间通过空格隔开。用户可以发现，实际上这种语法与执行Shell脚本的语法完全相同。

6.2.2  获取函数参数的个数
在Shell中，不仅含有参数的函数的调用方法和执行脚本的语法相同，而且，在函数内部，用户也是通过位置变量来接受参数的值。这一点，与Shell脚本也是完全相同的。前面已经介绍过，用户可以通过系统变量$#来获取脚本的参数的个数。

#! /bin/bash

#定义函数
func()
{
   #输出参数个数
   echo "the function has $# parameters."
}
#调用函数
func a b c d e f g hello
func 12 3 "hello world"
func

6.2.3  通过位置变量接收参数值
与Shell脚本一样，用户可以在Shell函数中使用位置变量来获取参数值。例如，$0表示脚本名称，$1表示第1个参数，$2表示第2个参数等，以此类推。另外，用户还可以通过系统变量$@和$*获取所有参数的值

#! /bin/bash

#定义函数
func()
{
   #输出所有的参数
   echo "all parameters are $*"
   #输出所有的参数
   echo "all parameters are $@"
   #输出脚本名称
   echo "the script's name is $0"
   #输出第1个参数
   echo "the first parameter is $1"
   #输出第2个参数
   echo "the second paramter is $2"
}
#调用函数
func hello world

6.2.4  移动位置参数
在Shell脚本中，用户可以使用shift命令来使得脚本的所有的位置参数向左移动一个位置，从而使得用户可以通过9以内的位置变量来获取超过9个的参数。在函数中，这种方法仍然适用。

#! /bin/bash

#定义函数
func()
{
   #通过while循环和shift命令依次获取参数值
   while (($# > 0))
   do
      echo "$1"
      shift
   done
}

6.2.5  通过getopts接收函数参数
getopts是bash内置的一个命令，通过该命令，用户可以获取函数的选项以及参数值，或者是脚本的命令行选项以及参数值。getopts命令的基本语法如下：
getopts optstring [args]
在上面的语法中，参数optstring包含一个可以为getopts命令识别的选项名称列表。如果某个选项名称的后面跟随着一个冒号，则表示用户可以为该选项提供参数值。同时，参数值将被保存到一个名称为$OPTARG的系统变量中。getopts命令会依次遍历每个选项，选项名称将被保存到args变量中。

#! /bin/bash

#定义函数
func()
{
   #逐个接收选项及其参数
   while getopts "a:b:c" arg
   do
      #当指定了-a选项时
      case "$arg" in
         a)
            #输出-a选项的参数值
            echo "a's argument is $OPTARG"
            ;;
         b)
            echo "b's argument is $OPTARG."
            ;;
         c)
            echo "c"
            ;;
         ?)
            #未知选项
            echo "unkown argument."
            exit 1
            ;;
      esac
   done
}
#调用函数
func -a hello -b world

6.2.6  间接参数传递
在Shell中，函数还支持间接参数传递。所谓间接参数传递，是指通过间接变量引用来实现函数参数的传递。而间接变量是指某个变量的值又是另外一个变量的变量名的变量。
例如，在某个脚本中，存在以下2个变量：
var=name
name=John
可以发现，在上面的代码中，变量var的值恰好是后面一个变量的变量名。此时，对于第2个变量，用户可以通过以下2种方式来引用：
${name}
${!var}

#! /bin/bash

#定义函数
func()
{
   echo "$1"
}

#定义变量
var=name
name=John
#调用函数
func "$var"
func ${!var}
#修改变量的值
name=Alice
#再次调用函数
func "$var"
func ${!var}

6.2.7  通过全局变量传递数据
用户除了可以使用参数传递数据之外，还可以通过全局变量来传递。前面已经介绍过，全局变量的作用域是整个程序，包括函数内部。尽管这种方式是有效的，但是在许多程序设计语言中，这种做法却饱受诟病，其原因在于会导致程序结构非常不清晰，代码的可读性较差。

#! /bin/bash

#定义全局变量
file="/bin/ls"
#定义函数
func()
{
   if [ -e "$file"  ]
   then
      echo "the file exists."
   else
      echo "the file does not exist."
   fi
}
#调用函数
func
#修改全局变量的值
file="/bin/a"
#调用函数
func

6.2.8  传递数组参数
严格地讲，Shell并不支持将数组作为参数传递给函数，但是用户仍然可以通过一些变通的方法实现数组参数的传递。
首先，用户可以将数组的元素展开，然后作为多个由空格隔开的多个参数传递给函数。下面举例说明这种传递参数的方法。

#! /bin/bash

#定义函数
func()
{
   echo "number of elements is $#."
   while [ $# -gt 0  ]
   do
        echo "$1"
        shift
    done

}
#定义数组
a=(a b "c d" e)
#调用函数
func "${a[@]}"

6.3  函数库文件
为了方便地重用这些功能，可以创建一些可重用的函数。这些函数可以单独地放在函数库文件中。本节将介绍如何在Shell程序中创建和调用函数库文件。

6.3.1  函数库文件的定义
创建一个函数库文件的过程非常类似于编写一个Shell脚本。
脚本与库文件之间的唯一区别在于函数库文件通常只包括函数，而脚本中则可以既包括函数和变量的定义，又包括可执行的代码。
此处所说的可执行代码，是指位于函数外部的代码，当脚本被载入后，这些代码会立即被执行，毋需另外调用。

#! /bin/bash

#定义函数
error()
{
   echo "ERROR:" $@ 1>&2
}
warning()
{
   echo "WARNING:" $@ 1>&2
}

6.3.2  函数库文件的调用
当库文件定义好之后，用户就可以在程序中载入库文件，并且调用其中的函数。在Shell中，载入库文件的命令为.，即一个圆点，其语法如下：
. filename
其中，参数filename表示库文件的名称，必须是一个合法的文件名。库文件可以使用相对路径，也可以使用绝对路径。另外，圆点命令和库文件名之间有一个空格。

#! /bin/bash

#载入函数库
. ex6-22.sh

#定义变量
msg="the file is not found."
#调用函数库中的函数
error $msg

6.4  递归函数
Linux的Shell也支持函数的递归调用。也就是说，函数可以直接或者间接地调用自身。在函数的递归调用中，函数既是调用者，又是被调用者。作为一个Shell函数介绍的补充内容，本节将介绍如何在Shell中实现递归函数。
递归函数的调用过程就是反复地调用其自身，每调用一次就进入新的一层

#! /bin/bash

#定义递归函数
func()
{
   read y
   #递归调用
   func "$y"
   echo "$y"
}  
#调用函数
func

#! /bin/bash

#定义递归函数
fact()
{
   #定义局部变量
   local n="$1"
   #当n等于0时终止递归调用
   if [ "$n" -eq 0  ]
   then
      result=1
   else
      #当n大于0时，递归计算n-1的阶乘
      let "m=n-1"
      fact "$m"
      let "result=$n * $?"
   fi
   #将计算结果以退出状态码的形式返回
   return $result
}

#调用递归函数
fact "$1"

echo "Factorial of $1 is $?"