详解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，意思清晰。

  • 获取最大值或最小值时后缀使用Max、Min
  • 获取信息或者返回值的函数可以使用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脚本编写规范内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • linux shell命令快捷获得系统帮助(一)[man-pages定义规范]

    作为刚刚学习linux朋友,我们拿到一个命令,不知道怎么样使用,一般都会先看下命令默认参数说明,然后再不清楚就是通过man命令查阅手册.还是找不到方法,就网上搜索,最后不行就去大论坛发帖.由于很多时候发帖子估计要比较久有人回复.久而久之,对学习linux的热情被怠慢下来了. 其实,这也是学习linux的最大困难. linux命令帮助,一般有2种,命令自身代码里面带有使用帮助说明,这种一般很精简,太长了,程序自身的大小以及日常维护不方便.还有一种,就是带有帮助文件,类似windows的chm格式文

  • 详解shell脚本的编写规范

    编写shell脚本的一些规范 解释器 shell脚本一般选择bash作为解释器,脚本开头应为 #!/bin/bash 或 #!/bin/sh 添加脚本版本和注释功能 在脚本的开头加注释,说明脚本作者.编写时间.脚本功能,最好可以加上脚本的版本号.shell中脚本注释用#,注释语句和#号之间有一个空格 #!/bin/bash # 脚本版本 # 脚本作者 # 脚本时间 # 脚本功能 添加脚本调试 通过set命令添加脚本调试,如果报错,脚本直接退出,不继续执行,对于管道错误也可以直接退出 #!/bin

  • 详解shell脚本中的case条件语句介绍和使用案例

    #前言:这篇我们接着写shell的另外一个条件语句case,上篇讲解了if条件语句.case条件语句我们常用于实现系统服务启动脚本等场景,case条件语句也相当于if条件语句多分支结构,多个选择,case看起来更规范和易读 #case条件语句的语法格式 case "变量" in 值1) 指令1... ;; 值2) 指令2... ;; *) 指令3... esac #说明:当变量的值等于1时,那么就会相应的执行指令1的相关命令输出,值等于2时就执行指令2的命令,以此类推,如果都不符合的话

  • 详解shell脚本[] [[]] -n -z 的含义解析

    在写脚本的时候,总是搞不懂[] [[]]的区别,这次写一个总结,把它掌握牢固 []和test 两者是一样的,在命令行里test expr和[ expr ]的效果相同. test的三个基本作用是判断文件.判断字符串.判断整数.支持使用 "与或非" 将表达式连接起来. test中可用的比较运算符只有==和!=,两者都是用于字符串比较的,不可用于整数比较,整数比较只能使用-eq, -gt这种形式. 无论是字符串比较还是整数比较都千万不要使用大于号小于号.当然,如果你实在想用也是可以的,对于字

  • 详解Shell脚本中调用另一个Shell脚本的三种方式

    主要以下有几种方式: Command Explanation fork 新开一个子 Shell 执行,子 Shell 可以从父 Shell 继承环境变量,但是子 Shell 中的环境变量不会带回给父 Shell. exec 在同一个 Shell 内执行,但是父脚本中 exec 行之后的内容就不会再执行了 source 在同一个 Shell 中执行,在被调用的脚本中声明的变量和环境变量, 都可以在主脚本中进行获取和使用,相当于合并两个脚本在执行. 第一种:fork 特点:会生成子PID而且可重复被

  • 详解Shell 脚本中 “$” 符号的多种用法

    通常情况下,在工作中用的最多的有如下几项: $0:Shell 的命令本身 1到9:表示 Shell 的第几个参数 $? :显示最后命令的执行情况 $#:传递到脚本的参数个数 $$:脚本运行的当前进程 ID 号 $*:以一个单字符串显示所有向脚本传递的参数 $!:后台运行的最后一个进程的 ID 号 $-:显示 Shell 使用的当前选项 ...... 今天将通过以上几种选项并做进一步的操作案例: 1.引用变量 引用变量时,使用 $ 符号直接来进行引用,以及包括循环变量: [root@localho

  • 详解Shell脚本中^M的问题和解决方案

    详解Shell脚本中^M的问题和解决方案

    目录 ^M 是什么? 本质原因 常用工具 在开发过程中,有时候不小心将Windows本地创建的shell脚本(以 .sh 结尾的脚本),传到linux系统中,通过 vi或者view命令查看文件时,发现在末尾发现出现了很多^M字符. ^M 是什么? 这个字符就是换行符.是由于跨平台解析的原因.因为window和Linux下对行尾的换行的定义不同Windows: \r\nLinux/Unix: \nMac: \r 例子 出现的原因:在DOS/Windows里,文本文件的换行符为\r\n,而在nix系

  • 详解Shell脚本控制docker容器启动顺序

    1.遇到的问题 在分布式项目部署的过程中,经常要求服务器重启之后,应用(包括数据库)能够自动恢复使用.虽然使用docker update --restart=always containerid能够让容器自动随docker启动,但是并不能保证是在数据库启动之后启动,如果数据库未启动,那么将导致应用启动失败;网上还有一种解决方法是通过docker-compose容器编排来控制启动顺序,这个博主研究的比较少. 2.解决思路 使用Shell脚本来控制,思路大致如下 探测数据库端口来检验数据库是否启动成

  • 详解shell中脚本参数传递的两种方式

    方式一:$0,$1,$2.. 采用$0,$1,$2..等方式获取脚本命令行传入的参数,值得注意的是,$0获取到的是脚本路径以及脚本名,后面按顺序获取参数,当参数超过10个时(包括10个),需要使用${10},${11}....才能获取到参数,但是一般很少会超过10个参数的情况. 1.1 示例:新建一个test.sh的文件 #!/bin/bash echo "脚本$0" echo "第一个参数$1" echo "第二个参数$2" 在shell中执行

  • 详解shell 变量

    1.简介 变量是任何一种编程语言都必不可少的组成部分,变量用来存放各种数据.脚本语言在定义变量时通常不需要指明类型,直接赋值就可以,Shell变量也遵循这个规则. 在Bash shell 中,每一个变量的值都是字符串,无论你给变量赋值时有没有使用引号,值都会以字符串的形式存储.这意味着,Bash shell 在默认情况下不会区分变量类型,即使你将整数和小数赋值给变量,它们也会被视为字符串,这一点和大部分的编程语言不同.如C/C++ ,变量分为整数.浮点数.字符串.布尔等多种类型.当然,如果有必要

  • 详解shell 变量的高级用法示例

    变量删除和替换 案例:从头开始匹配,将符合最短的数据删除 (#) variable_1="I love you, Do you love me" echo $variable_1 variable_2=${variable_1#*ov} echo $variable_2 案例:从头开始匹配,将复合最短的数据删除(##) varible_3=${variable_1##*ov} echo $varible_3 案例:替换字符串,只替换第一次匹配成功的(/) echo $PATH var6

随机推荐