Shell脚本的书写规范与优秀的开发习惯

简介:

<--目录-->
1)脚本模块名
2)代码框架
3)函数规范
4)脚本存放规范
5)补充规范19条
6)优秀的开发习惯

【脚本模块名】
1、常规Shell脚本使用统一后辍:.sh,例:wsyht.sh
2、模块的启动和停止脚本统一命名为start_{模块名}.sh和sop_{模块名}.sh
3、监控脚本可以*_mon.sh为后辍,控制脚本以*_ctl.sh为后辍
4、模块(及其脚本和二进制程序)命名应该代表其特性和功能,不要使用个人名字缩写等形式命名
5、模块中的脚本和二进制程序命名禁止和其它脚本和二进制程序重名

【代码框架】
1、脚本开头解释器声明为 #!/bin/bash,也可以为#!/bin/sh,尽量统一
2、配置文件及库函数脚本等的引用如,source conf/httpd.conf
3、主脚本过程只实现程序主干,功能实现尽量封装在子函中
4、对于能独立执行的脚本要有 usage 和 version 函数,可以输出脚本用法和版本信息

5、规范代码树如下:
[root@localhost ~]# tree
|-- bin
| `-- ipsecct
|-- conf
| `-- ipsec.cfg
`-- func
`-- functions

【函数规范】
1、函数定义时在函数名前加上function保留字,虽然/etc/init.d/functions中没有这样做
2、尽量一行一条语句,而不是使用":"将多个语句隔开,尽可能多的判断操作是否成功,并对其进行相应处理
3、对于重要的函数,需说明函数用途,参数,返回值,作者,版本

【脚本存放规范】
1、服务控制脚本统一放置在/service/scripts目录下;如果多个运维人员,可以放在以自已用户命名的二级目录下

      如/server/scrips/username;比如我开发的脚本可以放在/server/scripts/wsyht下

【补充规范19条】
1、必须要有基本的日志输出
2、要关注脚本的效率和系统消耗,综合、平衡的考虑
3、函数参数传递:在调用函数时,向函数传递的参数如果是以变量的方式进行传递

     必须使用双引号将变量引起,这是为了防止某个变量中以多个空格分隔的字段,导致函数误认为是多个参数
4、避免cat大文件。比如for id in `cat id_file`;do … ;done。而是采用readline形试读入文件
5、对上一个命令需要if [ $? ]判断返回值,对于异常分支,需有相应的处理策略;或打印warning日志,或提示后退出
6、sort超过1G数据文件时,必须用-T指定临时文件夹,推荐在使用到sort的时候就使用-T指定到自身的TMP目录
7、避免使用大的while/for循环,如果实在需要,请考虑用awk命令替代
8、对于一系列有严格依赖关系的命令,请使用&&来处理

      比如:make mydir && mv myfile mydir; 对于有前后次序的脚本,禁止采用后台运行 & 命令。(推荐)
9、脚本运行前后,注意清除过期数据(上次运行生成的数据),注意rm的风险,可考虑替代方法,如find
10、对于功能较为复杂的脚本,考虑使用一些函数对功能点进行封装。这样可以使脚本清晰易读。(推荐)
11、任何出错情况必须将出错信息打印到日志中;严重的错误必须以邮件或短信报警的形式发出。(必须)
12、对于逻辑比较复杂的脚本,可以使用 set -x 来打印命令执行情况,便于调式和排错(推荐)。
13、wget之前,注意先删除本地文件;(推荐)
14、拷贝比较大的文件,最好先将文件cp到一个临时文件夹,然后mv到目标文件夹,避免下游模块读取到不完整文件
15、mv,cp模块,注意要使用命令全路径,直接强制替换,如/bin/cp -ap wsyht /tmp
16、脚本中,要注意对单引号'' 双引号"" 的转义,不明确转义启义的,在自测的时候多加小心。(推荐)
17、例用ps axuw|grep 来获取信息时,注意ps打印的最大宽度。建议多打几个w,例如ps auxwww|grep … ;(推荐)
18、使用sort,uniq,join,comm等命令时,要注意两点:

1) 是否要求排序(例如uniq,join,comm要求输入文件是排好序的);
2) 如果排序,要求以什么方式排序(例如,comm要求输入文件是排好序的,而不是数值序);(推荐)

19、对于Java程序脚本要环境变量的,写脚本前最好通过export重新声明环境变量,以免在定时任务场合使用出问题

【优秀的开发习惯】
1、尽量少用中文注释:如果非要用,要根据自身的客户端对服务器进行字符集调整
      如:export LANG="zh_CN.GB18030"在脚本中,调整下了符集

2、尽量以.sh为扩展名
      例:script-name.sh

