简洁的脚本编写规范

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

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

基本规范

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

  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

相关推荐

  • 在 Kubernetes 上最小化安装 KubeSphere

    除了在 Linux 机器上安装 KubeSphere 之外,您还可以将其直接部署在现有的 Kubernetes 集群上。本快速入门指南将引导您完成在 Kubernetes 上最小化安装 KubeSphere 的一般性步骤。 准备工作 备注 部署 KubeSphere 确保您的机器满足安装的前提条件之后,可以按照以下步骤安装 KubeSphere。 执行以下命…

    2023年4月18日
    44800
  • Centos在dracut模式下如何修改系统配置文件

    1、进入dracut原因 Centos系统进入dracut的原因有很多比如:系统重要文件丢失系统配置文件配置错误等 2、恢复系统文件 2.1、dracut环境 在dracut上下文中是无法看到Centos系统文件的dracut# 2.2、找到系统盘 Centos默认安装时,系统盘是一个lv设备 如果安装时,手动修改了分区,那么可以根据实际情况找到系统设备比如…

    2023年6月12日
    56600
  • Rocky9的安装与基本配置

    安装 Rocky Linux 9.0 设置语言为:中文 — 简体中文(中国) 注意: 默认 Rocky Linux 9.0 安全设置禁用了 SSH 使用 root 密码登录了,所以在设置 root 用户密码的时候,记得勾选[允许 root 用户使用密码进行 SSH 登录] 开始安装 安装完成,点击[重启系统] 内核升级到了5.14 登录成功 防火墙配置 SE…

    2023年4月7日
    1.2K00
  • Key exchange was not finished, connection is closed.解决办法

    利用java连接Linux服务器中碰到错误:Key exchange was not finished, connection is closed.,导致服务器的连接失败,报错如下 原因 是ssh中的key交换算法不兼容导致 解决办法 修改配置文件 添加如下内容 重启服务

    2023年7月25日
    70800
  • 破解Esxi服务器中Windows虚机密码

    一.Esxi操作1.找到需要重置密码的Windows虚机点击操作,打开编辑设置 2.连接windows10的cd镜像 3.找到虚拟机选项,引导选择BIOS,并设置下次强制进入BIOS设置,然后保存 二.Windows虚机操作1.启动虚机,找到boot选项,将CD-ROM Drive设置为高优先引导后保存退出.重启虚机 2.重启后进入安装界面,点击下一步 找到…

    2023年10月11日
    59800

发表回复

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

在线咨询: QQ交谈

邮件:712342017@qq.com

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

关注微信