Shell脚本书写规范 (2)

通过脚本名称最好能够直接读出脚本的用途,比如常用xx服务的启动脚本可命名为start_xx.sh,oo服务的监控脚本可命名为oo_monit.sh,告警脚本可名称为abc_alert.sh

变量名字要有含义,不要拼错,尽量使用英文,可能显得更专业(ps:逼格高)一点,哈哈

统一命名风格,用驼峰或者下划线连接,推荐使用小写字母加下划线的方式

编码要统一

在写脚本的时候尽量使用UTF-8编码,能够支持中文等一些奇奇怪怪的字符。
尽管脚本中可以写中文,但是在写注释以及打log的时候还是尽量英文,毕竟有些机器还是没有直接支持中文的,打出来可能会有乱码。

执行权限记得加

小点,却非常重要;不加执行权限经常会导致无法直接执行,尤其是init脚本等。

日志和回显

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

注意:

一些debug级别的信息,在脚本调试结束后需要关闭。

日志输出要带时间、要带时间、带时间,在写定时任务用的脚本时尤为重要。

日志的输出推荐使用tee -a ${log_file}的方式,可以直接在main函数入口处添加日志输出。

脚本日志输出样例

logfile="/var/log/log_clean.log" # define functions function xx(){ echo "xx" } function oo(){ echo "oo" } # define main function function main(){ xx oo } # invoke main function main|tee -a ${logfile} 太长要分行

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

./configure \ –prefix=http://www.likecs.com/usr \ –sbin-path=http://www.likecs.com/usr/sbin/nginx \ –conf-path=http://www.likecs.com/etc/nginx/nginx.conf \

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

代码有效率

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

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

他们的作用一样,都是获取文件的第一行。但是第一条命令会读取整个文件,而第二条命令只读取第一行。当文件很大的时候,仅仅是这样一条命令不一样就会造成巨大的效率差异。

当然,这里只是为了举一个例子,这个例子真正正确的用法应该是使用head -1 file命令。

勤用双引号

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

#!/bin/sh #已知当前文件夹有一个a.sh的文件 var="*.sh" echo $var echo "$var"

他的运行结果如下:

a.sh *.sh

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

echo *.sh echo "*.sh"

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

巧用main函数

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

各位同学应该都写过python,因此大家都知道一个合乎标准的python脚本大体上至少是这样的:

#!/usr/bin/env python def func1(): pass def func2(): pass if __name__==\'__main__\': func1() func2()

他用一个很巧妙的方法实现了我们习惯的main函数,使得代码可读性更强。

在shell中,我们也有类似的小技巧:

#!/usr/bin/bash func1(){ #do sth } func2(){ #do sth } main(){ func1 func2 } main "$@"

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

另外在传递参数的时候可能会遇到参数接收位置的变化,记得使用shift函数。

考虑作用域

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

#!/usr/bin/env bash var=1 func(){ var=2 } func echo $var

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

巧用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 学会查路径

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zwxdxg.html