详解shell脚本的编写规范

 更新时间:2020年10月30日 10:06:28   作者:青丝一夜走  
这篇文章主要介绍了编写shell脚本的规范,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

编写shell脚本的一些规范

解释器

shell脚本一般选择bash作为解释器,脚本开头应为

#!/bin/bash
或
#!/bin/sh

添加脚本版本和注释功能

在脚本的开头加注释,说明脚本作者、编写时间、脚本功能,最好可以加上脚本的版本号。shell中脚本注释用#,注释语句和#号之间有一个空格

#!/bin/bash

# 脚本版本
# 脚本作者
# 脚本时间
# 脚本功能

添加脚本调试

通过set命令添加脚本调试,如果报错,脚本直接退出,不继续执行,对于管道错误也可以直接退出

#!/bin/bash

# 脚本版本
# 脚本作者
# 脚本时间
# 脚本功能

set -e 
set -o pipfail

变量命名

变量命名要统一规范,shell变量建议使用全部大写,意思清晰明了,如果是多个字符,可以采用下划线进行切割,如APACHE_LOG_PATH,对于变量的引用可以直接使用$,如果有下划线分区的变量,建议使用${APACHE_LOG_PATH}

全局变量和局部变量

全局变量可以采用前面时候的定义方式,如果是函数中的局部变量,建议使用local进行变量声明。这个防止全局变量和局部变量混淆,局部变量可以采用小写,用来区分局部变量和全局变量。

function TestFunc(){
	local name='xiaolangjun'
	echo ${name}
}

如果存在变量合并的情况,比如目录和文件名合并,这样可以重新赋值成一个新的变量,这样方便以后调用。

命名规范

函数命名

函数命名一般单词的首字母大写,比如GetInformation,意思清晰。

  • 获取最大值或最小值时后缀使用MaxMin
  • 获取信息或者返回值的函数可以使用Get作为前缀
  • 判断函数可以使用Is作为前缀

脚本命名

脚本命名,根据脚本功能进行命名,后缀为.sh,如果在脚本运行过程中产生一些临时文件,建议采用PID为后缀,如果脚本运行完成,这个文件没有用途,则自动进行删除。

PID=$$
TMP_FILE="ip_list".${PID}

函数

  • 函数定义,建议添加function关键字
  • 函数中缩进可以使用4个空格
  • 函数中使用判断或者循环语句,使用统一风格,不要有的换行,有的不换行
  • 多管道语句,建议可以进行拆分,增加可读性,可以将通用部分提取
  • 使用 &&|| 可以简化判断语句,语义更加清晰

引用模块或文件

引用脚本或者模块文件时,添加注释,简要说明模块的主要功能和作用,使用.或者source

脚本日志

脚本中建议添加日志函数,这样方便脚本调试,脚本运行中各函数的输出和状态,日志文件中包括时间-日志级别-函数,日志创建log目录,有常规的log和错误log。

配置文件

在工程目录下创建conf目录,配置文件以.conf为后缀,配置字段要风格统一,每个配置提供相关配置注释

其他

  • 脚本中路径变量,建议使用绝对路径,最后面不要使用/结尾,例如:LOG_DIR="/var/log"
  • 如果脚本中有重要文件拷贝,建议使用md5进行一致性检查,尤其是远程拷贝

到此这篇关于编写shell脚本的规范的文章就介绍到这了,更多相关shell脚本编写规范内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • linux下执行shell命令方法简介

    linux下执行shell命令方法简介

    本文给大家分享的是linux系统下执行shell命令的常用的2种方法,希望对初学shell命令的小伙伴能够有所帮助
    2016-12-12
  • linux shell 管道命令(pipe)使用及与shell重定向区别

    linux shell 管道命令(pipe)使用及与shell重定向区别

    这篇文章主要介绍了linux shell 管道命令(pipe)使用及与shell重定向区别,需要的朋友可以参考下
    2015-10-10
  • shell中循环调用hive sql 脚本的方法

    shell中循环调用hive sql 脚本的方法

    今天小编就为大家分享一篇shell中循环调用hive sql 脚本的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-06-06
  • 浅谈Shell中的函数

    浅谈Shell中的函数

    这篇文章主要介绍了Shell中函数的相关资料,帮助大家更好的理解和使用shell,感兴趣的朋友可以了解下
    2020-09-09
  • linux shell(.sh)脚本编写和运行入门

    linux shell(.sh)脚本编写和运行入门

    这篇文章主要介绍了linux shell(.sh)脚本编写和运行入门,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-09-09
  • Shell、Perl、Python、PHP访问 MySQL 数据库代码实例

    Shell、Perl、Python、PHP访问 MySQL 数据库代码实例

    这篇文章主要介绍了Shell、Perl、Python、PHP访问 MySQL 数据库代码实例,本文分别给出这几种语言访问Mysql数据的代码实例,需要的朋友可以参考下
    2015-04-04
  • shell实现俄罗斯方块脚本

    shell实现俄罗斯方块脚本

    这篇文章主要为大家详细介绍了shell实现俄罗斯方块的脚本,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-06-06
  • 自动化下载并检测ftp文件备份的shell脚本

    自动化下载并检测ftp文件备份的shell脚本

    这篇文章主要介绍了自动化下载并检测ftp文件备份的shell脚本,需要的朋友可以参考下
    2016-08-08
  • 自动生成linux网卡配置脚本分享

    自动生成linux网卡配置脚本分享

    这篇文章主要介绍了自动生成linux网卡配置的脚本,因为Linux虚拟机在复制时候网卡信息会更新,所以导致需要重新配置网卡。本脚本功能,第一次添加网卡后,启动虚拟机,然后运行脚本(可以写在启动脚步中),然后根据ifconfig -a 的信息来创建ifcfg-ethX的配置文件或者修改对应的ifcfg-ethX的mac
    2014-03-03
  • shell脚本编程实现9*9乘法表

    shell脚本编程实现9*9乘法表

    这篇文章主要介绍了shell脚本编程实现9*9乘法表,本文直接给出实现代码,并同时总结了实现代码中的知识点,需要的朋友可以参考下
    2015-03-03

最新评论