如何编写可复用的SHELL脚本?

接触SHELL脚本编程时间不长,在工作过程中发现,SHELL脚本(以下简称脚本)的内容无论从命名还是组织结构,都很混乱。编码人员随便写,怎么爽怎么来。维护人员头大,看不懂的地方,就通过if ... else ...绕过去。或者,增加新的补丁,一层一层。日复一日,年复一年,代码变得臃肿不堪,没人敢动手。命令的可读性差,让初学者无从下手。一般对命令的学习,也并不是系统性。这些都是脚本编程的问题源泉。能否通过以下的方法来避免这些问题呢?

尽量减少脚本长度

一个脚本文件,文件行数超过100行,看起来就非常费劲了。如果可以的话,尽量将所有的脚本文件都控制在100行以内。

尽量减少脚本功能范围

我们借鉴其他编程语言的经验,可以将每个脚本的功能范围做好限定,避免一个脚本中过多的功能。

尽量减少脚本的传入参数

脚本传入参数可以让脚本实现不同的功能,以此达成脚本内代码的重用。正如上面所述,任何情况下都应该尽量缩减脚本的功能范围。如果有可能,一个脚本仅实现一种业务场景。以此避免脚本的参数调用。

./do_business.sh
./do_business.sh  $VAR1  $VAR2  $VAR3

脚本文件名与脚本功能项匹配

每个脚本可以看成是一个函数,在编写脚本时应尽可能的将脚本功能与脚本文件名匹配对应。这样,既可以增加可读性,也可以从业务逻辑上对脚本进行更好的解耦与功能分割。

./init.sh
./init_ubuntu_build_environment.sh

编写脚本注释

脚本头部的注释非常重要,如果脚本可以接受输入参数,应该描述每个参数的功能。

#功能描述:描述脚本实现的业务功能。
#传入参数:描述传入脚本的每个参数功能和影响。
#全局变量:描述脚本需要依赖哪些全局变量?执行脚本后,会改变哪些全局变量?

提炼常用函数并放在公共脚本

针对经常使用的函数,可以将其提炼后放在公共的脚本中,使用时引入该公共脚本即可。
例如:字符串处理、文件处理、目录处理、日期与时间处理、日志处理等。这些常用的功能,通过函数封装的方式,既可以增加脚本的可读性,提高封装性、减少耦合度以及可能的错误。

公共脚本中,应禁止使用任何的系统变量。

函数应传入“输出参数变量名”来实现输出参数

由于SHELL函数无法返回整型除之外的值,所以调用函数时,传出函数的返回值变得较为困难。
为保证函数在调用过程中可重入性,应该避免通过全局变量的方式给函数传递参数。
而应该使用传入参数和传出参数,实现函数功能的调用。
在函数内部,应该使用局部变量:local修饰。

# 功能:实现字符串连接
# 输入$1:字符串1
# 输入$2:字符串2
# 输出:结果字符串
function string_add()
{
    local s1=$1
    local s2=$2
    local result_name=$3
    ${!result_name}=$(echo $s1$2)
}

编写函数注释

与脚本注释类似,经常调用的函数,也需要增加注释说明,减少调用者的歧义。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352

推荐阅读更多精彩内容