【Linux】Shell 编程规范及检查工具推荐

以下是重新整理后的内容，希望能对您有所帮助。如果您觉得有用，欢迎点赞、关注和转发！如果有其他问题或想要了解的内容，欢迎私信联系我～

基本介绍

1、Shell 编程

Shell 编程涉及使用 Shell 命令作为程序语言，设计、编写、测试和维护脚本型程序的过程。Shell 命令是实现 Shell 编程的基本语句和方法，而 Shell 脚本则是这种编程的最终产物。

Shell 编程还包括以下几个方面：

• 对 Shell 环境的理解
• 对变量和函数的使用
• 对条件语句、循环控制语句等复杂逻辑的应用
• 对程序错误的处理和调试技巧

2、Shell 脚本

Shell 脚本可以视为一系列按照特定逻辑顺序执行的 Shell 命令集合。这些脚本既可以包含简单操作命令（如 cd、cp、mv 等），也可以包含复杂逻辑区块（如条件语句、循环语句、函数等）。Shell 脚本是一种不需要编译的解释性程序，具有编写迅速、测试方便的优点，帮助运维工程师简化研发流程并提高工作效率。

Shell 脚本主要用于在类 Unix 系统（如 Linux、macOS 等）中执行以下任务：

• 执行批处理任务：例如批量安装软件、生成系统配置等
• 实现自动化过程：例如自动处理大量文本内容、自动备份数据等
• 管理操作系统：例如监控系统资源、与调度工具（如 Crontab）结合定期执行任务等

虽然 Shell 编程在与其他主流编程语言相比可能显得较为简陋，但编程的核心思想应是一致的。为了避免异常问题、便于他人阅读和管理，构建 Shell 脚本时应遵循一定的编程规范。

本文总结了 20 多条常用编程规范，并推荐一种 Shell 脚本检查工具，帮助大家养成良好的 Shell 编程习惯。

编程规范

• 建议在创建 Shell 脚本时，以 .sh 作为文件名后缀，以便于识别文件类型。
• 建议为 Shell 脚本赋予适当的执行权限，以便以 ./xxx.sh 的形式运行脚本；若未赋予执行权限，只能以 /bin/bash xxx.sh 的形式运行，并且非 root 用户需要加上 sudo。
• 建议在 Shell 脚本开头使用 #! 指定命令行解释器（如 #!/bin/bash）。
• 建议在 Shell 脚本结尾使用 main "$@" 指定程序的入口，增强脚本的结构化程度。
• 建议在 Shell 脚本中通过 (cd dirname $0;pwd) 获取当前脚本的路径，并以此为基准查找其他路径。
• 建议在 Shell 脚本内容中多使用 # 标注注释，充分解释脚本语句或逻辑区块的用途和注意事项，方便自己和他人阅读，提高理解效率。
• 建议对传入 Shell 脚本的参数进行检查（如判断个数是否符合预设），避免脚本运行异常。
• 建议 Shell 变量的名称尽量直观易理解且风格统一，可以使用驼峰型或下划线分隔单词等形式。
• 建议充分考虑环境变量、局部变量在不同 Shell（父 Shell、子 Shell）下的作用域，确保其在被引用时能够生效。
• 建议在 Shell 脚本中引用 Shell 变量时，尽量采用双引号。
• 建议在 Shell 脚本中将多次出现的常量统一赋值给一个变量，方便在常量发生变化后快速修改，提高脚本的可配置能力。
• 建议在 Shell 脚本中养成良好的缩进习惯，使脚本内容具有清晰易读的层级结构，有助于避免将直接执行的命令与函数体搞混。
• 建议在 Shell 脚本中为关键命令语句的输出添加回显或将其重定向至日志文件，方便在脚本运行出现异常时进行排查和调试；回显可以通过 echo -e "\033[2;32m xxxxxxx \033[0m" 命令设置颜色、高亮等特效，提升输出效果。
• 建议在 Shell 脚本中使用 >/dev/null 过滤不友好的输出信息，避免因无用信息过多而漏掉重要信息。
• 建议在 Shell 脚本中使用绝对路径，避免使用相对路径，否则需要注意目录的切换。
• 建议在 Shell 脚本中通过命令语句的返回值 ? 判断命令语句是否执行成功，? 为 0 时表示执行没有错误。
• 建议在 Shell 脚本中处理文件前判断文件是否存在，并做好异常处理。
• 建议在 Shell 脚本中使用 [[ ]] 代替 [ ]。
• 建议在 Shell 脚本中使用 && 和 || 写成单行形式，替代简单的 if 语句，如用 [[ x > 2 ]] && echo x 替代 if x >2 ;then echo x，以提升执行效率和阅读体验。
• 建议在 Shell 脚本中使用 function func() {} 形式来定义函数，而不是 function func {} 形式。
• 建议在 Shell 脚本中使用 $(命令) 的形式，将命令的结果赋给变量，而不是 命令 形式。
• 建议在 Shell 脚本中使用 Shell 变量替换语句，代替 awk、sed 语句处理字符串。
• 建议在 Shell 脚本中复制文件夹时使用 cp -r 命令，如果目标文件夹不存在则创建，如果存在则复制为子文件夹。
• 建议在 Shell 脚本中尽量不要处理 ls 后的数据，如 for i in $(ls)，因为 ls 的结果非常不确定并且与平台有关。
• 建议在 Shell 脚本中尝试使用 trap 捕获异常信号，并在接收到终止信号时执行一些收尾工作。
• 建议在 Shell 脚本中不要记录密码、密钥等敏感信息。
• 建议在 Shell 脚本中出现长命令时，通过反斜杠 \ 进行分行，以提升阅读体验。
• 建议在 Shell 脚本中尽量使用精简命令，如采用单条命令代替多条命令或管道命令，提升脚本运行效率。
• 建议在 Shell 脚本中存在可以同时执行、互不关联的命令时，采用 & 和 wait 方式实现并发，提升脚本运行效率。
• 建议在 Shell 脚本中采用 cat>> filename > filename 方式逐行写入。

检查工具推荐

1、ShellCheck 简介

豆包AI编程

豆包推出的AI编程助手

483

查看详情

ShellCheck 是一种静态分析工具，专门用于分析 Shell 脚本。它的强大之处在于不仅能够识别 Shell 脚本中存在的问题，还能提供清晰、有效的改进建议，帮助开发者快速定位并修复这些问题，从而提高 Shell 脚本的编写质量和维护效率。

ShellCheck 能够识别的问题包括但不限于：

• 语法错误
• 逻辑漏洞
• 代码风格问题
• 潜在的安全风险

2、ShellCheck 使用

方式一：在线检查

ShellCheck 在线服务地址：https://www.php.cn/link/40547606fba6796b5cded9cf8f7b6062

访问 ShellCheck 在线服务，粘贴 Shell 脚本内容即可开始自动检查，并输出检查结果。

方式二：本地安装后检查

安装方法如下：

# CentOS 系统
yum install -y ShellCheck
<h1>Ubuntu 系统</h1><p>apt install -y shellcheck

使用方法如下：

shellcheck xxx.sh

以上就是【Linux】Shell 编程规范及检查工具推荐的详细内容，更多请关注php中文网其它相关文章！