Shell编程之函数

在Shell编程中，函数是一种组织代码块的方式，它可以让我们在脚本中重复使用代码，提高脚本的可读性和可维护性。本文将介绍如何在Shell脚本中定义和使用函数。

一、Shell函数

函数的用法

• 将命令序列按格式写在一起
• 可以便重复使用命令序列
• Shell函数定义

[ function ] 函数名(){
    命令序列
    [return x]    # 使用retrun或exit可以显式地结束函数
}

• “function”关键字表示定义一个函数，可以省略；
• “{”符号表示函数执行命令的入口，该符号可以与函数名同行也可以在函数名下一行 的句首；
• “}”符号表示函数体结束，两个大括号之间{ }是函数体；
• “命令序列”部分可以是任意的 Shell 命令，也可以调用其他函数；
• “return”表示退出函数返回一个退出值，通过返回值判断执行是否成功，也可以使用 exit 终止整个 Shell 脚本。

调用函数的方法

函数名 [参数1] [参数2]

调用函数的两种方式

[root@bogon ~]# cat test.sh 
#!/bin/bash

function hello(){
    echo "Hello KGC"
}

hi(){
    echo "Hi KGC"
}

hello
hi

两个数求和

[root@bogon ~]# cat test.sh 
#!/bin/bash 

sum(){
    read -p "请输入第一个数：" NUM1 
    read -p "请输入第二个数：" NUM2
    echo "你输入的两个数为：$NUM1 和$NUM2." 
    SUM=$(( NUM1+$NUM2))
    echo "两个数的和为： $SUM"
}
sum

函数变量的作用范围

• 在编写脚本时，有时需要将变量的值限定在函数内部，可以通过内置命令 local 来实现。
• 函数内部变量的使用，可以避免函数内外同时出现同名变量对脚本结果的影响。
• local 命令的使用如下所示。

[root@localhost ~]# vi test.sh
myfun (){
    local i 
    i=8 
    echo $i
}
i=9 
myfun 
echo $i
[root@localhost ~]# . test.sh
8
9

函数的参数
参数的用法

函数名称 参数 1 参数 2 参数 3 ......

• 在使用函数参数时，函数名称在前参数在后，函数名和参数之间用空格分隔，可以有多个参数，参数使用$1、$2、$3……的方式表示
• 以此类推，从第 10 个参数开始，调用方法为${10}，不加大括号无法调用成功
• 示例

[root@bogon ~]# cat write_log.sh 
#!/bin/bash 
mydir="/data" 
outfile="${mydir}/my.log"
[ -e "${mydir}" ] || mkdir -p ${mydir} 
appendfile(){
    echo "$2" >> "$1"
}
appendfile ${outfile} "first line content." 
appendfile ${outfile} "second line content." 
[root@bogon ~]# . write_log.sh
[root@bogon ~]# cat /data/my.log
first line content.
second line content.
# 上述脚本接收两个参数，第一个参数是写日志的目标文件，第二个参数是日志信息，整个脚本实现将日志信息写入目标文件内的目的

递归函数

• Shell 也可以实现递归函数，就是可以调用自己本身的函数。
• 在 Linux 系统上编写 Shell 脚本的时候，经常需要递归遍历系统的目录，列出目录下的文件和目录，逐层递归列出，并对这些层级关系进行展示。
• 具体的实现过程如下所示。

[root@bogon ~]# cat test.sh 
#!/bin/bash

function list_files(){
    for f in `ls $1`
    do
        if [ -d "$1/$f" ]; then 
            echo "$2$f"
            list_files "$1/$f" "    $2"
        else
            echo "$2$f"
        fi
    done
}
list_files "/var/log" ""
# 函数 list_files 的第一个参数是列举的目录名，第二个参数是调整的空间。执行脚本后， 其结果显示如下
[root@bogon ~]# . test.sh 
anaconda
    anaconda.log
    ifcfg.log
    journal.log
......        # 省略部分内容
wtmp
yum.log

二、Shell数组

• 在 Shell 脚本中，数组是一种常见的数据结构，主要的应用场景包括：
• 获取数组长度、获取元素长度、遍历元素、元素切片、元素替换、元素删除等等。
• Shell 中的数组与 Java、C、Python 不同，只有一维数组，没有二维数组。
• 数组元素的大小与限制，也不需要事先定义。
• Shell 数组用括号（）来表示，元素用空格分隔，元素的下标与大部分编程语言类似从 0 开始。

