怎样写出规范的shell脚本(仅限Scripting with style)

来源：互联网发布：淘宝c店没有流量咋办编辑：程序博客网时间：2024/05/16 14:25

目录：Area1:某位博友总结的shell代码规范

Area2:一篇比较规范的脚本范例

Area3:书籍中提及的Scripting with style

Area4:shell脚本学习好书推荐

因本人平常酷爱shell脚本，感觉其处理一些常见问题语法灵活，能够方便并快捷地处理许多问题，我们知道linux（UNIX）系统的启动基本上都是通过rc.d里面的脚本来实现，然而在浏览过各式各样的脚本后发现，许多脚本编写者在书写shell脚本时很不规范，也包括自己，譬如不加注释或注释很少或注释形式杂乱无章等，认为很有必要系统性地学习下脚本的规范风格，在chinaunix上也看到有过多年脚本编写经历的人纳闷这个问题。以下是整理的几类认为规范性地学习脚本不错滴文章。尤其是Area3中的Scripting With Style的专门介绍。

注：本文只是谈及脚本的样式风格，如应该添加版本信息，用法等等，不涉及变量定义，代码效率等问题！

Area1:某位博友总结的shell代码规范

Shell代码规范［个人］

前言：随着写的SHELL程序越来越多，发现自己每次写都有不同的习惯或者定义了不同的东西，变量名定义得不一样，整个程序缩进不统一，没有注释等问题，等我回过头看这些程序的时候发现很麻烦。所以想到写个自己的shell代码规范。

1 概述

1.1 目的

定义Shell脚本命名和编码规范，统一管理Shell脚本，便于自己和别人查看，提高代码书写速度和美观，暂时只对自己进行约束,其它人只供参考。

1.2 概述

本文主要根据Fedora Core 4.0的特点，描述安装脚本、OS初始脚本、补丁制作等方面的代码编写规范，可能大部分还是根据自己的习惯与反复思考后的结果，同样也参考了PHP代码规范等。

1.3 开发工具

shell脚本是个文件，没有开发环境，FC4图形环境下，可用gedit、vi、vim、joe等，推荐使用vim因为这个最通用，他的功能同样是很强大，如果想在图形化下可以用gvim，并将环境设置为sh高亮显示，方法:1）cp /etc/vim/vimrc ~/.vimrc 2) vim ~/.vimrc 去掉”syntax on,并且；Windows下，可用ultraedit。文件保存时，有汉字提示的Shell脚本文件，文件保存时，字符编码必须为GB18030/GBK/GB2132 (UTF-8) 三种格式之一。

2 对象命名规范

2.1 命名约定
1.本文档的命名约定是系统配置文件、脚本文件；

2.文件名、变量名、函数名不超过20个字符；

3.命名只能使用英文字母，数字和下划线，只有一个英文单词时使用全拼，有多个单词时，使用下划线分隔，长度较长时，可以取单词前3～4个字母。

4.文件名全部以小写命名，不能大小写混用（通过U盘交换文件时，大小写可能会丢失，即：大写文件名可能会全部变成小写文件名）；

5.避免使用Linux的保留字如true、关键字如PWD等（见附表）；

6.从配置文件导出配置时，要注意过滤空行和注释

2.2代码开头约定

1、第一行一般为调用使用的语言

2、下面要有这个程序名，避免更改文件名为无法找到正确的文件

3、版本号

4、更改后的时间

5、作者相关信息

6、该程序的作用，及注意事项

7、版权与是否开放共享GNU说明

8、最后是各版本的更新简要说明
如下面的例子：

