Shell脚本需兼顾可读性、安全性和可维护性:首行用#!/usr/bin/env bash,启用set -euo pipefail和LANG=C.UTF-8;变量加引号、命名规范、函数显式声明local;结构分层、错误主动捕获、配置外置、路径防御、权限可控,并用shellcheck检查。

写 Shell 脚本不是“能跑就行”,而是要让别人(包括三个月后的你自己)一眼看懂、放心修改、安全复用。规范不是束缚,是降低协作成本、减少线上事故的基础设施。
脚本开头必须明确解释器与运行环境
首行必须是 #!/usr/bin/env bash,兼容不同系统中 bash 的安装路径,避免因默认 shell 差异(如 CentOS 的 /bin/sh 是 dash)导致静默失败。紧随其后应启用严格模式和编码声明:
- set -euo pipefail:未定义变量、命令失败、管道任一环节出错均立即终止
- export LANG=C.UTF-8:统一字符编码,防止 locale 引起的字符串比较或文件名处理异常
变量与函数命名清晰且作用域分明
所有变量引用必须加双引号("$var"),避免空格或通配符引发意外行为;赋值时等号两侧不加空格(log_dir="/var/log")。区分变量类型:
- 全局常量用全大写 + readonly(如 readonly MAX_AGE_DAYS=30)
- 函数内变量一律用 local 显式声明(如 local file="$1")
- 函数名以动词开头、小写+下划线(如 rotate_logs),顶部附简明注释说明用途、参数、返回值
结构分层、逻辑解耦、错误主动捕获
主流程只保留函数调用顺序,关键操作拆成独立函数。不用堆砌几十行 if-else 在 main 里。每行不超过 80 字符,管道符 | 和逻辑运算符后换行并缩进一层。条件判断统一用 [[ ]],不混用 [ ] 或 test。
- 参数解析必须用 getopts,支持连写选项(如 -vf config.yml)、自动 help 输出
- 关键命令后加 || die "描述性错误信息",die 函数统一输出日志并退出
- 日志分级输出:log_info、log_warn、log_error,不混用 echo
工程化落地:配置外置、路径防御、权限可控
脚本本身只负责逻辑,配置项抽到外部文件或环境变量中(如生产走 /etc/rotate.conf,开发走 ./config/dev.conf)。路径拼接前清理斜杠:full_path="${DIR%/}/${subdir#/}";文件操作前校验存在性:[ -d "$BACKUP_DIR" ] || mkdir -p "$BACKUP_DIR"。
- 脚本命名用蛇形小写 + .sh 后缀(如 backup_mysql.sh),禁止空格、大写、特殊字符
- 权限设为 755(chmod 755 script.sh),不给 777
- 上线前必跑 shellcheck -s bash script.sh,自动发现常见陷阱


