显示数组

[root@bogon ~]# kgc=(aa bb cc)
[root@bogon ~]# echo ${kgc[*]}
aa bb cc

[root@bogon ~]# echo ${kgc[@]}
aa bb cc

获取数组长度

[root@bogon ~]# echo ${#kgc[@]}
3

读取某下标赋值

[root@bogon ~]# echo ${kgc[0]}
aa
[root@bogon ~]# echo ${kgc[2]}    # 第三个元素
cc

数组遍历

[root@localhost ~]# vi array_traverse.sh
#!/bin/bash 
arr_number=(1 2 3 4 5) 
for v in ${arr_number[@]} 
do
    echo $v done
[root@localhost ~]# . array_traverse.sh
1
2
3
4
5

数组切片

[root@bogon ~]# echo ${kgc[@]:1:3}    # ${数组名[@或*]:起始位置:长度} 
bb cc dd
[root@bogon ~]# echo ${kgc[@]:1:2}
bb cc

数组替换

[root@bogon ~]# echo ${kgc[@]/bb/kc65}    # ${数组名[@或*]/查找字符/替换字符} 
aa kc65 cc dd

数组删除

[root@bogon ~]# unset kgc    # 删除数组
[root@bogon ~]# echo ${kgc[@]}

[root@bogon ~]# unset kgc[2]    # 删除第3个元素
[root@bogon ~]# echo ${kgc[@]}
aa bb dd                    

三、Shell 脚本调试

sh [-nvx] 脚本名

• -n：不会执行该脚本，仅查询脚本语法是否有问题，如果没有语法问题就不显示任何内容，如果有问题会提示报错。
• -v：在执行脚本时，先将脚本的内容输出到屏幕上然后执行脚本，如果有错误，也会给出错误提示。
• -x：将执行的脚本内容输出到屏幕上，这个是对调试很有用的参数。

# 示例，把结尾的 fi 结束语句注释掉
[root@bogon ~]# cat kkk.sh 
#!/bin/bash

read -p "请输入您的分数(0-100):" GRADE
if [ $GRADE -ge 85 ] && [ $GRADE -le 100 ];then
    echo "$GRADE 分!优秀"

elif [ $GRADE -ge 70 ] && [ $GRADE -le 84 ];then
    echo "$GRADE 分,合格"
else 
    echo "$GRADE 分？不合格"
#fi
[root@bogon ~]# sh -n kkk.sh 
kkk.sh:行12: 语法错误: 未预期的文件结尾
[root@bogon ~]# sh -x kkk.sh 
+ read -p '请输入您的分数(0-100):' GRADE
请输入您的分数(0-100):5
kkk.sh:行12: 语法错误: 未预期的文件结尾
[root@bogon ~]# sh -v kkk.sh 
#!/bin/bash

read -p "请输入您的分数(0-100):" GRADE
请输入您的分数(0-100):5
if [ $GRADE -ge 85 ] && [ $GRADE -le 100 ];then
    echo "$GRADE 分!优秀"

elif [ $GRADE -ge 70 ] && [ $GRADE -le 84 ];then
    echo "$GRADE 分,合格"
else 
    echo "$GRADE 分？不合格"
#fi
kkk.sh:行12: 语法错误: 未预期的文件结尾

# 当脚本文件较长时，可以使用 set 命令指定调试一段脚本。
[root@bogon ~]# cat kkk.sh 
#!/bin/bash
set -x        # 开启调试模式
read -p "请输入您的分数(0-100):" GRADE
if [ $GRADE -ge 85 ] && [ $GRADE -le 100 ];then
    echo "$GRADE 分!优秀"
set +x        # 关闭调试模式
elif [ $GRADE -ge 70 ] && [ $GRADE -le 84 ];then
    echo "$GRADE 分,合格"
else 
    echo "$GRADE 分？不合格"
#fi
[root@bogon ~]# sh kkk.sh 
+ read -p '请输入您的分数(0-100):' GRADE
请输入您的分数(0-100):50
kkk.sh:行12: 语法错误: 未预期的文件结尾

四、总结

Shell函数是编写可重用、可维护Shell脚本的重要工具。通过定义和使用函数，我们可以将复杂的任务分解为更小的、更易于管理的部分，并提高代码的可读性和可重用性。在编写Shell脚本时，建议充分利用函数来提高代码的质量和效率。