Linux Shell 脚本编程最佳实践

IT路边社

前言

与其它的编码规范一样，这里所讨论的不仅仅是编码格式美不美观的问题， 同时也讨论一些约定及编码标准。这份文档主要侧重于我们所普遍遵循的规则，对于那些不是明确强制要求的，我们尽量避免提供意见。

编码规范对于程序员而言尤为重要，有以下几个原因：

本文档中的准则致力于最大限度达到以下原则：

尽管本文档涵盖了许多基础知识，但应注意的是，没有编码规范可以为我们回答所有问题，开发人员始终需要再编写完代码后，对上述原则做出正确的判断。

注 ：未明确指明的则默认为必须（Mandatory）

主要参考如下文档:

仅建议Shell用作相对简单的实用工具或者包装脚本。因此单个shell脚本内容不宜太过复杂。

在选择何时使用shell脚本时时应遵循以下原则：

可执行文件不建议有扩展名，库文件必须使用 .sh 作为扩展名，且应是不可执行的。

执行一个程序时，无需知道其编写语言，且shell脚本并不要求具有扩展名，所以更倾向可执行文件没有扩展名。

而库文件知道其编写语言十分重要，使用 .sh 作为特定语言后缀的扩展名，可以和其他语言编写的库文件加以区分。

文件名要求全部小写, 可以包含下划线 _ 或连字符 - , 建议可执行文件使用连字符，库文件使用下划线。

正例:

反例：

源文件编码格式为UTF-8。避免不同 *** 作系统对文件换行处理的方式不同，一律使用 LF 。

每行最多不超过120个字符。每行代码最大长度限制的根本原因是过长的行会导致阅读障碍，使得缩进失效。

除了以下两种情况例外：

如出现长度必须超过120个字符的字符串，应尽量使用here document或者嵌入的换行符等合适的方法使其变短。

示例：

除了在行结束使用换行符，空格是源文件中唯一允许出现的空白字符。

对从来没有用到的或者被注释的方法、变量等要坚决从代码中清理出去，避免过多垃圾造成干扰。

Bash 是唯一被允许使用的可执行脚本shell。

可执行文件必须以 #!/bin/bash 开始。请使用 set 来设置shell的选项，使得用 bash echo "Process $: Done making $$$."

# 示例7：命令参数及路径不需要引号 grep -li Hugo /dev/ "$1"

# 示例8：常规变量用双引号，ccs可能为空的特殊情况可不用引号 git send-email --to "${reviewers}" ${ccs:+"--cc" "${ccs}"}

# 示例9：正则用单引号，$1可能为空的特殊情况可不用引号 grep -cP '([Ss]pecial||?characters*) ${1:+"$1"}

# 示例10：位置参数传递推荐带引号的"$@"，所有参数作为单字符串传递用带引号的"$*" # content of t.sh func_t { echo num: $# echo args: 1:$1 2:$2 3:$3 }

func_t "$@" func_t "$*" # 当执行 ./t.sh a b c 时输出如下： num: 3 args: 1:a 2:b 3:c num: 1 args: 1:a b c 2: 3:

使用 $(command) 而不是反引号。

因反引号如果要嵌套则要求用反斜杠转义内部的反引号。而 $(command) 形式的嵌套无需转义，且可读性更高。

正例：

反例：

条件测试

