Linux 与服务器运维 / 系统课时

使用函数组织脚本

使用函数组织脚本

当 Shell 脚本开始出现重复命令、参数判断和错误处理时,把逻辑拆成函数能明显降低修改成本。本节用一个可直接运行的 Bash 示例,掌握函数定义、参数传递、局部变量与返回状态的组合方式。

学习目标

  • 能定义并调用 Bash 函数,理解 $1、$# 和 $@ 在函数中的含义
  • 能区分“函数输出的数据”和“函数返回状态”,正确处理成功与失败
  • 能用 local、return 和主函数入口组织可维护脚本

函数解决什么问题

函数适合封装“会重复执行、可以单独命名、输入输出明确”的逻辑。例如参数校验、日志输出、文件检查和业务步骤都可以各自成为函数。调用函数时不需要括号,参数直接写在函数名之后。

Bash 常见定义方式如下:

bash
function_name() {
    # 函数体
    :
}

这里的 : 是 Bash 的空命令,仅用于展示语法。真正脚本中应替换为实际逻辑。函数必须先定义后调用,除非定义代码已经通过 source 提前加载。

参数与局部变量

函数拥有自己的位置参数。调用 check_file "/tmp/demo.txt" 时,函数内部的 $1 是 /tmp/demo.txt;$# 表示参数个数;$@ 表示全部参数。它们只在函数调用期间代表该函数收到的参数,不会自动沿用外层脚本的位置参数。

函数内部变量默认仍是全局变量。为了避免函数意外覆盖脚本其他位置的同名变量,应优先用 local:

bash
show_target() {
    local target="$1"
    printf 'target=%s\n' "$target"
}
show_target "/tmp/demo.txt"

预期输出:

text
target=/tmp/demo.txt

用返回状态表达成功或失败

return 返回的是退出状态,而不是业务数据。约定上 0 表示成功,非 0 表示失败;Bash 函数的返回状态范围是 0~255。如果需要把计算结果交给调用方,可将数据写到标准输出,再用命令替换 $(...) 捕获。

下面的脚本把参数校验、计算和主流程拆成三个函数。将命令整体执行后,会创建并运行 calc.sh:

bash
cat > ./calc.sh <<'EOF'
#!/usr/bin/env bash

require_args() {
    if (( $# != 2 )); then
        printf 'usage: %s INTEGER INTEGER\n' "$0" >&2
        return 64
    fi
    if [[ ! "$1" =~ ^-?[0-9]+$ || ! "$2" =~ ^-?[0-9]+$ ]]; then
        printf 'arguments must be integers\n' >&2
        return 65
    fi
}

sum_two() {
    local left="$1"
    local right="$2"
    printf '%d\n' "$((left + right))"
}

main() {
    require_args "$@" || return $?

    local total
    total="$(sum_two "$1" "$2")" || return $?
    printf '[INFO] %s + %s = %s\n' "$1" "$2" "$total"
}

main "$@"
EOF
chmod +x ./calc.sh
./calc.sh 7 5

预期输出:

text
[INFO] 7 + 5 = 12

再传入非法参数,检查失败状态是否向外传播:

bash
./calc.sh 7 x
printf 'exit=%s\n' "$?"

预期输出:

text
arguments must be integers
exit=65

这样调用方既能读取正常数据,也能通过 $? 判断执行是否成功。

组织脚本时的边界

函数应尽量只承担一个职责。参数通过位置参数传入,函数内部临时变量用 local,需要让调用方判断成败时使用 return。不要依赖大量未声明的全局变量,否则函数表面上可复用,实际却和脚本其他部分紧密耦合。

对于较大的脚本,可保留一个 main 函数作为入口,把准备、校验和业务步骤串起来。这样既能从上到下读懂执行顺序,也能单独测试其中的函数,而不必复制整段脚本逻辑。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

使用函数组织脚本

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通