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

把重复动作封装成函数

把重复动作封装成函数

运维脚本一旦同时包含部署、检查和清理,复制粘贴很快会让参数、错误处理和日志行为失去一致性。本节把重复动作拆成 Shell 函数,并用位置参数、local 变量和返回状态建立清晰的调用契约。

学习目标

  • 用函数参数明确输入,避免函数隐式依赖大量全局变量。
  • 使用 local 限制临时变量作用域,并区分标准输出与返回状态。
  • 让调用方通过 if function ... 正确处理成功和失败分支。

先定义函数契约

Shell 函数没有独立的参数声明,调用函数时传入的值会成为函数内部的 $1、$2、$@。因此可维护函数应主动检查参数数量,并在函数开始处把位置参数赋给有语义的局部变量。

函数的 return 返回的是 0~255 的状态码,其中 0 表示成功,非零表示失败。它不是用来返回字符串、路径或对象的;如果函数确实需要产生数据,可以写到标准输出,再由调用方按需要捕获。

封装部署检查与清理

下面用一个临时目录模拟最小部署过程:deploy_file 复制配置文件,check_deploy 验证目标是否存在,cleanup_deploy 删除部署结果。三个函数都只依赖显式参数,不需要知道调用方用了什么变量名。

bash
#!/usr/bin/env bash
set -euo pipefail

deploy_file() {
  local source_file=${1:?缺少源文件参数}
  local deploy_dir=${2:?缺少部署目录参数}

  if [[ ! -f "$source_file" ]]; then
    printf '源文件不存在: %s\n' "$source_file" >&2
    return 2
  fi

  mkdir -p -- "$deploy_dir"
  cp -- "$source_file" "$deploy_dir/app.conf"
  printf '部署完成: %s\n' "$deploy_dir/app.conf"
}

check_deploy() {
  local deploy_dir=${1:?缺少部署目录参数}

  if [[ -s "$deploy_dir/app.conf" ]]; then
    printf '检查通过: app.conf 存在且非空\n'
    return 0
  fi

  printf '检查失败: app.conf 缺失或为空\n' >&2
  return 3
}

cleanup_deploy() {
  local deploy_dir=${1:?缺少部署目录参数}
  rm -rf -- "$deploy_dir"
  printf '清理完成: %s\n' "$deploy_dir"
}

work_dir=$(mktemp -d)
source_file="$work_dir/source.conf"
deploy_dir="$work_dir/release"
trap 'rm -rf "$work_dir"' EXIT

printf 'port=8080\n' > "$source_file"

if deploy_file "$source_file" "$deploy_dir" && check_deploy "$deploy_dir"; then
  printf '发布流程成功\n'
else
  printf '发布流程失败\n' >&2
  exit 1
fi

cleanup_deploy "$deploy_dir"

预期输出

text
部署完成: <PATH>/release/app.conf
检查通过: app.conf 存在且非空
发布流程成功
清理完成: <PATH>/release

其中 <PATH> 是 mktemp 创建的临时目录,实际值会因系统和每次运行而不同。函数通过标准输出打印过程信息,通过状态码告诉调用方动作是否成功,这两个通道承担不同职责。

用 local 隔离函数内部状态

如果直接写 source_file=$1,函数会修改同名全局变量;脚本规模变大后,这类隐式覆盖非常难定位。Bash 中应优先写成 local source_file=$1,让变量只在当前函数及其调用链的动态作用域内有效。

参数也应该在函数边界尽早校验。示例中的 ${1:?缺少源文件参数} 会在必填参数不存在时立即报错,比执行到 cp 才发现空路径更接近真正根因。

让状态码驱动调用流程

Shell 原生命令已经遵循“0 成功、非 0 失败”的约定,函数最好沿用这一机制。调用方可以直接把函数放进 if 条件,而不必执行后再立即读取 $?。

bash
#!/usr/bin/env bash
set -u

is_port_valid() {
  local port=${1:?缺少端口参数}
  [[ "$port" =~ ^[0-9]+$ ]] || return 2
  (( port >= 1 && port <= 65535 )) || return 3
  return 0
}

for port in 8080 70000 invalid; do
  if is_port_valid "$port"; then
    printf '%s: valid\n' "$port"
  else
    status=$?
    printf '%s: invalid, status=%d\n' "$port" "$status"
  fi
done

预期输出

text
8080: valid
70000: invalid, status=3
invalid: invalid, status=2

这里不同非零状态可以表达不同失败类型,使上层逻辑能够决定是重试、跳过还是直接终止。状态码不需要设计得过细,但至少应区分成功与失败,关键动作再增加少量稳定的错误码。

避免把输出和状态混在一起

当函数既要生成一个值又可能失败时,要特别注意命令替换。可以捕获标准输出,但同时必须保留并判断执行状态;否则调用方可能拿到空字符串后继续执行,把真正错误延迟到更远的位置。

另一个常见问题是函数内部直接 exit。普通可复用函数通常应 return,把是否终止整个脚本的决定交给最外层调用者。只有函数明确承担“结束整个程序”的职责时,才适合调用 exit。

一个可组合的 Shell 函数应具备清晰的输入参数、局部内部状态和稳定返回码:函数负责完成一个动作并报告结果,调用方负责把多个动作串成部署、检查、清理等更大的运维流程。

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

目录与阅读设置

阅读设置

17

记录一个想法

把重复动作封装成函数

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

登录哪都通