什么是Shell脚本运维规范

Shell脚本运维规范是指在服务器运维、自动化部署、定时任务等场景中，编写和维护 Shell 脚本（如 Bash 脚本）时应遵循的一套标准、约定和最佳实践。它的核心目的是：提高脚本的可读性、可维护性、安全性和稳定性，减少因脚本问题导致的线上故障。

下面从多个维度系统说明常见的 Shell 脚本运维规范。

一、脚本基础规范

1. 指定解释器（Shebang）

脚本第一行必须明确指定解释器：

#!/bin/bash

或

#!/usr/bin/env bash

2. 文件命名规范

• 使用小写字母、数字、下划线
• 见名知意
• 以 .sh 结尾（可选但推荐）

示例：

backup_mysql.sh
deploy_web.sh

3. 脚本权限

• 脚本文件权限一般为 755 或 750
• 避免赋予过宽权限（如 777）

二、编码与风格规范

1. 使用统一缩进

• 推荐使用 4 个空格 或 2 个空格
• 不使用 Tab 和空格混用

2. 变量命名

• 常量：大写
• 变量：小写或驼峰（团队统一）

LOG_DIR="/var/log"
retry_count=3

3. 变量加双引号

防止空格和特殊字符引发问题：

rm -rf "$file"

4. 避免硬编码

使用变量或配置文件：

BASE_DIR="/data/app"

三、健壮性与错误处理规范

1. 开启错误检测

set -euo pipefail

含义：

• -e：命令失败立即退出
• -u：使用未定义变量报错
• -o pipefail：管道中任意命令失败即失败

2. 明确处理返回值

if ! mkdir "$dir"; then
    echo "创建目录失败"
    exit 1
fi

3. 关键操作前做检查

• 文件是否存在
• 用户是否有权限
• 端口是否被占用

四、日志与输出规范

1. 统一日志格式

log_info() {
    echo "[$(date '+%F %T')] [INFO] $*"
}

2. 重要操作用日志留存

• 不建议只 echo 到终端
• 可写入日志文件

3. 避免敏感信息输出

• 密码、密钥不要打印

五、安全规范（非常重要）

1. 避免使用 rm -rf / 类危险命令

# 不安全
rm -rf $dir/

# 安全
[ -d "$dir" ] && rm -rf "$dir"

2. 不在脚本中明文写密码

使用：

• 环境变量
• 配置文件中限制权限
• 密钥管理工具

3. 校验输入参数

if [ $# -ne 2 ]; then
    echo "用法: $0 src dst"
    exit 1
fi

六、函数与结构规范

1. 合理使用函数

backup() {
    ...
}

main() {
    backup
}

main "$@"

2. 主逻辑放最后

• 变量定义在前
• 函数在中
• 执行业务在最后

七、定时任务（cron）规范

• cron 中写绝对路径
• 重定向输出，避免邮件爆炸

0 2 * * * /opt/scripts/backup.sh >> /var/log/backup.log 2>&1

八、可维护性规范

• 脚本头部写说明注释

# 脚本名称: backup.sh
# 功能: 备份 MySQL 数据库
# 作者: ops
# 更新时间: 2026-01-15

• 变更需评审和记录
• 重要脚本纳入 Git 管理

九、典型“反例”对照

❌ 不规范：

cd /data
rm -rf *

✅ 规范：

set -euo pipefail
BACKUP_DIR="/data/backup"
[ -d "$BACKUP_DIR" ] && rm -rf "$BACKUP_DIR"/*

总结一句话

Shell 脚本运维规范 = 可读 + 可控 + 可恢复 + 不坑人

如果你需要，我也可以：

• 给你一套企业级 Shell 脚本模板
• 或针对 运维 / _devops / SRE 场景做专项规范说明