详解shell脚本的编写规范

firefaith 2020-10-30

编写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进行一致性检查,尤其是远程拷贝

相关推荐