shell介绍（八）--shell 函数

目录

定义函数

函数调用

返回值

示例：定义和调用函数

传递参数

局部变量

返回多个值

使用 return 设置返回状态码

使用 exit 退出脚本

使用 source 或 .  加载其他脚本中的函数

使用 export 导出函数

使用 type 检查函数定义

总结

---

 

在Unix/Linux Shell脚本中，函数（function）是一种组织代码的方式，它可以让脚本更加模块化，易于维护，并且可以重复使用代码。Shell函数可以接受参数，执行一系列命令，并返回一个状态码。

定义函数

在Bash shell中定义函数的基本语法如下：

bash

深色版本

1function_name() {
2    # 函数体
3    commands
4}

或者简化形式：

bash

深色版本

1function_name() {
2    commands
3}

或者使用关键字function：

bash

深色版本

1function function_name {
2    commands
3}

函数调用

定义好函数之后，就可以在脚本的任何地方调用它：

bash

深色版本

1function_name arg1 arg2 ...

返回值

函数可以返回一个整数作为状态码，通常用于指示函数是否成功执行：

bash

深色版本

1return number

如果函数没有显式返回值，默认返回最后一条命令的状态码。

示例：定义和调用函数

bash

深色版本

1#!/bin/bash
2
3# 定义一个函数
4greet() {
5    local name="$1"
6    echo "Hello, $name!"
7}
8
9# 调用函数
10greet "Alice"

传递参数

函数可以接受任意数量的参数，参数可以通过 $1, $2, $3, ... 访问，其中 $1 表示第一个参数，$2 表示第二个参数，以此类推。$0 通常表示脚本名称或者函数名称。

bash

深色版本

1#!/bin/bash
2
3# 定义一个函数
4add() {
5    local a=$1
6    local b=$2
7    echo $((a + b))
8}
9
10# 调用函数
11result=$(add 3 4)
12echo "The sum is $result"

局部变量

在函数内部定义的变量默认是局部的，这意味着它们只在函数内部有效，并且不会影响函数外部的同名变量。

bash

深色版本

1#!/bin/bash
2
3# 定义全局变量
4global_var="global"
5
6# 定义一个函数
7local_var_test() {
8    local local_var="local"
9    echo "Inside function: global_var = $global_var, local_var = $local_var"
10}
11
12# 调用函数
13local_var_test
14echo "Outside function: global_var = $global_var, local_var = $local_var"

返回多个值

如果需要从函数返回多个值，可以使用数组或者通过全局变量传递。

bash

深色版本

1#!/bin/bash
2
3# 定义一个函数
4get_info() {
5    local name="Alice"
6    local age=30
7    echo "$name"
8    echo "$age"
9}
10
11# 调用函数并读取输出
12read name age < <(get_info)
13echo "Name: $name, Age: $age"

使用 return 设置返回状态码

return 命令可以用来设置函数的返回状态码，这通常用于错误处理。

bash

深色版本

1#!/bin/bash
2
3# 定义一个函数
4check_status() {
5    if [ "$1" -gt 0 ]; then
6        echo "Passed"
7        return 0
8    else
9        echo "Failed"
10        return 1
11    fi
12}
13
14# 调用函数
15status=$(check_status 5)
16if [ $? -eq 0 ]; then
17    echo "Status check passed."
18else
19    echo "Status check failed."
20fi

使用 exit 退出脚本

如果函数内部需要提前终止脚本的执行，可以使用 exit 命令。

bash

深色版本

1#!/bin/bash
2
3# 定义一个函数
4error_check() {
5    if [ "$1" -lt 0 ]; then
6        echo "Negative value detected."
7        exit 1
8    fi
9}
10
11# 调用函数
12error_check -1
13echo "This line will not be executed if error_check exits with non-zero status."

使用 source 或 .  加载其他脚本中的函数

如果函数定义在另一个脚本文件中，可以使用 source 或者 . 来加载那个脚本文件，这样就可以在当前脚本中使用那些函数了。

bash

深色版本

1#!/bin/bash
2
3# 加载其他脚本中的函数
4source other_script.sh
5
6# 调用其他脚本中的函数
7other_function "Argument"

使用 export 导出函数

如果你想让函数在子shell中也能使用，可以使用 export 命令来导出函数。

bash

深色版本

1#!/bin/bash
2
3# 定义一个函数
4export -f greet_user
5
6# 在子shell中调用函数
7( greet_user "Alice" )

使用 type 检查函数定义

可以使用 type 命令来检查一个名字是否被定义为函数。

bash

深色版本

1#!/bin/bash
2
3# 定义一个函数
4function hello {
5    echo "Hello!"
6}
7
8# 检查函数定义
9type hello

总结

通过使用Shell函数，你可以编写更加模块化和可维护的脚本。函数不仅可以接受参数和返回值，还可以包含复杂的逻辑。掌握Shell函数的定义和使用方法，有助于编写高效、可靠的脚本程序。