使用 [[ ... ]] ，而不是 [ , test , 和 /usr/bin/[ 。

因为在 [[ 和 ]] 之间不会出现路径扩展或单词切分，所以使用 [[ ... ]] 能够减少犯错。且 [[ ... ]] 支持正则表达式匹配，而 [ ... ] 不支持。参考以下示例：

尽可能使用变量引用，而非字符串过滤。

Bash可以很好的处理空字符串测试，请使用空/非空字符串测试方法，而不是过滤字符，让代码具有更高的可读性。正例：

反例：

正例：

反例：

正例：

反例：

文件名扩展

当进行文件名的通配符扩展时，请指定明确的路径。

当目录中有特殊文件名如以 - 开头的文件时，使用带路径的扩展通配符 ./* 比不带路径的 * 要安全很多。

应该避免使用eval。

Eval在用于分配变量时会修改输入内容，但设置变量的同时并不能检查这些变量是什么。反例：

请使用进程替换或者for循环，而不是通过管道连接while循环。

这是因为在管道之后的while循环中，命令是在一个子shell中运行的，因此对变量的修改是不能传递给父shell的。

这种管道连接while循环中的隐式子shell使得bug定位非常困难。反例：

如果你确定输入中不包含空格或者其他特殊符号（通常不是来自用户输入），则可以用for循环代替。例如：

使用进程替换可实现重定向输出，但是请将命令放入显式子 shell，而非 while 循环创建的隐式子 shell。例如：

总是检查返回值，且提供有用的返回值。

对于非管道命令，使用 $? 或直接通过 if 语句来检查以保持其简洁。

例如：

当内建命令可以完成相同的任务时，在shell内建命令和调用外部命令之间，应尽量选择内建命令。

因内建命令相比外部命令而言会产生更少的依赖，且多数情况调用内建命令比调用外部命令可以获得更好的性能（通常外部命令会产生额外的进程开销）。

正例：

反例：

加载外部库文件不建议用使用.，建议使用source，已提升可阅读性。正例：

反例：

除非必要情况，尽量使用单个命令及其参数组合来完成一项任务，而非多个命令加上管道的不必要组合。常见的不建议的用法例如：cat和grep连用过滤字符串cat和wc连用统计行数grep和wc连用统计行数等。

正例：

除特殊情况外，几乎所有函数都不应该使用exit直接退出脚本，而应该使用return进行返回，以便后续逻辑中可以对错误进行处理。正例：

反例：

推荐以下工具帮助我们进行代码的规范：

原文链接：http://itxx00.github.io/blog/2020/01/03/shell-standards/

获取更多的面试题、脚本等运维资料点击: 运维知识社区 获取

脚本之---短信轰炸机

脚本之---QQ微信轰炸机

ansible---一键搭建redis5.0.5集群

elk7.9真集群docker部署文档

全球最全loki部署及配置文档

最强安全加固脚本2.0

一键设置iptbales脚本

本人主要用shell,结合工作经验，给出如下常用功能：

1.制作定时任务，可以获得系统状态，然后截取系统状态，发送至故障监控平台或短信平台，实现故障的自动预警。

2.提取数据，形成文本，处理文本，得到规格化的数据，提供给相关部门使用。

3.制作shell交互式菜单，提供给其他运维值班人员使用，用以手工监控系统各种状态

4.版本升级、系统变更等 *** 作需要使用。

Linux运维人员必会的120个命令

跟老男孩学Linux运维：核心系统命令实战

前言

第1章 Linux命令行简介 / 1

1.1Linux命令行概述 / 1

1.2在Linux命令行下查看命令帮助 / 4

1.3Linux shutdown reboot halt / 9

关机：

shutdown -h now

halt

init 0

第2章 文件和目录 *** 作命令 / 13

2.1pwd：显示当前所在的位置 / 13

2.2cd：切换目录 / 16

2.3tree：以树形结构显示目录下的内容 / 18

2.4mkdir：创建目录 / 22

2.5touch：创建空文件或改变文件的时间戳属性 / 27

2.6ls：显示目录下的内容及相关属性信息 / 30

2.7cp：复制文件或目录 / 39

2.8mv：移动或重命名文件 / 42

2.9rm：删除文件或目录 / 45

2.10rmdir：删除空目录 / 48

2.11ln：硬链接与软链接 / 49

2.12readlink：查看符号链接文件的内容 / 54

2.13find：查找目录下的文件 / 55

2.14xargs：将标准输入转换成命令行参数 / 68

2.15rename：重命名文件 / 71

2.16basename：显示文件名或目录名 / 72

2.17dirname：显示文件或目录路径 / 72

2.18chattr：改变文件的扩展属性 / 73

2.19lsattr：查看文件扩展属性 / 75

2.20file：显示文件的类型 / 76

2.21md5sum：计算和校验文件的MD5值 / 77

2.22chown：改变文件或目录的用户和用户组 / 80

2.23chmod：改变文件或目录权限 / 81

2.24chgrp：更改文件用户组 / 85

2.25umask：显示或设置权限掩码 / 86

2.26老男孩从新手成为技术大牛的心法 / 90

第3章 文件过滤及内容编辑处理命令 / 91

3.1cat：合并文件或查看文件内容 / 91

3.2tac：反向显示文件内容 / 103

3.3more：分页显示文件内容 / 104

3.4less：分页显示文件内容 / 107

3.5head：显示文件内容头部 / 109

3.6tail：显示文件内容尾部 / 111

3.7tailf：跟踪日志文件 / 114

3.8cut：从文本中提取一段文字并输出 / 115

3.9split：分割文件 / 117

3.10paste：合并文件 / 118

3.11sort：文本排序 / 123

3.12join：按两个文件的相同字段合并 / 127

3.13uniq：去除重复行 / 129

3.14wc：统计文件的行数、单词数或字节数 / 131

3.15iconv：转换文件的编码格式 / 133

3.16dos2unix：将DOS格式文件转换成UNIX格式 / 134

3.17diff：比较两个文件的不同 / 135

3.18vimdiff：可视化比较工具 / 138

3.19rev：反向输出文件内容 / 139

3.20tr：替换或删除字符 / 140

3.21od：按不同进制显示文件 / 143

3.22tee：多重定向 / 145

3.23vi/vim：纯文本编辑器 / 147

3.24老男孩逆袭思想：做Linux运维的多个好处 / 152

第4章 文本处理三剑客 / 153

4.1grep：文本过滤工具 / 153

4.2sed：字符流编辑器 / 159

4.3awk基础入门 / 165

第5章 Linux信息显示与搜索文件命令 / 176

5.1uname：显示系统信息 / 176

5.2hostname：显示或设置系统的主机名 / 178

5.3dmesg：系统启动异常诊断 / 179

5.4stat：显示文件或文件系统状态 / 181

5.5du：统计磁盘空间使用情况 / 183

5.6date：显示与设置系统时间 / 186

5.7echo：显示一行文本 / 190

5.8watch：监视命令执行情况 / 193

5.9which：显示命令的全路径 / 195

5.10whereis：显示命令及其相关文件全路径 / 196

5.11locate：快速定位文件路径 / 197

5.12updatedb：更新mlocate数据库 / 199

5.13老男孩逆袭思想：新手在工作中如何问问题不会被鄙视 / 200

第6章 文件备份与压缩命令 / 201

6.1tar：打包备份 / 201

6.2gzip：压缩或解压文件 / 208

6.3zip：打包和压缩文件 / 211

6.4unzip：解压zip文件 / 212

6.5scp：远程文件复制 / 214

6.6rsync：文件同步工具 / 216

6.7老男孩逆袭思想：新手如何高效地提问 / 220

第7章 Linux用户管理及用户信息查询命令 / 222

7.1 useradd：创建用户 / 222

7.2usermod：修改用户信息 / 227

7.3userdel：删除用户 / 229

7.4groupadd：创建新的用户组 / 230

7.5groupdel：删除用户组 / 231

7.6passwd：修改用户密码 / 232

7.7chage:修改用户密码有效期 / 237

7.8chpasswd：批量更新用户密码 / 238

7.9su：切换用户 / 240

7.10visudo：编辑sudoers文件 / 242

7.11sudo：以另一个用户身份执行命令 / 244

7.12id：显示用户与用户组的信息 / 248

7.13w：显示已登录用户信息 / 249

7.14who：显示已登录用户信息 / 250

7.15users：显示已登录用户 / 252

7.16whoami：显示当前登录的用户名 / 253

7.17last：显示用户登录列表 / 253

7.18lastb：显示用户登录失败的记录 / 254

7.19lastlog：显示所有用户的最近登录记录 / 255

第8章 Linux磁盘与文件系统管理命令 / 257

8.1fdisk：磁盘分区工具 / 257

8.2partprobe：更新内核的硬盘分区表信息 / 265

8.3tune2fs：调整ext2/ext3/ext4文件系统参数 / 266

8.4parted：磁盘分区工具 / 268

8.5mkfs：创建Linux文件系统 / 272

8.6dumpe2fs：导出ext2/ext3/ext4文件系统信息 / 274

8.7resize2fs：调整ext2/ext3/ext4文件系统大小 / 275

8.8fsck：检查并修复Linux文件系统 / 278

8.9dd：转换或复制文件 / 281

8.10mount：挂载文件系统 / 284

8.11umount：卸载文件系统 / 288

8.12df：报告文件系统磁盘空间的使用情况 / 289

8.13mkswap：创建交换分区 / 293

8.14swapon：激活交换分区 / 294

8.15swapoff：关闭交换分区 / 295

8.16sync：刷新文件系统缓冲区 / 296

第9章 Linux进程管理命令 / 298

9.1ps：查看进程 / 298

9.2pstree：显示进程状态树 / 305

9.3pgrep：查找匹配条件的进程 / 306

9.4kill：终止进程 / 307

9.5killall：通过进程名终止进程 / 310

9.6pkill：通过进程名终止进程 / 311

9.7top：实时显示系统中各个进程的资源占用状况 / 313

9.8nice：调整程序运行时的优先级 / 320

9.9renice：调整运行中的进程的优先级 / 323

9.10nohup：用户退出系统进程继续工作 / 324

9.11strace：跟踪进程的系统调用 / 325

9.12ltrace：跟踪进程调用库函数 / 332

9.13runlevel：输出当前运行级别 / 334

9.14init：初始化Linux进程 / 335

9.15service：管理系统服务 / 335

第10章 Linux网络管理命令 / 338

10.1ifconfig：配置或显示网络接口信息 / 338

10.2ifup：激活网络接口 / 343

ifup eth0

10.3ifdown：禁用网络接口 / 343

ifdown eth0

service network restart（/etc/init.d/network restart） 激活整个网络，所有网卡。

10.4route：显示或管理路由表 / 344

10.5arp：管理系统的arp缓存 / 350

10.6ip：网络配置工具 / 351

10.7netstat：查看网络状态 / 358

10.8ss：查看网络状态 / 362

10.9ping：测试主机之间网络的连通性 / 363

10.10traceroute：追踪数据传输路由状况 / 366

10.11arping：发送arp请求 / 367

10.12telnet：远程登录主机 / 369

10.13nc：多功能网络工具 / 370

10.14ssh：安全地远程登录主机 / 373

10.15wget：命令行下载工具 / 376

10.16mailq：显示邮件传输队列 / 379

10.17mail：发送和接收邮件 / 381

10.18nslookup：域名查询工具 / 386

10.19dig：域名查询工具 / 389

10.20host：域名查询工具 / 393

10.21nmap：网络探测工具和安全/端口扫描器 / 394

10.22tcpdump：监听网络流量 / 398

第11章 Linux系统管理命令 / 407

11.1lsof：查看进程打开的文件 / 407

11.2uptime：显示系统的运行时间及负载 / 411

11.3free：查看系统内存信息 / 411

11.4iftop：动态显示网络接口流量信息 / 413

11.5vmstat：虚拟内存统计 / 415

11.6mpstat：CPU信息统计 / 419

11.7iostat：I/O信息统计 / 420

11.8iotop：动态显示磁盘I/O统计信息 / 423

11.9sar：收集系统信息 / 425

11.10chkconfig：管理开机服务 / 430

11.11ntsysv：管理开机服务 / 433

11.12 setup：系统管理工具 / 434

11.13ethtool：查询网卡参数 / 436

11.14mii-tool：管理网络接口的状态 / 437

11.19rpm：RPM包管理器 / 443

11.20yum：自动化RPM包管理工具 / 446

top命令

第12章 Linux系统常用内置命令 / 450

12.1Linux内置命令概述 / 450

12.2Linux内置命令简介 / 450

12.3Linux常用内置命令实例 / 452

---