命令行与文本处理 / 系统课时
公共函数怎样拆到独立文件
公共函数怎样拆到独立文件
当多个 Shell 脚本都要记录日志、检查参数或判断文件是否存在时,继续复制函数会让修复变得不一致。更稳妥的做法是把公共函数放进独立文件,再由业务脚本通过 source 加载,并用稳定路径定位这个文件。
学习目标
- 把可复用函数拆到独立的 Shell 文件中
- 正确使用
source加载函数,并理解它与执行子脚本的区别 - 避免因当前工作目录变化导致公共文件找不到
把公共逻辑放进独立文件
公共文件只负责定义函数,不要在被加载时直接执行备份、删除文件等业务动作。这样其他脚本加载它时,只会获得函数定义,不会产生额外副作用。
下面的示例创建 lib/common.sh,其中包含日志函数和文件检查函数,再由 backup.sh 复用它们。
set -eu
mkdir -p lib
cat > lib/common.sh <<'EOF'
log_info() {
printf '[INFO] %s\n' "$1"
}
require_file() {
local file=$1
if [ ! -f "$file" ]; then
printf '[ERROR] missing file: %s\n' "$file" >&2
return 1
fi
}
EOF
cat > backup.sh <<'EOF'
#!/usr/bin/env bash
set -eu
SCRIPT_DIR=$(CDPATH= cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)
source "$SCRIPT_DIR/lib/common.sh"
input_file=$1
require_file "$input_file"
log_info "ready to process: $input_file"
EOF
printf 'demo\n' > sample.log
bash backup.sh sample.log预期输出:
[INFO] ready to process: sample.log这里把公共函数集中在 lib/common.sh。以后日志格式或检查规则需要修改,只改这一处,所有加载它的脚本都会获得一致行为。
为什么要用 source
source file 会在当前 Shell 进程中读取并执行文件,因此其中定义的函数和变量在后续代码里仍然可用。Bash 也支持等价写法 . file。
如果改成 bash lib/common.sh,系统会启动一个子 Shell。函数只存在于子 Shell,命令结束后当前脚本仍然无法调用 log_info 或 require_file。
不要依赖启动时的当前目录
直接写 source ./lib/common.sh 只有在调用者当前目录恰好是脚本所在目录时才可靠。例如用户在 /tmp 中运行 /opt/tools/backup.sh,./lib/common.sh 会被解释成 /tmp/lib/common.sh。
示例中的 SCRIPT_DIR 根据 BASH_SOURCE[0] 计算当前脚本自身所在目录,再从那里加载公共文件,因此从哪个目录启动脚本都不会改变查找位置。
cd /tmp
bash <PATH>/backup.sh <PATH>/sample.log预期结果:
[INFO] ready to process: <PATH>/sample.log<PATH> 代表示例文件实际所在目录,不同机器上的值会不同。
让公共文件保持可控
拆分后还应控制公共文件的职责。适合复用的通常是日志、参数检查、重试、路径检查等通用能力;只服务于某一个脚本的流程判断,应继续留在业务脚本中。
公共函数最好通过参数接收输入,并使用 return 报告成功或失败。避免在公共文件顶层修改调用者的关键变量,也不要随意执行 exit,否则一个检查函数就可能直接终止整个调用脚本。
把公共函数拆出去的核心收益不是“文件更少”,而是让共享行为只有一个维护入口,同时让每个业务脚本仍然清楚地表达自己的执行流程。