LinuxShell脚本规范建议_可维护性提升说明【指导】

9次阅读

脚本应以 #!/usr/bin/env bash 开头并启用 set -euo pipefail 和 export LANG=C.UTF-8;变量须区分全局(全大写 + 前缀 +readonly)与局部(local 显式声明);参数解析必须用 getopts;路径拼接需防御性处理,文件操作前须校验存在性并支持 dry-run。

LinuxShell 脚本规范建议_可维护性提升说明【指导】

脚本开头必须声明解释器和 编码

不加 #!/bin/bash 或写成 #!/bin/sh 却用了 Bash 特性(比如数组、[[),会导致在不同系统上行为不一致。CentOS 默认 /bin/sh 是 dash,Ubuntu 可能是 dash 或 bash,行为差异直接引发静默失败。

  • 统一用 #!/usr/bin/env bash:兼容不同安装路径,且明确启用 Bash 模式
  • 加上 set -euo pipefail:让脚本在变量未定义、命令失败、管道任一环节出错时立即退出
  • 显式声明 UTF-8:export LANG=C.UTF-8,避免 locale 相关的字符串比较或文件名处理异常

变量命名与 作用域 要严格区分

全局变量全大写加前缀(如 MYAPP_CONFIG_DIR),局部变量一律小写且用 local 显式声明——否则函数内赋值会污染全局,调试时极难定位。

  • 禁止裸写 CONFIG_PATH="/etc/myapp";应写成 readonly MYAPP_CONFIG_PATH="/etc/myapp"
  • 函数内所有非返回值变量必须加 local,包括循环变量:for local file in "${files[@]}"; do ……
  • 避免用 $1$2 直接逻辑判断;先赋给具名变量:readonly input_file="$1",便于阅读和后续加校验

参数解析必须用 getopts 而非手工切分

手写 if [[""=="-v"]] 看似简单,但无法处理 -vf config.yml 这类连写选项,也不支持长选项(--verbose)、必需参数绑定、自动 help 输出。

  • getopts 是 POSIX 标准 工具,无需额外依赖,足够覆盖 95% 场景
  • 短选项后跟 : 表示该选项需要参数,例如 getopts "f:v" optf: 表示 -f FILEv 是开关型
  • 错误处理要主动:当 getopts 返回非零时,应调用自定义 usage 函数并 exit 1,而不是默认忽略
while getopts "f:v" opt; do   case $opt in     f) readonly INPUT_FILE="$OPTARG" ;;     v) readonly VERBOSE=1 ;;     *) usage; exit 1 ;;   esac done

路径拼接和文件操作必须防御性处理

硬编码路径、忽略空格、不检查文件是否存在,是运维脚本最常导致“线上炸掉”的三连击。尤其当路径来自变量或用户输入时,"$DIR/$FILE"$DIR 末尾有斜杠、$FILE 开头有斜杠时,会意外变成双斜杠甚至覆盖上级目录。

  • realpathdirname "$(realpath"$0") 获取脚本真实路径,避免软链接执行时的路径错乱
  • 拼接前统一清理斜杠:full_path="${INSTALL_DIR%/}/${subdir#/}"%/ 去尾部斜杠,#/ 去开头斜杠
  • 所有 rmcpmv 前加 [[-e "$target"]] && echo "will remove: $target" 日志,生产环境建议默认禁用自动删除,改用 --dry-run 模式

真正难的不是写出能跑的 Shell 脚本,而是三个月后别人(或你自己)还能看懂它 为什么 删了那个 配置文件、为什么在某台机器上跳过了某个步骤——所有看似“多此一举”的声明、校验和路径处理,都是在为下次凌晨三点的故障排查省下两小时。

text=ZqhQzanResources