#!/bin/bash# -------------------------------------------------------------------------------# Filename:    check_mem.sh# Revision:    1.1# Date:        2009/02/10# Author:      Ajian# Email:       ajian521#gmail.com# Website:     www.ohlinux.com# Description: Plugin to monitor the memory of the system# Notes:       This plugin uses the "" command# -------------------------------------------------------------------------------# Copyright:   2009 (c) Ajian# License:     GPL## This program is free software; you can redistribute it and/or# modify it under the terms of the GNU General Public License# as published by the Free Software Foundation; either version 2# of the License, or (at your option) any later version.## This program is distributed in the hope that it will be useful,# but WITHOUT ANY WARRANTY; without even the implied warranty# of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the# GNU General Public License for more details.## you should have received a copy of the GNU General Public License# along with this program (or with Nagios);## Credits go to Ethan Galstad for coding Nagios# If any changes are made to this script, please mail me a copy of the changes# -------------------------------------------------------------------------------#Version 1.0#The first one , can monitor the system memory#Version 1.1#Modify the method of the script ,more fast

2.3 缩进

由于Shell没有很好的编辑环境，所以，建议用四个空格为基数进行缩进，好处在不同的环境下TAB可能代表的空格数不同，造成代码的错乱。用TAB他的优点是速度快方便，可以在编辑的时候也用TAB，但需要转换。

可以在更改编辑器，Windows的就不说了，主要是VIM

:set softtabstop=4

注意不要使用 :set tabstop=4 上面那个是同时把这一个TAB转换为四个空格，而这一条是定义TAB为四个空格，如果到其它编辑器上就会看到默认8个空格的情况，那就会不美观了。

另外将原有的TAB转换为空格，:retab

如果想让刚才的配置永久生效需要改动vim的配置文件 vim ~/.vimrc,更多详细的有用的配置见“VIM配置总结”

2.4 页宽

每行不要超过80字，如果超出，建议用“\”折行，有管道的命令行除外。

2.5 环境变量

变量：全部是大写字母

变量引用：全部以变量名加双引号引用，如”$TERMTYPE”，或“${TERMTYPE}”，如果变量类型是数值型不引用，如:

如果需要从配置文件导出变量，则在变量前加一大写字母，以识别导出变量与自定义环境变量的区别，如：

变量值的引用尽量以$开头，如$(ls inst_*.sh)，避免使用`ls inst_*。sh`

循环控制变量可以命名为单个字母，比如 i、j等。也可以是更有意义的名称，比如 UserIndex。

环境变量和全局变量在脚本开头定义。

函数中使用较多的文件，以环境变量的形式在文件开头定义，仅函数中使用的变量在函数开头定义

2.6 函数

函数以动名词形式存储，且第二个单词首字母要大写，如updateConfig()

每个函数控制在50－100行，超出行数建议分成两个函数

多次反复调用的程序最好分成函数，可以简化程序，使程序条理更清楚

2.7 语句

if 语句

if/then/else 语句中最可能被执行的部分应该放在 then 子句中，不太可能被执行的部分应该放在 else 子句中。

如果可能，尽量不要使用一连串的 if 语句，而应该以 case 语句替代。

不要使 if 语句嵌套超过5层以上，尽量以更清楚的代码替代。

case 语句

概要

case 语句中的单个子句应该以 case 常数的数字顺序或字母顺序排列。子句中的执行语句应该尽量保持简单，一般不要超过4到5行代码。如果执行语句过于复杂，应该将它放置在独立的函数中。

case 语句的 *) 子句应该只在正常的默认情况或检测到错误的情况下使用。

格式

case 语句遵循同样的缩进和命名约定。

while 语句

使用 Exit 过程退出 while 循环是不好的; 如果可能，应该只使用循环条件来结束循环。

while 循环的所有初始化代码应该紧贴在进入 while 循环之前，不要被其他无关语句分隔开。

循环结束后的处理应该紧跟在循环之后。

for 语句

如果需要执行确定次数的增量循环，应该用 for 语句替代 while 语句。

2.8 信号捕捉

如果在进行重要配置修改时，应捕捉用户按键，如果用户按下Ctrl+C等重要操作终止程序，则调用回退程序，如：

2.9 关于注释

程序头应加注版本与功能说明的注释。但程序第一行不能汉字。

程序体中应包含必要的注释，注释说明如下：

单行注释，可以放在代码行的尾部或代码行的上部；

