Shell脚本标准完全指南：运维工程师必备手册

编写高质量的 Shell 脚本，核心在于兼顾可读性、可维护性和安全性。结合你平时在服务器运维和网络安全方面的技术积累，这里为你梳理了一套从底层规范到防御性编程的实战标准：

 1. 文件基础与命名规范

Shebang 声明： 脚本第一行必须明确指定解释器，如 #!/bin/bash 或 #!/usr/bin/env bash，避免依赖系统默认的 Shell 环境。

文件命名： 采用小写字母加下划线的蛇形命名法(如 backup_mysql.sh)，做到见名知意，严禁使用空格或特殊字符。

编码与权限： 统一使用 UTF-8 编码，行尾使用 LF(Unix 格式)。脚本执行权限设为 755，数据文件设为 600，遵循最小权限原则。

 2. 代码排版与注释

缩进与换行： 统一使用 4 个空格缩进(禁止使用 Tab)，单行代码建议不超过 80 个字符。长命令在管道符 | 或逻辑运算符 && 后换行，并使用 续行。

头部注释： 脚本开头必须包含多行注释，说明脚本功能、作者、创建时间、参数用法及依赖项。

函数注释： 每个函数顶部需写明作用、输入参数、返回值及副作用。

 3. 变量与函数规范

命名区分： 全局变量和常量使用全大写加下划线(如 MAX_RETRY_COUNT)，局部变量使用小写加下划线(如 log_dir)。

安全引用： 所有变量引用必须加双引号(如 "$var")，防止因空格或通配符引发解析错误。使用 ${var} 明确变量边界。

作用域控制： 函数内部优先使用 local 声明局部变量，避免污染全局命名空间。

常量声明： 使用 readonly 或 declare -r 声明不可变常量。

 4. 错误处理与严格模式

启用严格模式： 脚本开头推荐启用 set -euo pipefail：

set -e：遇到命令执行失败立即退出。

set -u：引用未定义变量时报错。

set -o pipefail：管道中任一命令失败，整个表达式即失败。

资源清理： 使用 trap 机制捕获 EXIT、ERR 等信号，确保临时文件清理、锁文件释放等收尾操作原子执行。

输入校验： 脚本入参必须进行合法性校验(如检查参数数量、目录是否存在)，失败时输出错误信息到标准错误(>&2)并退出。

 5. 安全与运维规范

绝对路径： 所有外部命令尽量使用绝对路径(如 /usr/bin/mysql)，避免 PATH 劫持风险。

敏感信息： 严禁在脚本中硬编码密码或密钥，应通过环境变量或密钥管理服务动态注入。

危险命令： 避免使用 eval，防止命令注入。对用户输入的路径使用 realpath 标准化，阻断 ../ 路径遍历。

静态检查： 脚本上线前务必使用 shellcheck 工具进行静态扫描，自动发现常见陷阱和语法错误。