编写Linux Shell脚本的优秀实践
发布时间:2022-07-15 16:01:17 所属栏目:Linux 来源:互联网
导读:前言 由于工作需要,最近重新开始拾掇shell脚本。虽然绝大部分命令自己平时也经常使用,但是在写成脚本的时候总觉得写的很难看。而且当我在看其他人写的脚本的时候,总觉得难以阅读。毕竟shell脚本这个东西不算是正经的编程语言,他更像是一个工具,用来杂糅
前言 由于工作需要,最近重新开始拾掇shell脚本。虽然绝大部分命令自己平时也经常使用,但是在写成脚本的时候总觉得写的很难看。而且当我在看其他人写的脚本的时候,总觉得难以阅读。毕竟shell脚本这个东西不算是正经的编程语言,他更像是一个工具,用来杂糅不同的程序供我们调用。因此很多人在写的时候也是想到哪里写到哪里,基本上都像是一段超长的main函数,不忍直视。同时,由于历史原因,shell有很多不同的版本,而且也有很多有相同功能的命令需要我们进行取舍,以至于代码的规范很难统一。 自动化运维 | 编写Linux Shell脚本的最佳实践 代码风格规范 开头有“蛇棒” 所谓shebang其实就是在很多脚本的第一行出现的以”#!”开头的注释,他指明了当我们没有指定解释器的时候默认的解释器,一般可能是下面这样: 自动化运维 | 编写Linux Shell脚本的最佳实践 当然,解释器有很多种,除了bash之外,我们可以用下面的命令查看本机支持的解释器: 代码有注释 注释,显然是一个常识,不过这里还是要再强调一下,这个在shell脚本里尤为重要。因为很多单行的shell命令不是那么浅显易懂,没有注释的话在维护起来会让人尤其的头大。 注释的意义不仅在于解释用途,而在于告诉我们注意事项,就像是一个README。 具体的来说,对于shell脚本,注释一般包括下面几个部分: shebang 脚本的参数 脚本的用途 脚本的注意事项 脚本的写作时间,作者,版权等 各个函数前的说明注释 一些较复杂的单行命令注释 参数要规范 这一点很重要,当我们的脚本需要接受参数的时候,我们一定要先判断参数是否合乎规范,并给出合适的回显,方便使用者了解参数的使用。 最少,最少,我们至少得判断下参数的个数吧: 自动化运维 | 编写Linux Shell脚本的最佳实践 变量和魔数 一般情况下我们会将一些重要的环境变量定义在开头,确保这些变量的存在。 自动化运维 | 编写Linux Shell脚本的最佳实践 这种定义方式有一个很常见的用途,最典型的应用就是,当我们本地安装了很多java版本时,我们可能需要指定一个java来用。那么这时我们就会在脚本开头重新定义JAVA_HOME以及PATH变量来进行控制。 同时,一段好的代码通常是不会有很多硬编码在代码里的“魔数”的。如果一定要有,通常是用一个变量的形式定义在开头,然后调用的时候直接调用这个变量,这样方便日后的修改。 常见的缩进方法主要有”soft tab”和”hard tab”两种。 所谓soft tab就是使用n个空格进行缩进(n通常是2或4) 所谓hard tab当然就是指真实的””字符 这里不去撕哪种方式最好,只能说各有各的优劣。反正我习惯用hard tab。 对于if和for语句之类的,我们最好不要把then,do这些关键字单独写一行,这样看上去比较丑。。。 (编辑:PHP编程网 - 黄冈站长网) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |