0

0

LinuxShell脚本规范建议_可维护性提升说明【指导】

冷漠man

冷漠man

发布时间:2026-01-01 15:23:02

|

972人浏览过

|

来源于php中文网

原创

脚本应以 #!/usr/bin/env bash 开头并启用 set -euo pipefail 和 export LANG=C.UTF-8;变量须区分全局(全大写+前缀+readonly)与局部(local 显式声明);参数解析必须用 getopts;路径拼接需防御性处理,文件操作前须校验存在性并支持 dry-run。

linuxshell脚本规范建议_可维护性提升说明【指导】

脚本开头必须声明解释器和编码

不加 #!/bin/bash 或写成 #!/bin/sh 却用了 Bash 特性(比如数组、[[),会导致在不同系统上行为不一致。CentOS 默认 /bin/sh 是 dash,Ubuntu 可能是 dash 或 bash,行为差异直接引发静默失败。

  • 统一用 #!/usr/bin/env bash:兼容不同安装路径,且明确启用 Bash 模式
  • 加上 set -euo pipefail:让脚本在变量未定义、命令失败、管道任一环节出错时立即退出
  • 显式声明 UTF-8:export LANG=C.UTF-8,避免 locale 相关的字符串比较或文件名处理异常

变量命名与作用域要严格区分

全局变量全大写加前缀(如 MYAPP_CONFIG_DIR),局部变量一律小写且用 local 显式声明——否则函数内赋值会污染全局,调试时极难定位。

  • 禁止裸写 CONFIG_PATH="/etc/myapp";应写成 readonly MYAPP_CONFIG_PATH="/etc/myapp"
  • 函数内所有非返回值变量必须加 local,包括循环变量:for local file in "${files[@]}"; do ...
  • 避免用 $1$2 直接逻辑判断;先赋给具名变量:readonly input_file="$1",便于阅读和后续加校验

参数解析必须用 getopts 而非手工切分

手写 if [[ "" == "-v" ]] 看似简单,但无法处理 -vf config.yml 这类连写选项,也不支持长选项(--verbose)、必需参数绑定、自动 help 输出。

boardmix博思白板
boardmix博思白板

boardmix博思白板,一个点燃团队协作和激发创意的空间,集aigc,一键PPT,思维导图,笔记文档多种创意表达能力于一体,将团队工作效率提升到新的层次。

下载
  • getopts 是 POSIX 标准工具,无需额外依赖,足够覆盖 95% 场景
  • 短选项后跟 : 表示该选项需要参数,例如 getopts "f:v" optf: 表示 -f FILEv 是开关型
  • 错误处理要主动:当 getopts 返回非零时,应调用自定义 usage 函数并 exit 1,而不是默认忽略
while getopts "f:v" opt; do
  case $opt in
    f) readonly INPUT_FILE="$OPTARG" ;;
    v) readonly VERBOSE=1 ;;
    *) usage; exit 1 ;;
  esac
done

路径拼接和文件操作必须防御性处理

硬编码路径、忽略空格、不检查文件是否存在,是运维脚本最常导致“线上炸掉”的三连击。尤其当路径来自变量或用户输入时,"$DIR/$FILE"$DIR 末尾有斜杠、$FILE 开头有斜杠时,会意外变成双斜杠甚至覆盖上级目录。

  • realpathdirname "$(realpath "$0") 获取脚本真实路径,避免软链接执行时的路径错乱
  • 拼接前统一清理斜杠:full_path="${INSTALL_DIR%/}/${subdir#/}"%/ 去尾部斜杠,#/ 去开头斜杠
  • 所有 rmcpmv 前加 [[ -e "$target" ]] && echo "will remove: $target" 日志,生产环境建议默认禁用自动删除,改用 --dry-run 模式
真正难的不是写出能跑的 Shell 脚本,而是三个月后别人(或你自己)还能看懂它为什么删了那个配置文件、为什么在某台机器上跳过了某个步骤——所有看似“多此一举”的声明、校验和路径处理,都是在为下次凌晨三点的故障排查省下两小时。

相关专题

更多
if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

713

2023.08.22

全局变量怎么定义
全局变量怎么定义

本专题整合了全局变量相关内容,阅读专题下面的文章了解更多详细内容。

73

2025.09.18

python 全局变量
python 全局变量

本专题整合了python中全局变量定义相关教程,阅读专题下面的文章了解更多详细内容。

96

2025.09.18

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

248

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

205

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1435

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

609

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

547

2024.03.22

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

61

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 6.4万人学习

Git 教程
Git 教程

共21课时 | 2.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号