1. 函数定义

函数可以让我们将一个复杂功能划分成若干模块，让程序结构更加清晰，代码重复利用率更高。Shell 也支持函数。Shell 函数必须先定义后使用。

Shell 函数的定义格式如下：

1
2
3
4

function_name () {
    list of commands
    [ return value ]
}

也可以在函数名前加上关键字 function：

1
2
3
4

function function_name () {
    list of commands
    [ return value ]
}

2. 函数返回值

函数返回值，可以显式增加return语句；如果不加，会将最后一条命令运行结果作为返回值。

Shell 函数返回值只能是整数，一般用来表示函数执行成功与否，0表示成功，其他值表示失败。

如果 return 其他数据，比如一个字符串，往往会得到错误提示：“numeric argument required”。

如果一定要让函数返回字符串，那么可以先定义一个变量，用来接收函数的计算结果，脚本在需要的时候访问这个变量来获得函数返回值。函数返回值在调用该函数后通过 $?【$?表示上个命令的退出状态，或函数的返回值。】 来获得。

3. 函数调用

调用函数只需要给出函数名，不需要加括号。

像删除变量一样，删除函数也可以使用 unset 不过要加上 .f 选项

1

$unset .f function_name

如果你希望直接从终端调用函数，可以将函数定义在主目录下的 .profile 文件，这样每次登录后，在命令提示符后面输入函数名字就可以立即调用。

示例：

1
2
3
4
5
6
7

#!/bin/bash
# Define your function here
Hello () {
   echo "Url is http://see.xidian.edu.cn/cpp/shell/"
}
# Invoke your function
Hello

运行结果：

1
2
3

$./test.sh
Hello World
$

4. 函数参数

在Shell中，调用函数时可以向其传递参数。在函数体内部，通过 $n 的形式来获取参数的值，例如，$1表示第一个参数，$2表示第二个参数…

注意，$10 不能获取第十个参数，获取第十个参数需要${10}。当n>=10时，需要使用${n}来获取参数。

特殊变量用来处理参数:

特殊变量 说明
$# 传递给函数的参数个数。
$* 显示所有传递给函数的参数。
$@ 与$*相同，但是略有区别，请查看 Shell特殊变量 。
$? 函数的返回值。 【可以用反引号 ` 围住命令调用，然后赋值给一个变量】
$$ 本脚本进程的 PID

带参数的函数示例：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

#!/bin/bash
funWithParam(){
    echo "The value of the first parameter is $1 !"
    echo "The value of the second parameter is $2 !"
    echo "The value of the tenth parameter is $10 !"
    echo "The value of the tenth parameter is ${10} !"
    echo "The value of the eleventh parameter is ${11} !"
    echo "The amount of the parameters is $# !"  # 参数个数
    echo "The string of the parameters is $* !"  # 传递给函数的所有参数
}
funWithParam 1 2 3 4 5 6 7 8 9 34 73

运行脚本：

1
2
3
4
5
6
7

The value of the first parameter is 1 !
The value of the second parameter is 2 !
The value of the tenth parameter is 10 !
The value of the tenth parameter is 34 !
The value of the eleventh parameter is 73 !
The amount of the parameters is 12 !
The string of the parameters is 1 2 3 4 5 6 7 8 9 34 73 !"

参考：

$? 的使用方法

返回值的方式

方法一 return
方法二 echo

$? 可以用来表示 上一个进程是否正确执行，0 表示成功，1 表示失败

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

systemctl start nginx
ps -ef | grep nginx | grep -v grep
echo $?

systemctl stop nginx
ps -ef | grep nginx | grep -v grep

echo $?
# 答案肯定是 1 ，因为 nginx进程已经没有了
# 注意，如果写到脚本里面，不要把脚本名字含有 nginx，不然会有bug

脚本的使用方法 查看进程信息

1
2
3
4
5

#!/bin/bash
this_pid=$$
# 自己的pid
ps -ef | grep nginx | grep -v grep | grep -v $this_pid
echo $?

另一种写法

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

#!/bin/bash
#Author:LYR
#Time:2021-10-03 17:35:05
#Name:app.sh


this_pid=$$
# 自己的pid
ps -ef | grep nginx | grep -v grep | grep -v $this_pid

if [ $? -eq 0 ]; then
        echo "nginx is running"
else
        # systemctl start nginx
        echo "nginx is down ,start it..."
fi

使用 return返回

  • 使用return 返回值，只能返回 1-255 的整数
  • 函数 使用return 返回值 ，通常只是用来供其他地方获取这台，通常 返回 0 或者1
    • 0 表示成功，1 表示失败

使用 echo返回

  • echo 可以返回任何字符串
  • 通常用于返回数据，比如 一个字符串或者列表的值
return 的操作用法
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

#!/bin/bash
#Author:LYR
#Time:2021-10-03 17:35:05
#Name:app.sh


this_pid=$$
# 自己的pid
function is_nginx_running
{

	ps -ef | grep nginx | grep -v grep | grep -v $this_pid &> /dev/null
# 放入 /dev/null 这样 就不会控制台打印了
	if [ $? -eq 0 ]; then
 		return 0
	else 
		return 1

	fi


}

# shell 三目表达式：  b? a:b 
is_nginx_running && echo "nginx running" || echo "nginx is stopped"
echo 的操作用法
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

#!/bin/bash
#Author:LYR
#Time:2021-10-03 17:35:05
#Name:app.sh

# cat /etc/passwd | cut -d: -f1
# 取出第一个字段
# 取出所有系统的用户名字
function get_users
{
# 分隔符是 : 
	local users=`cat /etc/passwd | cut -d: -f1`
	# 用 local 声明为 局部变量
	echo $users

}

user_list=`get_users`

index=1
for u in $user_list
do
	echo " the $index user is :  $u "
	index=$(($))
done

函数库的使用方法

库函数经验

  • 一般的库文件名字后缀是任意的，但是一般会 使用 .lib 结尾

  • 导入方法

    • . 引入
    • source 关键字引入

练习

函数库 通常是封装被其他脚本调用的

实现加减乘除 几个函数的方法

这个是封装的 app.sh
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

#!/bin/bash
#Author:LYR
#Time:2021-10-03 17:35:05
#Name:app.sh

this_pid=$$
# 自己的pid
        # systemctl start nginx


function add {
    echo "`expr $1 + $2`"
}

function reduce
{
    echo "`expr $1 - $2`"

}

function multiple
{
    echo "`expr $1 * $2`"
}
function divide
{
    echo "`expr $1 / $2`"

}

用 . 脚本名字 导入函数

1
2
3
4
5
6
7
8
9

#!/bin/bash
#Author:LYR
#Time:2021-10-03 18:13:01
#Name:test.sh

. app.sh

add 1 1
reduce 30 10

你也可以在 shell 交互界面这里 引入

1
2
3
4
5
6
7

# 这里是交互的
. ./app.sh
add 1 1

# 其实 你还可以用 source 关键字引入
source ./app.sh
add 1 2