编写 Shell 脚本的最佳实践

转载自:https://blog.mythsman.com/post/5d2ab67ff678ba2eb3bd346f/

开头有 “蛇棒”

所谓 shebang 其实就是在很多脚本的第一行出现的以 "#!" 开头的注释,他指明了当我们没有指定解释器的时候默认的解释器,一般可能是下面这样:

#!/bin/bash

当然,解释器有很多种,除了 bash 之外,我们可以用下面的命令查看本机支持的解释器:

$ cat /etc/shells

/bin/sh
/bin/dash
/bin/bash
/bin/rbash
/usr/bin/screen

当我们直接使用./a.sh来执行这个脚本的时候,如果没有 shebang,那么它就会默认用$SHELL指定的解释器,否则就会用 shebang 指定的解释器。
不过,上面这种写法可能不太具备适应性,一般我们会用下面的方式来指定:

#!/usr/bin/env bash

这种方式是我们推荐的使用方式。

代码有注释

注释,显然是一个常识,不过这里还是要再强调一下,这个在 shell 脚本里尤为重要。因为很多单行的 shell 命令不是那么浅显易懂,没有注释的话在维护起来会让人尤其的头大。
注释的意义不仅在于解释用途,而在于告诉我们注意事项,就像是一个 README。
具体的来说,对于 shell 脚本,注释一般包括下面几个部分:

  1. shebang

  2. 脚本的参数

  3. 脚本的用途

  4. 脚本的注意事项

  5. 脚本的写作时间,作者,版权等

  6. 各个函数前的说明注释

  7. 一些较复杂的单行命令注释

参数要规范

这一点很重要,当我们的脚本需要接受参数的时候,我们一定要先判断参数是否合乎规范,并给出合适的回显,方便使用者了解参数的使用。
最少,最少,我们至少得判断下参数的个数吧:

if [[ $# != 2 ]];then
    echo "Parameter incorrect."
    exit 1
fi

变量和魔数

一般情况下我们会将一些重要的环境变量定义在开头,确保这些变量的存在。

source /etc/profile
export PATH=”/usr/local/bin:/usr/bin:/bin:/usr/local/sbin:/usr/sbin:/sbin:/apps/bin/”

这种定义方式有一个很常见的用途,最典型的应用就是,当我们本地安装了很多 java 版本时,我们可能需要指定一个 java 来用。那么这时我们就会在脚本开头重新定义JAVA_HOME以及PATH变量来进行控制。

同时,一段好的代码通常是不会有很多硬编码在代码里的 “魔数” 的。如果一定要有,通常是用一个变量的形式定义在开头,然后调用的时候直接调用这个变量,这样方便日后的修改。

缩进有规矩

对于 shell 脚本,缩进是个大问题。因为很多需要缩进的地方 (比如 if,for 语句) 都不长,所有很多人都懒得去缩进,而且很多人不习惯用函数,导致缩进功能被弱化。
其实正确的缩进是很重要的,尤其是在写函数的时候,否则我们在阅读的时候很容易把函数体跟直接执行的命令搞混。
常见的缩进方法主要有 "soft tab" 和 "hard tab" 两种。

  • 所谓 soft tab 就是使用 n 个空格进行缩进 (n 通常是 2 或 4)

  • 所谓 hard tab 当然就是指真实的 "\t" 字符
    这里不去撕哪种方式最好,只能说各有各的优劣。反正我习惯用 hard tab。
    对于 if 和 for 语句之类的,我们最好不要把 then,do 这些关键字单独写一行,这样看上去比较丑。。。

命名有标准

所谓命名规范,基本包含下面这几点:

  1. 文件名规范,以. sh 结尾,方便识别

  2. 变量名字要有含义,不要拼错

  3. 统一命名风格,写 shell 一般用小写字母加下划线

编码要统一

在写脚本的时候尽量使用 UTF-8 编码,能够支持中文等一些奇奇怪怪的字符。不过虽然能写中文,但是在写注释以及打 log 的时候还是尽量英文,毕竟很多机器还是没有直接支持中文的,打出来可能会有乱码。
这里还尤其需要注意一点,就是当我们是在 windows 下用 utf-8 编码来写 shell 脚本的时候,一定要注意这个 utf-8 是否是有 BOM 的。默认情况下 windows 判断 utf-8 格式是通过在文件开头加上三个 EF BB BF 字节来判断的,但是在 Linux 中默认是无 BOM 的。因此如果我们是在 windows 下写脚本的时候,一定要注意将编码改成 Utf-8 无 BOM,一般用 notepad++ 之类的编辑器都能改。否则,在 Linux 下运行的时候就会识别到开头的三个字符,从而报一些无法识别命令的错。
当然,对于跨平台写脚本还有一个比较常见的问题就是换行符不同。windows 默认是 \ r\n 而 unix 下是 \ n。不过有两个小工具可以非常方便的解决这个问题: dos2unix,unix2dos。

权限记得加

这一点虽然很小,但是我个人却经常忘记,不加执行权限会导致无法直接执行,有点讨厌。。。

日志和回显

日志的重要性不必多说,能够方便我们回头纠错,在大型的项目里是非常重要的。
如果这个脚本是供用户直接在命令行使用的,那么我们最好还要能够在执行时实时回显执行过程,方便用户掌控。
有时候为了提高用户体验,我们会在回显中添加一些特效,比如颜色啊,闪烁啊之类的,具体可以参考 ANSI/VT100 Control sequences 这篇文章的介绍。

密码要移除

不要把密码硬编码在脚本里,不要把密码硬编码在脚本里,不要把密码硬编码在脚本里。
重要的事情说三遍,尤其是当脚本托管在类似 Github 这类平台中时。。。

太长要分行

在调用某些程序的时候,参数可能会很长,这时候为了保证较好的阅读体验,我们可以用反斜杠来分行:

./configure \
–prefix=/usr \
–sbin-path=/usr/sbin/nginx \
–conf-path=/etc/nginx/nginx.conf \

注意在反斜杠前有个空格。

代码有效率

在使用命令的时候要了解命令的具体做法,尤其当数据处理量大的时候,要时刻考虑该命令是否会影响效率。
比如下面的两个 sed 命令:

sed -n '1p' file
sed -n '1p;1q' file

他们的作用一样,都是获取文件的第一行。但是第一条命令会读取整个文件,而第二条命令只读取第一行。当文件很大的时候,仅仅是这样一条命令不一样就会造成巨大的效率差异。
当然,这里只是为了举一个例子,这个例子真正正确的用法应该是使用head -n1 file命令。。。

勤用双引号

几乎所有的大佬都推荐在使用 "$" 来获取变量的时候最好加上双引号。
不加上双引号在很多情况下都会造成很大的麻烦,为什么呢?举一个例子:

#!/bin/sh

var="*.sh"
echo $var
echo "$var"

他的运行结果如下:

a.sh
*.sh

为啥会这样呢?其实可以解释为他执行了下面的命令:

echo *.sh
echo "*.sh"

在很多情况下,在将变量作为参数的时候,一定要注意上面这一点,仔细体会其中的差异。上面只是一个非常小的例子,实际应用的时候由于这个细节导致的问题实在是太多了。。。

巧用 main 函数

我们知道,像 java,C 这样的编译型语言都会有一个函数入口,这种结构使得代码可读性很强,我们知道哪些直接执行,那些是函数。但是脚本不一样,脚本属于解释性语言,从第一行直接执行到最后一行,如果在这当中命令与函数糅杂在一起,那就非常难读了。
用 python 的朋友都知道,一个合乎标准的 python 脚本大体上至少是这样的:

def func1():
    pass

def func2():
    pass

if __name__=='__main__':
    func1()
    func2()

他用一个很巧妙的方法实现了我们习惯的 main 函数,使得代码可读性更强。
在 shell 中,我们也有类似的小技巧:

#!/usr/bin/env bash

func1(){
    
}

func2(){
    
}

main(){
    func1
    func2
}

main "$@"

我们可以采用这种写法,同样实现类似的 main 函数,使得脚本的结构化程度更好。

考虑作用域

shell 中默认的变量作用域都是全局的,比如下面的脚本:

#!/usr/bin/env bash

var=1
func(){
    var=2
}
func
echo $var

他的输出结果就是 2 而不是 1,这样显然不符合我们的编码习惯,很容易造成一些问题。
因此,相比直接使用全局变量,我们最好使用local readonly这类的命令,其次我们可以使用declare来声明变量。这些方式都比使用全局方式定义要好。

函数返回值

在使用函数的时候一定要注意,shell 中函数的返回值只能是整数,估计是因为一般情况下一个函数的返回值通常表示这个函数的运行状态,所以一般都是 0 或者是1就够了,因此就设计成了这样。不过,如果非得想传递字符串,也可以通过下面变通的方法:

func(){
    echo "2333"
}

res=$(func)
echo "This is from $res."

这样,通过 echo 或者 print 之类的就可以做到传一些额外参数的目的。

间接引用值

什么叫间接引用?比如下面这个场景:

VAR1="2323232"
VAR2="VAR1"

我们有一个变量 VAR1,又有一个变量 VAR2,这个 VAR2 的值是 VAR1 的名字,那么我们现在想通过 VAR2 来获取 VAR1 的值,这时候应该怎么办呢?
比较土鳖的方法是这样:

eval echo \$$VAR2

啥意思呢?其实就是构造了一个字符串 "echo $XXX",这个 XXX 就是 $VAR2 的值 VAR1,然后再用 eval 强制解析,这样就做到了变相取值。
这个用法的确可行,但是看起来十分的不舒服,很难直观的去理解,我们并不推荐。而且事实上我们本身就不推荐使用 eval 这个命令。
比较舒服的写法是下面这样:

echo ${!VAR1}

通过在变量名前加一个! 就可以做到简单的间接引用了。
不过需要注意的是,用上面的方法,我们只能够做到取值,而不能做到赋值。如果想要做到赋值,还要老老实实的用 eval 来处理:

VAR1=VAR2
eval $VAR1=233
echo $VAR2

巧用 heredocs

所谓 heredocs,也可以算是一种多行输入的方法,即在 "<<" 后定一个标识符,接着我们可以输入多行内容,直到再次遇到标识符为止。
使用 heredocs,我们可以非常方便的生成一些模板文件:

cat>>/etc/rsyncd.conf << EOF
log file = /usr/local/logs/rsyncd.log
transfer logging = yes
log format = %t %a %m %f %b
syslog facility = local3
EOF

学会查路径

很多情况下,我们会先获取当前脚本的路径,然后一这个路径为基准,去找其他的路径。通常我们是直接用pwd以期获得脚本的路径。
不过其实这样是不严谨的,pwd获得的是当前 shell 的执行路径,而不是当前脚本的执行路径。
正确的做法应该是下面这两种:

script_dir=$(cd $(dirname $0) && pwd)
script_dir=$(dirname $(readlink -f $0 ))

应当先 cd 进当前脚本的目录然后再 pwd,或者直接读取当前脚本的所在路径。

代码要简短

这里的简短不单单是指代码长度,而是只用到的命令数。原则上我们应当做到,能一条命令解决的问题绝不用两条命令解决。这不仅牵涉到代码的可读性,而且也关乎代码的执行效率。
最最经典的例子如下:

cat /etc/passwd | grep root
grep root /etc/passwd

cat 命令最为人不齿的用法就是这样,用的没有任何意义,明明一条命令可以解决,他非得加根管道。。。
其实代码简短在还能某种程度上能保证效率的提升,比如下面的例子:

find . -name '*.txt' |xargs sed -i s/233/666/g
find . -name '*.txt' |xargs sed -i s/235/626/g
find . -name '*.txt' |xargs sed -i s/333/616/g
find . -name '*.txt' |xargs sed -i s/233/664/g
find . -name '*.txt' |xargs sed -i "s/233/666/g;s/235/626/g;s/333/616/g;s/233/664/g"

这两种方法做的事情都一样,就是查找所有的. txt 后缀的文件并做一系列替换。前者是多次执行 find,后者是执行一次 find,但是增加了 sed 的模式串。第一种更直观一点,但是当替换的量变大的时候,第二种的速度就会比第一种快很多。这里效率提升的原因,就是第二种只要执行一次命令,而第一种要执行多次。
并且,巧用 xargs 命令,我们还可以十分方便的进行并行化处理:

find . -name '*.txt' |xargs -P $(nproc) sed -i "s/233/666/g;s/235/626/g;s/333/616/g;s/233/664/g"

通过 - P 参数指定并行度,可以进一步加快执行效率。

命令并行化

当我们需要充分考虑执行效率时,我们可能需要在执行命令的时候考虑并行化。shell 中最简单的并行化是通过 "&" 以及 "wait" 命令来做:

func(){
    
}
for((i=0;i<10;i++))do
    func &
done
wait

当然,这里并行的次数不能太多,否则机器会卡死。稍微正确的做法比较复杂,以后再讨论,如果图省事可以使用 parallel 命令来做,或者是用上面提到的 xargs 来处理。

全文本检索

我们知道,当我们想在文件夹下所有的 txt 文件中检索某一个字符串 (比如 233) 的时候,我们可能会用类似这样的命令:

find . -name '*.txt' -type f | xargs grep 2333

很多情况下,这个命令会想我们所想的找到对应的匹配行,但是我们需要注意两个小问题。
find 命令会符合要求的匹配文件名,但是如果文件名包含空格,这时候将文件名传给 grep 的时候就会有问题,这个文件就会被当成两个参数,这时候就要加一层处理,保证用空格分开的文件名不会被当成两个参数:

find . -type f|xargs -i echo '"{}"'|xargs grep 2333

有时候,文件的字符集可能跟终端的字符集不一致,这时候就会导致 grep 在搜索时将文件当成二进制文件从而报binary file matches之类的问题。这时候要么用 iconv 之类的字符集转换工具将字符集进行切换,要么就在不影响查找的情况下对 grep 加 - a 参数,将所有文件看成文本文件:

find . -type f|xargs grep -a 2333

使用新写法

这里的新写法不是指有多厉害,而是指我们可能更希望使用较新引入的一些语法,更多是偏向代码风格的,比如

  1. 尽量使用func(){}来定义函数,而不是func{}

  2. 尽量使用[[]]来代替[]

  3. 尽量使用$()将命令的结果赋给变量,而不是反引号

  4. 在复杂的场景下尽量使用 printf 代替 echo 进行回显

事实上,这些新写法很多功能都比旧的写法要强大,用的时候就知道了。

其他小 tip

考虑到还有很多零碎的点,就不一一展开了,这里简单提一提。

  • 路径尽量保持绝对路径,绝多路径不容易出错,如果非要用相对路径,最好用./ 修饰

  • 优先使用 bash 的变量替换代替 awk sed,这样更加简短

  • 简单的 if 尽量使用 && ||,写成单行。比如[[ x > 2]] && echo x

  • 当 export 变量时,尽量加上子脚本的 namespace,保证变量不冲突

  • 会使用 trap 捕获信号,并在接受到终止信号时执行一些收尾工作

  • 使用 mktemp 生成临时文件或文件夹

  • 利用 / dev/null 过滤不友好的输出信息

  • 会利用命令的返回值判断命令的执行情况

  • 使用文件前要判断文件是否存在,否则做好异常处理

  • 不要处理 ls 后的数据 (比如ls -l | awk '{ print $8 }'),ls 的结果非常不确定,并且平台有关

  • 读取文件时不要使用 for loop 而要使用 while read

  • 使用cp -r命令复制文件夹的时候要注意如果目的文件夹不存在则会创建,如果存在则会复制到该文件的子文件夹下

概述

为了从制度上保证脚本的质量,我们最简单的想法大概就是搞一个静态检查工具,通过引入工具来弥补开发者可能存在的知识盲点。
市面上对于 shell 的静态检查工具还真不多,找来找去就找到一个叫 shellcheck 的工具,开源在 github 上,有 8K 多的 star,看上去还是十分靠谱的。我们可以去他的主页了解具体的安装和使用信息。

安装

这个工具的对不同平台的支持力度都很大,他至少支持了 Debian,Arch,Gentoo,EPEL,Fedora,OS X,openSUSE 等等各种的平台的主流包管理工具。安装方便。具体可以参照安装文档

集成

既然是静态检查工具,就一定可以集成在 CI 框架里,shellcheck 可以非常方便的集成在 Travis CI 中,供以 shell 脚本为主语言的项目进行静态检查。

样例

在文档的 Gallery of bad code 里,也提供了非常详细的 “坏代码” 的标准,具有非常不错的参考价值,可以在闲下来的时候当成 "Java Puzzlers" 之类的书来读读还是很惬意的。

本质

不过,其实我觉得这个项目最最精华的部分都不是上面的功能,而是他提供了一个非常非常强大的 wiki。在这个 wiki 里,我们可以找到这个工具所有判断的依据。在这里,每一个检测到的问题都可以在 wiki 里找到对应的问题单号,他不仅告诉我们 "这样写不好",而且告诉我们 "为什么这样写不好","我们应当怎么写才好",非常适合刨根问底党进一步研究。

参考资料

关于 shell 脚本编程的 10 个最佳实践
shell 脚本编写规范
Shellcheck Tool
Best Practices for Writing Bash Scripts
Good coding practices for bash
Design patterns or best practices for shell scripts
bashstyle(GITHUB)
BashGuide/Practices
Obsolete and deprecated syntax
ANSI/VT100 Control sequences
what-makes-grep-consider-a-file-to-be-binary


anzhihe安志合个人博客,版权所有丨 如未注明,均为原创 丨转载请注明转自:https://chegva.com/3731.html | ☆★★每天进步一点点,加油!★★☆

您可能还感兴趣的文章!

发表评论

电子邮件地址不会被公开。 必填项已用*标注