shell函数封装核心是模块化、可复用与避免变量污染:须用local声明局部变量,规范参数传递,统一返回值,封装日志校验等通用逻辑,并确保不修改调用方环境。

Shell函数封装的核心是让代码模块化、可复用,同时避免变量污染——关键在于用 local 明确声明局部变量,并合理设计参数接口。
函数定义与调用要简洁清晰
函数名应见名知意,参数尽量通过位置变量($1、$2…)传递,避免依赖全局状态。函数体首行建议加简短注释说明用途。
- 用 function name { ... } 或 name() { ... } 均可,推荐后者(POSIX 兼容性更好)
- 调用时直接写函数名,不加括号,如 log_info "task started"
- 返回值统一用 return N(N 为 0–255 整数),0 表示成功,非 0 表示异常
必须用 local 声明所有内部变量
未加 local 的变量默认是全局的,极易引发意外覆盖。即使只读变量(如 )也要在函数开头赋值给局部变量再使用。
- local msg="$1" —— 安全捕获参数
- local count=0 —— 明确初始化局部计数器
- 嵌套函数中,外层的 local 对内层不可见,天然隔离
- 不要在条件语句或循环体内单独写 local var,而应在函数顶部集中声明(提高可读性)
封装常见操作:日志、校验、临时文件处理
把重复逻辑抽成小函数,比如统一日志格式、路径存在性检查、安全创建临时目录等,能显著提升脚本健壮性。
- log_debug() 和 log_error() 可共用时间戳和颜色前缀
- require_cmd git curl 检查多个命令是否存在,缺失则报错退出
- with_tempdir() { local dir=$(mktemp -d); trap "rm -rf '$dir'" EXIT; echo "$dir"; } —— 自动清理临时目录
避免副作用:不修改调用方环境
函数不应擅自改变 PWD、IFS、set -e 等全局设置,也不应 unset 调用方变量。
- 若需切换目录,用 (cd "$path" && do_something) 子 shell,不影响父环境
- 修改 IFS 仅限当前函数内,且必须在函数末尾恢复(local IFS=':' 更安全)
- 启用严格模式(set -euo pipefail)应在脚本顶层设置,而非函数内随意开关











