简洁的脚本编写规范

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

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

基本规范

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

  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

相关推荐

  • Ubuntu修改静态IP、网关和DNS的方法总结

    /etc/netplan (use) Ubuntu 18.04开始可以使用netplan配置网络,其也是默认安装的。配置文件位于/etc/netplan/xxx.yaml中,netplan默认是使用NetworkManager来配置网卡信息的。 使用 netplan apply 网络配置 Ubuntu /etc/network/interfaces 修改静态…

    2023年11月27日
    15700
  • Docker搭建phpipam管理平台

    phpipam功能很多,但最直接的都是用来做IP地址管理工具。在IT管理中,IP地址的分配和使用是比较重要的一环,尤其是对于全网中子网地址的分配,以及个别Server地址分配,静态地址使用记录等。 这里按照参考通过docker方式,下载镜像并运行容器,可以很容易搭建并应用。phpipam采用mysql数据库来储存数据,对应容器来说,在运行时可以将其数据目录映…

    2022年12月1日
    68200
  • 通过远程桌面连接Windows系统的ECS实例提示“你的远程桌面许可证出现问题,您的会话将在60分钟后断开连接。”错误怎么办?

    问题描述 重启Windows系统的ECS实例之后,通过远程桌面连接实例时提示如下错误。 问题原因 Windows系统的ECS实例的本地组策略编辑器中“指定 RD 会话主机服务器的授权模式”的选项设置不为按设备模式。 解决方案

    2023年11月15日
    22600
  • k8s命令自动补齐

    k8s命令自动补齐 yum install bash-completion -y source /usr/share/bash-completion/bash_completion source <(kubectl completion bash) kubectl completion bash >/etc/bash_comple…

    2023年2月2日
    24500
  • 如何修复Linux系统中已知的系统软件缺陷?

    Linux操作系统的ECS实例某些业务运行异常问题,是由Linux操作系统本身已知的系统软件缺陷导致,若您的ECS实例的操作系统不是最新版本,可以尝试通过手动升级ECS实例的操作系统软件包来修复。 当前已知的Linux系统软件缺陷如下: 可通过升级操作系统中软件解决的Linux ECS实例问题 在CentOS或RHEL 7实例上,启动某个服务或进程时提示端口…

    2023年11月14日
    13400

发表回复

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

在线咨询: QQ交谈

邮件:712342017@qq.com

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

关注微信