多行注释，用于注解复杂的功能说明，可以放在程序体中，也可以放在代码块的开始部分

代码修改时，对修改的内容要加必要版本注释及功能说明。

Area2:一篇比较规范的脚本范例

以下是一个游戏脚本--“挖地雷”。像代码注释段，该有的信息都有，显得非常专业化，再者脚本的内容也看起来很舒服，可以说是化难为易。

#!/bin/bash
#-------------CopyRight-------------
# Name:Mine Sweeping
# Version Number:1.00
# Type:game
# Language:bash shell
# Date:2005-10-26
# Author:BitBull
# Email:BitBull.cn(at)gmail.com
#------------Environment------------
# Terminal: column 80 line 24
# Linux 2.6.9 i686
# GNU Bash 3.00.15
#-----------------------------------
#---------------Define--------------
ECHO="echo -ne"
ESC="\033["
OK=0
FALSE=1
#--------------Variable--------------
#ANSI ESC action
FLASH=5
REV=7
#color
NULL=0
BLACK=30
RED=31
GREEN=32
ORANGE=33
BLUE=34
PURPLE=35
SBLUE=36
GREY=37
#back color
BBLACK=40
BRED=41
BGREEN=42
BORANGE=43
BBLUE=44
BPURPLE=45
BSBLUE=46
BGREY=47
MINE='@'
FLAG='F'
NUL=' '
SHADOW='X'
X=0
Y=0
CurX=1 #cur's X
CurY=1 #cur's Y
OCurX=1 #old cur's X
OCurY=1 #old cur's Y
MCount=0 #count mine
FCount=0 #count flag
SCount=0 #count shadow
MXYp=0 #MXY Array's ptr
#---------------Array----------------
#if ${XY[]} == M { mine }
#if ${XY[]} == F { flag }
#if ${XY[]} == N { null }
#if ${XY[]} == S { shadow }
#if ${XY[]} == [1-8] { tip_num }
#${XY[]} init in XYInit(i)
MXY[0]=""
#--------------Function--------------
function SttyInit ()
{
stty_save=$(stty -g) #backup stty
clear
trap "GameExit;" 2 15
stty -echo
$ECHO "${ESC}?25l" #hidden cursor
return $OK
}
function GameExit ()
{
stty $stty_save
stty echo
clear
trap 2 15
$ECHO "${ESC}?25h${ESC}0;0H${ESC}0m"
exit $OK
}
#print help
function Help ()
{
msg="Move:w s a d Dig:j Flag:f NewGame:n Exit:x --CopyRight-- -2005-10-28 BitBull--"
$ECHO "${ESC}${REV};${RED}m${ESC}24;1H${msg}${ESC}${NULL}m"
return $OK
}
#print dialog window in screen
function PMsg ()
{
local title="$1" content="$2" greeting="$3"
$ECHO "${ESC}${RED}m"
$ECHO "${ESC}11;20H ------------------------------------------- "
$ECHO "${ESC}12;20H| ======>$title<====== |"
$ECHO "${ESC}13;20H| $content |"
$ECHO "${ESC}14;20H| ======>$greeting<====== |"
$ECHO "${ESC}15;20H ------------------------------------------- "
$ECHO "${ESC}${NULL}m"
return $OK
}
#print menu and player choose level,then ${X,Y,MCount,FCount,SCount} init
function Menu ()
{
local key
$ECHO "${ESC}6;1H${ESC}${RED}m"
cat<<MENUEND
+++++++++++++++++++++++++++++
+ (1) Easy +
+ (2) Normal +
+ (3) Hardly +
+ (4) Exit +
+++++++++++++++++++++++++++++
MENUEND
$ECHO "${ESC}${NULL}m"
while read -s -n 1 key
do
case $key in
1) X=10;Y=10;MCount=10;FCount=10;SCount=100;break
;;
2) X=20;Y=14;MCount=28;FCount=28;SCount=280;break
;;
3) X=36;Y=18;MCount=65;FCount=65;SCount=648;break
;;
4) GameExit
;;
esac
done
return $OK
}
#receive CurX CurY,put it into XY[CurX+X*(CurY-1))]
#if $# == 3;write into XY[]
#if $# == 2;read from XY[]
function XYFormat ()
{
local XTmp=$1 YTmp=$2
if [[ $# -eq 3 ]]
then XY[$XTmp+$X*($YTmp-1)]=$3
else echo ${XY[$XTmp+$X*($YTmp-1)]}
fi
return $OK
}
function DrawInit ()
{
local DIline DIline2
DIline=$( for (( i=1; i<$((X*2)); i++ )) do $ECHO '-';done )
DIline2=$( for (( i=0; i<X; i++ )) do $ECHO "|${ESC}${SBLUE}mX${ESC}${NULL}m";done )
clear
Help
$ECHO "${ESC}1;1H+${DIline}+"
for (( i=0; i<Y; i++ ))
do
$ECHO "${ESC}$((i+2));1H${DIline2}|"
done
$ECHO "${ESC}$((Y+2));1H+${DIline}+"
return $OK
}
#${XY[*]}=S
function XYInit ()
{
for (( i=1; i<=$X; i++ ))
do
for (( j=1; j<=$Y; j++ ))
do
XYFormat $i $j S
done
done
return $OK
}
#check X Y
function CheckXY ()
{
local XYTmp="$1 $2"
for(( i=0; i<MXYp; i++ ))
do
if [[ "${MXY[i]}" == "$XYTmp" ]]
then return $FALSE
fi
done
return $OK
}
#RANDOM mine's X Y
function XYRand ()
{
local XTmp YTmp
for(( i=0; i<MCount; i++ ))
do
while :
do
XTmp=$(( RANDOM % ( X - 1 ) + 1 ))
YTmp=$(( RANDOM % ( Y - 1 ) + 1 ))
CheckXY $XTmp $YTmp
if [[ "$?" == "$OK" ]]
then
XYFormat $XTmp $YTmp M
MXY[i]="$XTmp $YTmp"
(( ++MXYp ))
break
else continue
fi
done
done
return $OK
}
#DEBUG
# print ${XY[*]} into ./mine.tmp
#you can read mine.tmp to know where is mine,xixi~~:)
#M is mine
function DEBUGPXY ()
{
rm mine.tmp>/dev/null 2>&1
for(( i=1; i<=$Y; i++ ))
do
for(( j=1; j<=$X; j++))
do
$ECHO "$(XYFormat $j $i)">>mine.tmp
done
$ECHO "\n">>mine.tmp
done
return $OK
}
#move cur
#usage:CurMov [UP|DOWN|LEFT|RIGHT]
function CurMov ()
{
local direction=$1 Xmin=1 Ymin=1 Xmax=$X Ymax=$Y
OCurX=$CurX
OCurY=$CurY
case $direction in
"UP") if [[ $CurY -gt $Ymin ]];then (( CurY-- ));fi
;;
"DOWN") if [[ $CurY -lt $Ymax ]];then (( CurY++ ));fi
;;
"LEFT") if [[ $CurX -gt $Xmin ]];then (( CurX-- ));fi
;;
"RIGHT")if [[ $CurX -lt $Xmax ]];then (( CurX++ ));fi
;;
esac
if [[ $CurX != $OCurX || $CurY != $OCurY ]]
then DrawPoint $CurX $CurY CUR
fi
return $OK
}
#display point
#include cur,flag,mine,shadow,nul,tip [1-8]
function DrawPoint ()
{
local TCurX=$(( $1 * 2 )) TCurY=$(( $2 + 1 )) Type=$3
local TOCurX=$(( OCurX * 2 )) TOCurY=$(( OCurY + 1 ))
local colr=0 osign=0 sign=0
case $Type in
"CUR")
case $(XYFormat $OCurX $OCurY) in
F) colr=$PURPLE;osign=$FLAG;;
N) colr=$NULL;osign=$NUL;;
[1-8]) colr=$ORANGE;osign=$(XYFormat $OCurX $OCurY);;
[SM]) colr=$SBLUE;osign=$SHADOW;;
esac
case $(XYFormat $CurX $CurY) in
F) sign=$FLAG;;
N) sign=$NUL;;
[1-8]) sign=$(XYFormat $CurX $CurY);;
[SM]) sign=$SHADOW;;
esac
$ECHO "${ESC}${colr}m${ESC}${TOCurY};${TOCurX}H${osign}${ESC}${NULL}m"
$ECHO "${ESC}${REV};${FLASH};${ORANGE}m${ESC}${TCurY};${TCurX}H${sign}${ESC}${NULL}m"
;;
"SHADOW")
$ECHO "${ESC}${SBLUE}m${ESC}${TCurY};${TCurX}H${SHADOW}${ESC}${NULL}m"
;;
"MINE")
$ECHO "${ESC}${REV};${RED}m${ESC}${TCurY};${TCurX}H${MINE}${ESC}${NULL}m"
;;
"FLAG")
$ECHO "${ESC}${TCurY};${TCurX}H${ESC}${PURPLE}m${FLAG}${ESC}${NULL}m"
;;
[1-8])
$ECHO "${ESC}${TCurY};${TCurX}H${ESC}${ORANGE}m${Type}${ESC}${NULL}m"
;;
"NUL")
$ECHO "${ESC}${TCurY};${TCurX}H${NUL}"
esac
return $OK
}
#check xy
function Loop ()
{
local XYTmp="$1 $2"
for (( i=0; i<MXYp; i++ ))
do
if [[ "$XYTmp" == "${MXY[i]}" ]]
then $ECHO 1
fi
done
return $OK
}
#count around mine
#A B C
#D X E
#F G H
#return mine's number
function CountM ()
{
local Xmin=1 Ymin=1 Xmax=$X Ymax=$Y minecount=0 n=0
#A
if [[ ( $CurX -gt $Xmin ) && ( $CurY -gt $Ymin ) ]]
then
n=$( Loop $((CurX-1)) $((CurY-1)) )
(( minecount += n ))
n=0
fi
#B
if [[ $CurY -gt $Ymin ]]
then
n=$( Loop $CurX $((CurY-1)) )
(( minecount += n ))
n=0
fi
#C
if [[ ( $CurX -lt $Xmax ) && ( $CurY -gt $Ymin ) ]]
then
n=$( Loop $((CurX+1)) $((CurY-1)) )
(( minecount += n ))
n=0
fi
#D
if [[ $CurX -gt $Xmin ]]
then
n=$( Loop $((CurX-1)) $CurY )
(( minecount += n ))
n=0
fi
#E
if [[ $CurX -lt $Xmax ]]
then
n=$( Loop $((CurX+1)) $CurY )
(( minecount += n ))
n=0
fi
#F
if [[ ( $CurX -gt $Xmin ) && ( $CurY -lt $Ymax ) ]]
then
n=$( Loop $((CurX-1)) $((CurY+1)) )
(( minecount += n ))
n=0
fi
#G
if [[ $CurY -lt $Ymax ]]
then
n=$( Loop $CurX $((CurY+1)) )
(( minecount += n ))
n=0
fi
#H
if [[ ( $CurX -lt $Xmax ) && ( $CurY -lt $Ymax ) ]]
then
n=$( Loop $((CurX+1)) $((CurY+1)) )
(( minecount += n ))
n=0
fi
return $minecount
}
#dig
#if mine ,gameover
#else tip around mine's number
function Dig ()
{
local key minenum=0
case $(XYFormat $CurX $CurY) in
M)
DrawPoint $CurX $CurY MINE
read -s -n 1 key
GameOver "Game Over"
;;
S)
CountM
minenum=$?
if [[ $minenum -eq $NULL ]]
then
XYFormat $CurX $CurY N
DrawPoint $CurX $CurY NUL
else
XYFormat $CurX $CurY $minenum
DrawPoint $CurX $CurY $minenum
fi
(( SCount-- ))
if [[ $SCount -eq $MCount ]]
then GameOver "Well Done"
fi
;;
esac
DrawPoint $CurX $CurY CUR
return $OK
}
#draw flag's number
function DrawFCount ()
{
$ECHO "${ESC}22;34H${ESC};${PURPLE}mFLAG=${FCount} ${ESC}${NULL}m"
}
#sign mine
function Flag ()
{
local XYTmp="$CurX $CurY";stat=$FALSE
case $(XYFormat $CurX $CurY) in
F)
for (( i=1; i<MXYp; i++ ))
do
if [[ "${MXY[i]}" == "$XYTmp" ]]
then XYFormat $CurX $CurY M;stat=$OK;break
fi
done
if [[ $stat == $FALSE ]]
then XYFormat $CurX $CurY S
fi
DrawPoint $CurX $CurY SHADOW
(( FCount++ ))
DrawFCount
;;
[SM])
if [[ $FCount -eq $NULL ]]
then return $FALSE
fi
DrawPoint $CurX $CurY FLAG
XYFormat $CurX $CurY F
(( FCount-- ))
DrawFCount
;;
esac
DrawPoint $CurX $CurY CUR
return $OK
}
function GameOver ()
{
local key msgtitle=$1
PMsg "$msgtitle" "Do you want replay?<y/n>" "Thank You"
while read -s -n 1 key
do
case $key in
[yY]) exec $(dirname $0)/$(basename $0);;
[nN]) GameExit;;
*) continue;;
esac
done
return $OK
}
#main
#drawscreen and control
function Main ()
{
local key
XYInit
XYRand
############################
# if you enable DEBUGPXY,
#you can know where is mine
# DEBUGPXY #delete this line's #
#then cat ./mine.tmp
############################
DrawPoint $CurX $CurY CUR
DrawFCount
while read -s -n 1 key
do
case $key in
[wW]) CurMov UP;;
[sS]) CurMov DOWN;;
[aA]) CurMov LEFT;;
[dD]) CurMov RIGHT;;
[jJ]) Dig;;
[fF]) Flag;;
[nN]) exec $(dirname $0)/$(basename $0);;
[xX]) GameExit;;
esac
done
return $OK
}
#---------------Main-----------------
SttyInit
Menu #X Y MCount FCount SCount OK!
DrawInit
Main

