Shell脚本编写规范:运维代码的可读性与工程化

风浩姑娘_5191

风浩姑娘_5191

2026-06-18

880人浏览

原创

shell脚本需兼顾可读性、安全性和可维护性:开头明确解释器与用途,变量函数命名规范并加引号引用,启用set -euo pipefail严格模式,逻辑拆分为函数,日志分级输出,配置外置,权限设为755,上线前用shellcheck检查。

shell脚本编写规范:运维代码的可读性与工程化

写 Shell 脚本不是“能跑就行”,而是要让别人(包括三个月后的你自己)一眼看懂、放心修改、安全复用。规范不是束缚,是降低协作成本、减少线上事故的基础设施。

脚本开头必须明确解释器和意图

第一行必须是 #!/bin/bash 或更通用的 #!/usr/bin/env bash,避免因系统默认 shell 不同导致语法错误。紧接着用注释说明脚本用途、作者、创建时间、参数用法和依赖项。比如:

  • 功能一句话讲清:“每日清理 /var/log 下 30 天前的压缩日志”
  • 参数写清楚:“-d DIR 指定日志目录(必选),-k 保留最近 N 个文件(默认7)”
  • 依赖标出来:“需安装 findutils 4.6+,不依赖外部 Python 或 Perl”

变量与函数要“看得见、管得住”

所有变量名用小写加下划线(log_dir),赋值时等号两侧不加空格(log_dir="/var/log"),引用时一律加双引号("$log_dir")。常量全大写并只读声明(readonly MAX_AGE_DAYS=30)。函数以动词开头(cleanup_old_logs),每个函数顶部写明作用、输入参数、返回含义,并优先使用 local 声明局部变量。

FakeYou
FakeYou

FakeYou是一款AI音频处理工具,Deep Fake文本转语音。

下载
  • 避免全局污染:函数里不要直接改 PATH 或 IFS,要用就先保存后恢复
  • 数组遍历必须用 "${array[@]}",否则含空格的元素会断开
  • 临时文件用 mktemp 创建,退出前用 trap 清理

结构清晰比技巧炫酷更重要

把逻辑拆成独立函数,主流程只留调用顺序。不用堆在 main 里写几十行 if-else。缩进统一用 4 个空格,每行不超过 80 字符,管道符 | 和逻辑运算符后换行并缩进一层。条件判断统一用 [[ ]],不混用 [ ] 或 test。

  • 启用严格模式:set -euo pipefail,未定义变量、命令失败、管道任一环节出错都立即终止
  • 错误处理不靠运气:关键命令后加 || die "无法连接数据库",die 函数统一输出错误并退出
  • 日志分级输出:log_info、log_warn、log_error,不混用 echo

工程化从文件管理和权限开始

脚本命名用蛇形小写加 .sh 后缀(rotate_nginx_logs.sh),不带空格或大写字母。文件编码为 UTF-8,权限设为 755(chmod 755 rotate_nginx_logs.sh)。配置项尽量抽到外部文件或环境变量中,脚本本身只负责逻辑。

  • 不同环境用不同配置:生产环境走 /etc/rotate.conf,开发环境走 ./config/dev.conf
  • 版本控制别忽略:脚本进 Git,但敏感配置(如密码)不提交,用占位符 + 部署时注入
  • 上线前跑一遍 shellcheck -s bash script.sh,自动发现常见陷阱

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

shell脚本

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.06.21

4130

4

如何安装LINUX
如何安装LINUX

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

2023.06.29

3513

10

linux find
linux find

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

2023.06.30

2713

5

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

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

2023.07.05

6630

7

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

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

2023.07.06

6282

7

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

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

2023.07.20

3633

8

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

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

2023.07.20

3125

4

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

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

2023.07.25

3359

6

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

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

2023.07.31

297

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
尚观shell视频教程
尚观shell视频教程

共8课时 | 1.9万人学习

Linux开发视频教程
Linux开发视频教程

共18课时 | 4.6万人学习

Perl 入门教程
Perl 入门教程

共29课时 | 31.4万人学习