Debian上下文下的脚本编写有哪些规范

Debian上下文下的脚本编写规范

1. Shebang行规范

脚本开头必须添加Shebang行（#!），用于指定解释器路径。Debian环境下推荐以下两种写法：

• 明确指定解释器：#!/bin/bash（适用于大多数Debian系统，Bash是默认Shell之一）；
• 增强可移植性：#!/usr/bin/env bash（通过env命令动态查找bash路径，避免因解释器路径不同导致的兼容性问题）。
  Shebang行必须是脚本的第一行，且不能有多余空格（如#!/bin/bash 会导致错误）。

2. 缩进与格式规范

• 缩进：使用2个或4个空格进行缩进（避免使用Tab键，因Tab在不同编辑器中显示宽度不一致）；
• 命令换行：长命令可通过**反斜杠（\）**换行，提高可读性（如find /var/log \ -type f \ -name "*.log" \ -mtime +7）；
• 变量与运算符：变量赋值时等号两边不能有空格（如var=value），条件判断时变量与运算符需用空格分隔（如if [[ "$var" == "value" ]]; then）。

3. 命名约定

• 变量与函数：使用小写字母+下划线（lowercase_snake_case）命名（如file_path、check_file_exists），避免使用系统关键字（如if、while）或函数名作为变量名；
• 常量与环境变量：使用大写字母+下划线（UPPERCASE_SNAKE_CASE）命名（如MAX_RETRIES=5、export DATABASE_URL="pgsql://..."），明确区分可变与不可变数据。

4. 引号使用规范

• 变量引用：永远用**双引号（“”）**包裹变量（如echo "${my_variable}"），防止变量值包含空格或特殊字符时导致错误（如$my_variable未加引号可能被拆分成多个参数）；
• 字符串字面量：固定字符串可使用单引号（‘’）或双引号（“”），但双引号支持变量替换（如echo "Hello, $name"），单引号则原样输出（如echo 'Hello, $name'）。

5. 错误处理规范

• 严格模式：脚本开头添加set -euo pipefail，实现以下功能：
  • set -e：任何命令执行失败（退出码非0）时，脚本立即终止；
  • set -u：使用未定义变量时，脚本立即终止；
  • set -o pipefail：管道命令中任一命令失败，整个管道返回失败状态。
• 错误信息输出：将错误信息输出到标准错误流（>&2）（如echo "Error: File not found." >&2），区分正常输出与错误输出；
• 命令检查：关键命令执行后检查返回值（$?），如mkdir /data || { echo "Failed to create directory."; exit 1; }；
• 清理机制：使用trap命令在脚本退出时（包括错误退出）执行清理操作（如删除临时文件），例如trap 'rm -f "$temp_file"' EXIT。

6. 注释规范

• 解释“为什么”：注释应说明代码的意图（如# 需要重试3次以提高成功率），而非“是什么”（如# i加1）；
• 分割逻辑块：使用# ---或# ===等分割线分隔不同功能的代码块（如# --- 初始化变量 ---），提高可读性；
• 避免冗余注释：如i=$((i + 1))无需注释“i加1”，但复杂逻辑（如正则表达式）需注释说明用途。

7. 安全规范

• 权限管理：脚本文件需设置合理权限（如chmod 755 script.sh），确保只有所有者可写（防止未授权修改）；敏感脚本（如包含密码）需限制为chmod 700；
• 防止注入攻击：
  • 对用户输入进行验证（如用正则表达式[[ $input =~ ^[0-9]+$ ]]验证数字）；
  • 对输入进行转义（如用printf "%s" "$input" | sed 's/[^a-zA-Z0-9._-]/_/g'去除特殊字符）；
  • 使用参数扩展而非字符串拼接（如ls "$dir"而非ls $dir），避免命令注入。

8. 可移植性规范

• 避免硬编码路径：如/usr/bin/apt应改为command -v apt（动态查找命令路径），适配不同Debian版本或自定义安装路径；
• 使用系统工具：优先使用Debian自带的工具（如apt、dpkg、tar），避免依赖第三方工具（除非必要）；
• 兼容性测试：在Debian的不同版本（如Debian 11、Debian 12）中测试脚本，确保兼容性。

9. 调试规范

• 调试模式：使用set -x开启调试（显示执行的命令及参数），帮助定位问题（如bash -x script.sh）；
• 日志记录：将关键操作输出到日志文件（如echo "$(date): Script started." >> script.log），便于后续排查问题；
• 分段测试：将脚本拆分为多个函数，单独测试每个函数的正确性（如test_check_file_exists），降低调试复杂度。

10. 模块化规范

• 函数封装：将重复逻辑封装为函数（如function backup_files { ... }），提高代码复用性；
• 参数传递：通过$1、$2等位置参数传递输入（如./script.sh input_dir output_dir），增强脚本灵活性；
• 模块化设计：将复杂任务拆分为多个脚本，通过source命令引入公共函数（如source utils.sh），提升可维护性。