3、书写代码习惯:
      a.成对内容的一次写出来。如:
     {}、[]、''、``、""
      b.流程控制语然一次书写完,如:
      if语句格式一次完成:
      c: 书写[]时,添内容之前直接两端的空格留出来,例: [ content ]
      d.变量的字符串定义加双引号,等号前后不能有空格。WSYHT_FILE="test.txt"
      e.变量的引用加双引号,大括号,"{WSYHT_FILE}"
      f.特别注意,脚本中的单引号

4、调整vim语法配置,及内容自动补便配置




本文转自 2012hjtwyf 51CTO博客,原文链接:http://blog.51cto.com/hujiangtao/1930661,如需转载请自行联系原作者
相关文章
|
8月前
|
存储 安全 Unix
七、Linux Shell 与脚本基础
别再一遍遍地敲重复的命令了,把它们写进Shell脚本,就能一键搞定。脚本本质上就是个存着一堆命令的文本文件,但要让它“活”起来,有几个关键点:文件开头最好用#!/usr/bin/env bash来指定解释器,并用chmod +x给它执行权限。执行时也有讲究:./script.sh是在一个新“房间”(子Shell)里跑,不影响你;而source script.sh是在当前“房间”里跑,适合用来加载环境变量和配置文件。
774 9
|
8月前
|
存储 Shell Linux
八、Linux Shell 脚本:变量与字符串
Shell脚本里的变量就像一个个贴着标签的“箱子”。装东西(赋值)时,=两边千万不能有空格。用单引号''装进去的东西会原封不动,用双引号""则会让里面的$变量先“变身”再装箱。默认箱子只能在当前“房间”(Shell进程)用,想让隔壁房间(子进程)也能看到,就得给箱子盖个export的“出口”戳。此外,Shell还自带了$?(上条命令的成绩单)和$1(别人递进来的第一个包裹)等许多特殊箱子,非常有用。
785 2
|
11月前
|
Shell
Shell脚本循环控制:shift、continue、break、exit指令
使用这些命令可以让你的Shell脚本像有生命一样动起来。正确使用它们,你的脚本就能像一场精心编排的舞蹈剧目,既有旋律的起伏,也有节奏的跳跃,最终以一场惊艳的表演结束。每一个动作、每一个转折点,都准确、优雅地完成所需要表达的逻辑。如此,你的脚本不只是冰冷的代码,它透过终端的界面,跳着有节奏的舞蹈,走进观众——使用者的心中。
383 60
|
8月前
|
数据采集 监控 Shell
无需Python:Shell脚本如何成为你的自动化爬虫引擎?
Shell脚本利用curl/wget发起请求,结合文本处理工具构建轻量级爬虫,支持并行加速、定时任务、增量抓取及分布式部署。通过随机UA、异常重试等优化提升稳定性,适用于日志监控、价格追踪等场景。相比Python,具备启动快、资源占用低的优势,适合嵌入式或老旧服务器环境,复杂任务可结合Python实现混合编程。
|
10月前
|
Web App开发 缓存 安全
Linux一键清理系统垃圾:释放30GB空间的Shell脚本实战​
这篇博客介绍了一个实用的Linux系统盘清理脚本,主要功能包括: 安全权限检查和旧内核清理,保留当前使用内核 7天以上日志文件清理和系统日志压缩 浏览器缓存(Chrome/Firefox)、APT缓存、临时文件清理 智能清理Snap旧版本和Docker无用数据 提供磁盘空间使用前后对比和大文件查找功能 脚本采用交互式设计确保安全性,适合定期维护开发环境、服务器和个人电脑。文章详细解析了脚本的关键功能代码,并给出了使用建议。完整脚本已开源,用户可根据需求自定义调整清理策略。
1182 1
|
12月前
|
存储 Unix Shell
确定Shell脚本在操作系统中的具体位置方法。
这对于掌握Linux的文件系统组织结构和路径方面的理解很有帮助,是我们日常工作和学习中都可能使用到的知识。以上讲解详细清晰,应用简便,是每一个想要精通操作系统的计算机爱好者必备的实用技能。
634 17
|
Linux Shell 数据安全/隐私保护
Centos或Linux编写一键式Shell脚本创建用户、组、目录分配权限指导手册
Centos或Linux编写一键式Shell脚本创建用户、组、目录分配权限指导手册
631 3
|
Shell 索引
shell脚本入门到实战(四)- 数组
shell脚本入门到实战(四)- 数组
204 0
|
Shell
shell脚本入门到实战(三) - 变量
shell脚本入门到实战(三) - 变量
230 0
|
Shell Linux 人机交互
shell脚本入门到实战(二)--shell输入和格式化输出
shell脚本入门到实战(二)--shell输入和格式化输出
825 0