简洁的脚本编写规范

脚本健壮性是脚本设计考虑的重要因素。很多脚本编写时只考虑到一些正常执行路径,里面各种条件都满足的情况下,脚本能正常执行。条件不满足时,容易出错,导致故障

脚本设计应该是一个闭环,从开始执行到最终执行完成是可预期的。脚本依赖的条件,执行时会进行检测,不满足则抛异常,脚本执行的结果应该返回正确的状态,执行出错时有通知机制

基本规范

脚本编写需要遵循以下基本的规范

  1. 脚本风格:在编写脚本时,应有良好的系统化和结构化的风格,增加脚本的美观以及可读性。可参考Google脚本风格指南
  2. USAGE函数:脚本需要包含USAGE函数,告知脚本使用方法,应包含输入、输出、功能、外部依赖、环境变量等,便于用户使用
  3. 用户检查:当脚本只能在特定用户下执行时务必加上用户检查
  4. 绝对路径:脚本中推荐使用绝对路径,如必须在特定目录下执行,则脚本中应先切换到该目录下
  5. 重复执行:脚本设计时,尽量设计成可重复执行,并确保重复执行的结果是幂等
  6. 单例执行:如果脚本同时只能执行一次,应通过文件锁或进程检查等方式进行校验
  7. 异常处理:脚本执行出错,应抛出错误,同时设置正确退出值,0为正常,非0为异常,任务系统会根据退出值来判断脚本执行结果,Ansible、Jenkins、Rundeck等也是同样的设计
  8. 日志记录:编写脚本的过程中应添加日志,例如执行步骤、错误信息等,方便追踪执行过程及排错

最佳实践

根据对之前脚本执行失败问题的汇总分析,以下问题需要特别注意

  1. 添加脚本使用方法

脚本开头需要添加脚本的使用方法,使用方法需明确脚本是否接收参数,对于一些有参数的脚本,需在使用方法中描述参数的含义,同时需要判断传入的参数数量是否一致,一个好的使用方法编写如下

if [ $# != 3 ];then
    echo "USAGE: $0 PROJ ENVT TAG"
    exit 1
fi

使用方法应位于脚本开头位置

  1. 提前创建文件夹

当需要在特定文件夹下进行操作时,需要先检查文件夹是否存在,若不存在请提前创建,例如

if [ ! -d /tmp/ops-coffee/ ];then
    mkdir /tmp/ops-coffee/
fi

cd /tmp/ops-coffee/ &&\
echo "tmp file." > dena.txt
  1. 校验命令执行结果

脚本是由若干命令组成的,脚本编写时应确保每一条命令都符合预期,在脚本中推荐使用&&||运算符

ps -ef | grep java | grep -v grep | wc -l &&\
echo 0 ||\
echo 1
  1. 返回正确的状态

在命令执行完成后,会根据命令的返回状态也就是$?的值来判断命令是否执行成功,当$?0时表示执行成功,否则表示执行失败,如果是执行的脚本时,需要在脚本最后明确脚本返回状态,shell脚本可以在脚本执行成功时通过exit指定退出状态,例如

ls /ops-coffee.cn &&\
exit 0 ||\
exit 1

而对于python脚本则可以借助sys.exit这样写

import sys

if 'www' in 'ops-coffee.cn':
  sys.exit(0)
else:
  sys.exit(1)

其他语言类似

文章来源:https://www.cnaaa.net,转载请注明出处:https://www.cnaaa.net/archives/8008

(0)
郭靖的头像郭靖
上一篇 2023年4月18日 下午4:11
下一篇 2023年4月19日 下午5:09

相关推荐

  • Truenas webdav共享服务数据备份

    第一步 首先创建数据集 第二步 启用webdav共享服务,并配置账号密码(已启用可忽视) 第三步 配置数据集使用webdav共享服务 这样webdav服务就已经打开了 配置webdav服务上传文件大小限制,进入/usr/local/etc/apache24/Includes 修改webdav文件,http修改webdav.conf ,https修改webda…

    2023年3月13日
    1.6K00
  • Linux系统之安装uptime-kuma服务器监控面板

    一、检查本地环境 1.1 检查本地操作系统版本检查本地操作系统版本 1.2 检查系统内核版本 检查系统内核版本 1.3 检查系统是否安装Node.js 检查系统是否安装Node.js 二、部署Node.js 环境 2.1 下载Node.js安装包 下载Node.js安装包 2.2 解压Node.js安装包 解压Node.js安装包 2.3 复制二进制文件 将…

    2023年9月21日
    93900
  • DELL服务器配置RAID图文教程

    dell服务器创建Raid5,(适用于Dell R730、R720、R630、R620、R420、R530) Disk Group:磁盘组,这里相当于是阵列,例如配置了一个RAID5,就是一个磁盘组。 VD(Virtual Disk): 虚拟磁盘,虚拟磁盘可以不使用阵列的全部容量,也就是说一个磁盘组可以分为多个VD。 PD(Physical Disk):物理…

    2023年11月30日
    1.1K00
  • linux查看某个文件夹的大小(ls命令、du命令详解)

    ls 命令:列出当前工作目录下的所有文件/文件夹的名称 使用ls -l,会显示成字节大小,ls- lh会以KB、MB等为单位进行显示更加直观。 du 命令:查看当前目录和子目录文件夹/文件大小情况 du = disk usage 磁盘使用率,输出每个文件或者目录总大小,其用法如下: du -sh:查看当前目录总大小。 du -sh *:查看当前目录所有子目录…

    2024年5月13日
    1.0K00
  • Zabbix的Mysql数据库内存占用高问题分析与处理

    问题:1、Zabbix内存使用率高;2、MariaDB没有开启独享表空间 ibdata1是InnoDB的共有表空间,默认情况下会把表空间存放在一个文件ibdata1中,会造成这个文件越来越大. 原因1:使用InnoDB共享表空间存储数据 参数innodb_file_per_table,控制innodb引擎采用共享表空间存储还是独立表空间存储。 参数innod…

    2022年12月30日
    1.2K00

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

在线咨询: QQ交谈

邮件:712342017@qq.com

工作时间:周一至周五,8:30-17:30,节假日休息

关注微信