Area3:书籍中提及的Scripting with style

http://tldp.org/LDP/abs/html/scrstyle.html这是链接地址

Area4:shell脚本学习好书推荐

ABS，高级Bash脚本编程指南，http://www.tsnc.edu.cn/default/tsnc_wgrj/doc/abs-3.9.1_cn/html/

推荐看这本：《Learning the bash shell》（http://book.douban.com/subject/3296982/）

内容清晰，提纲挈领
书不是很厚，可以很快看完，然后投入实践

1. < < Advanced Bash-Scripting Guide > > ，即ABS，http://tldp.org/LDP/abs/html/。
经典的Online教程，内容全面，对每一个知识点都有相当多的实例，适合系统的学习。之前有翻译的版本出到过3.9.1。

2. < < UNIX Shells by Example Fourth Edition > > ，网上有chm下载。
这本书适合用的时候查询，结构很清晰，以语法为主。它的亮点在于将几种常用的不同种类的Shell分开来描述。

3. < < Linux Command Line and Shell Scripting Bible > > ，网上有pdf下载。
这本书也很全面。适合那些喜欢一章一章看书的人去学，印刷质量相当的好。

4. < < LINUX与UNIX Shell编程指南 > > ，网上有pdf下载。
中文。中文。中文。

< < UNIX Shells by Example Fourth Edition > > 推荐这本，网上有中文版pdf。内容丰富，讲解也不错。每个例子都是c shell ，ksh，bash三种都有，最好着重学习一个，个人喜欢bash，简练且紧凑。c shell的交互功能做的倒是不错，不过要是用它写脚本你会想去撞墙。
其实学什么教材倒是其次，坚持只用linux做桌面环境才是关键，同时拔掉你的鼠标。