Linux Shell 脚本编写规范与可维护性代码编写原则

风墨姑娘_3671

风墨姑娘_3671

2026-09-19

224人浏览

原创

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

linux shell 脚本编写规范与可维护性代码编写原则

写 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")。区分变量类型:

Linux Ai Server
Linux Ai Server

Linux AI 服务器 — 将 Linux 服务器转换为本地 AI 推理集群。使用 systemd、NVIDIA CUDA 实现无头 Linux AI,零 GUI 开销。

下载
  • 全局常量用全大写 + 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,自动发现常见陷阱

相关专题

更多
磁盘配额是什么
磁盘配额是什么

磁盘配额是计算机中指定磁盘的储存限制,就是管理员可以为用户所能使用的磁盘空间进行配额限制,每一用户只能使用最大配额范围内的磁盘空间。php中文网为大家提供各种磁盘配额相关的内容,教程,供大家免费下载安装。

2023.06.21

4050

4

如何安装LINUX
如何安装LINUX

本站专题提供如何安装LINUX的相关教程文章,还有相关的下载、课程,大家可以免费体验。

2023.06.29

3453

10

linux find
linux find

find是linux命令,它将档案系统内符合 expression 的档案列出来。可以指要档案的名称、类别、时间、大小、权限等不同资讯的组合,只有完全相符的才会被列出来。find根据下列规则判断 path 和 expression,在命令列上第一个 - ( ) , ! 之前的部分为 path,之后的是 expression。还有指DOS 命令 find,Excel 函数 find等。本站专题提供linux find相关教程文章,还有相关

2023.06.30

2633

5

linux修改文件名
linux修改文件名

本专题为大家提供linux修改文件名相关的文章,这些文章可以帮助用户快速轻松地完成文件名的修改工作,大家可以免费体验。

2023.07.05

6410

7

linux系统安装教程
linux系统安装教程

linux系统是一种可以免费使用,自由传播,多用户、多任务、多线程、多CPU的操作系统。本专题提供linux系统安装教程相关的文章,大家可以免费体验。

2023.07.06

6062

7

linux查看文件夹大小
linux查看文件夹大小

Linux是一种自由和开放源码的类Unix操作系统,存在着许多不同的Linux版本,但它们都使用了Linux内核。Linux可安装在各种计算机硬件设备中,比如手机、平板电脑、路由器、视频游戏控制台、台式计算机、大型机和超级计算机。linux怎么查看文件夹大小呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.20

3533

8

linux查看ip命令
linux查看ip命令

本专题为大家提供linux查看ip命令相关文章内容,感兴趣的朋友可以免费下载体验试试。

2023.07.20

3005

4

linux查看cpu使用率
linux查看cpu使用率

在linux的系统维护中,可能需要经常查看cpu使用率,分析系统整体的运行情况。本专题为大家带来了linux查看cpu使用率的相关文章,感兴趣的朋友千万不要错过了。

2023.07.25

3239

6

linux查找文件命令
linux查找文件命令

Linux是一种自由和开放源码的类Unix操作系统,存在着许多不同的Linux版本,但它们都使用了Linux内核。Linux可安装在各种计算机硬件设备中,比如手机、平板电脑、路由器、视频游戏控制台、台式计算机、大型机和超级计算机。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.31

297

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

Buffalo框架快速入门指南
Buffalo框架快速入门指南

共0课时 | 0人学习

Valgrind支持平台说明
Valgrind支持平台说明

共0课时 | 0人学习