简洁的脚本编写规范

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

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

基本规范

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

  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

相关推荐

  • rsync的搭建与使用

    rsync是数据镜像备份工具。使用快速增量备份工具Remote Sync可以远程同步,支持本地复制,或者与其他SSH、rsync主机同步。 已支持跨平台,可以在Windows与Linux间进行数据同步。 Ubuntu安装 Centos安装 基本用法 rsync语法有三种,分别是本地到本地形式Local to Local,本地到远程Local to Remot…

    2022年11月19日
    82600
  • HBase 高可用集群详细图文安装部署

    一、HBase 安装部署 1.1 Zookeeper 正常部署 首先保证 Zookeeper 集群的正常部署,并启动之。 1.2 Hadoop 正常部署  Hadoop 集群的正常部署并启动。 1.3 HBase 安装  HBase 官方下载地址:Apache Download Mirrors 1.4 HBase 的配置文件  1.4.1 hbas…

    2023年12月15日
    59400
  • SSL/TLS协议信息泄露漏洞(CVE-2016-2183)修复

    一、漏洞说明 Windows server 2008或2012、2016远程桌面服务SSL加密默认是开启的,且有默认的CA证书。由于SSL/ TLS自身存在漏洞缺陷,当开启远程桌面服务,使用漏洞扫描工具扫描,发现存在SSL/TSL漏洞。例如如下漏洞: 二、修复办法 1、登录服务器,打开windows powershell,运行gpedit.msc,打开“本地…

    2022年11月16日
    1.6K00
  • zabbix利用自带模板-监控mysql性能

    环境: zabbix3.4.4 mariadb 5.5.56   要求:  利用zabbix 自带的模板 监控mariadb 上的 并发连接数,慢查询数量,增删改查、请求流量带宽,mysql响应流量带宽等 (1)创建监控用户 grant all on *.* to zabbix@’localhost’ identified by ‘zab…

    2023年2月25日
    71700
  • Win11如何执行干净启动?启动/禁用干净启动

      干净启动是什么?通过使用最少的一组驱动程序和启动程序来启动 Windows,这种启动方式就称为“ 干净启动”。使用干净启动过程启动计算机时,Microsoft Windows在启动时仅加载基本设备和服务。那Win11如何执行干净启动呢?下面我们就来看看。   如何执行 Windows 11 的干净启动   要执行 Windows 11 的干净启动,请执行…

    2024年6月14日
    82200

发表回复

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

在线咨询: QQ交谈

邮件:712342017@qq.com

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

关注微信