当前位置:  操作系统/服务器>linux

让代码整洁、过程清晰的BASH Shell编程技巧

    来源: 互联网  发布时间:2014-10-17

    本文导语:  这是我写BASH程序的招式。这里本没有什么新的内容,但是从我的经验来看,人们爱滥用BASH。他们忽略了计算机科学,而从他们的程序中创造的是“大泥球”(译注:指架构不清晰的软件系统)。 在此我告诉你方法,以保护你...

这是我写BASH程序的招式。这里本没有什么新的内容,但是从我的经验来看,人们爱滥用BASH。他们忽略了计算机科学,而从他们的程序中创造的是“大泥球”(译注:指架构不清晰的软件系统)。

在此我告诉你方法,以保护你的程序免于障碍,并保持代码的整洁。

一、不可改变的全局变量

1.尽量少用全局变量
2.以大写命名
3.只读声明
4.用全局变量来代替隐晦的$0,$1等

在我的程序中常使用的全局变量:

代码如下:

readonly PROGNAME=$(basename $0)
readonly PROGDIR=$(readlink -m $(dirname $0))
readonly ARGS="$@"

二、一切皆是局部的

所有变量都应为局部的。

代码如下:

change_owner_of_file() {
    local filename=$1
    local user=$2
    local group=$3

    chown $user:$group $filename
}
change_owner_of_files() {
    local user=$1; shift
    local group=$1; shift
    local files=$@
    local i

    for i in $files
    do
        chown $user:$group $i
    done
}

1.自注释(self documenting)的参数
2.通常作为循环用的变量i,把它声明为局部变量是很重要的。
3.局部变量不作用于全局域。

代码如下:

kfir@goofy ~ $ local a
bash: local: can only be used in a function

三、main()

1.有助于保持所有变量的局部性
2.直观的函数式编程
3.代码中唯一的全局命令是:main

代码如下:

main() {
    local files="/tmp/a /tmp/b"
    local i

    for i in $files
    do
        change_owner_of_file kfir users $i
    done
}
main

四、一切皆是函数

唯一全局性运行的代码是:
- 不可变的全局变量声明
- main()函数

1.保持代码整洁
2.过程变得清晰

代码如下:

main() {
    local files=$(ls /tmp | grep pid | grep -v daemon)
}

代码如下:

temporary_files() {
    local dir=$1

    ls $dir
        | grep pid
        | grep -v daemon
}

main() {
    local files=$(temporary_files /tmp)
}

1.第二个例子好得多。查找文件是temporary_files()的问题而非main()的。这段代码用temporary_files()的单元测试也是可测试的。

2.如果你一定要尝试第一个例子,你会得到查找临时文件以和main算法的大杂烩。

代码如下:

test_temporary_files() {
    local dir=/tmp

    touch $dir/a-pid1232.tmp
    touch $dir/a-pid1232-daemon.tmp

    returns "$dir/a-pid1232.tmp" temporary_files $dir

    touch $dir/b-pid1534.tmp

    returns "$dir/a-pid1232.tmp $dir/b-pid1534.tmp" temporary_files $dir
}

如你所见,这个测试不关心main()。

五、调试函数

带-x标志运行程序:

代码如下:

bash -x my_prog.sh

只调试一小段代码,使用set-x和set+x,会只对被set -x和set +x包含的当前代码打印调试信息。

代码如下:

temporary_files() {
    local dir=$1

    set -x
    ls $dir
        | grep pid
        | grep -v daemon
    set +x
}

打印函数名和它的参数:

代码如下:

temporary_files() {
    echo $FUNCNAME $@
    local dir=$1

    ls $dir
        | grep pid
        | grep -v daemon
}

调用函数:

代码如下:

temporary_files /tmp

会打印到标准输出:

代码如下:
temporary_files /tmp

六、代码的清晰度

这段代码做了什么?

代码如下:

main() {
    local dir=/tmp

    [[ -z $dir ]]
        && do_something...

    [[ -n $dir ]]
        && do_something...

    [[ -f $dir ]]
        && do_something...

    [[ -d $dir ]]
        && do_something...
}
main

让你的代码说话:

代码如下:

is_empty() {
    local var=$1

    [[ -z $var ]]
}

is_not_empty() {
    local var=$1

    [[ -n $var ]]
}

is_file() {
    local file=$1

    [[ -f $file ]]
}

is_dir() {
    local dir=$1

    [[ -d $dir ]]
}

main() {
    local dir=/tmp

    is_empty $dir
        && do_something...

    is_not_empty $dir
        && do_something...

    is_file $dir
        && do_something...

    is_dir $dir
        && do_something...
}
main

七、每一行只做一件事

用反斜杠来作分隔符。例如:

代码如下:

temporary_files() {
    local dir=$1

    ls $dir | grep pid | grep -v daemon
}

可以写得简洁得多:

代码如下:

temporary_files() {
    local dir=$1

    ls $dir
        | grep pid
        | grep -v daemon
}

符号在缩进行的开始

符号在行末的坏例子:(译注:原文在此例中用了temporary_files()代码段,疑似是贴错了。结合上下文,应为print_dir_if_not_empty())

代码如下:

print_dir_if_not_empty() {
    local dir=$1
 
    is_empty $dir &&
        echo "dir is empty" ||
        echo "dir=$dir"
}

好的例子:我们可以清晰看到行和连接符号之间的联系。

代码如下:

print_dir_if_not_empty() {
    local dir=$1

    is_empty $dir
        && echo "dir is empty"
        || echo "dir=$dir"
}

八、打印用法

不要这样做:

代码如下:

echo "this prog does:..."
echo "flags:"
echo "-h print help"

它应该是个函数:

代码如下:

usage() {
    echo "this prog does:..."
    echo "flags:"
    echo "-h print help"
}

echo在每一行重复。因此我们得到了这个文档:

代码如下:

usage() {
    cat

    
 
 

您可能感兴趣的文章:

  • 分页存储过程(用存储过程实现数据库的分页代码)
  • C# 中调用 MySQL 存储过程的示例代码
  • linux的启动过程~ 从源代码的角度
  • gdb在调试过程中是否可以修改代码,比如加句printf()
  • C# 调用 MySQL 存储过程的代码
  • Linux启动过程到哪个阶段之后的源代码全是C语言而不是汇编写的?
  • 谁有oracle存储过程的原代码?谢谢!
  • jdbc调用mysql存储过程实现代码
  • mysql 让一个存储过程定时作业的代码
  • 存储过程配合UpdateDaset方法批量插入Dataset数据实现代码
  • sql 判断函数、存储过程是否存在的代码整理
  • sql2005 存储过程分页示例代码
  • 一个基于ROW_NUMBER()的通用分页存储过程代码
  • 急寻分段和段页式存储管理方式的地址换算过程的演示代码
  • sql 判断数据库,表,存储过程等是否存在的代码
  • 一个分页存储过程代码
  • 数据库分页存储过程代码
  • Sqlserver 存储过程中结合事务的代码
  • Mac OS X 10.8 中编译APUE(Unix环境高级编程)的源代码过程
  • sql 存储过程分页代码 支持亿万庞大数据量
  •  
    本站(WWW.169IT.COM)旨在分享和传播互联网科技相关的资讯和技术,将尽最大努力为读者提供更好的信息聚合和浏览方式。
    本站(WWW.169IT.COM)站内文章除注明原创外,均为转载、整理或搜集自网络。欢迎任何形式的转载,转载请注明出处。












  • 相关文章推荐
  • Python GUI编程:tkinter实现一个窗口并居中代码
  • 寻找<<java2图形设计卷2SWING>>一书源代码和<<java网络高级编程>>一书源代码
  • andriod下java socket网络编程:java socket客户端服务端代码示例
  • 想看linux内核源代码,另外手头上有一本《unix环境高级编程》,需要先把《unix环境高级编程》看完之后再看内核吗?
  • 哪位能提供学习LINUX SOCKET编程的源代码或相关下载网站
  • 哪有 UNIX环境高级编程 第2版 源代码 ????(急急~~~~)
  • 诚求KDE 2/QT编程宝典配套光盘中的例子代码.
  • 谁有<linux上c编程>的源代码?
  • 《UNIX环境高级编程(第2版)》这本书的源代码哪里可以下载啊?
  • shell 编程 从0到10求和 ,代码有错,请高手看看
  • Unix环境高级编程 源代码编译
  • 请问那里有关于linux编程方面的源代码?
  • 提供些下载linux C 编程 原代码的 下载 链接吧?
  • 诚求<<LINUX编程宝典>>的示例代码!!!
  • 那位有unix网络编程第1卷的源代码,请给一份
  • 哪位有机械出版社的《linux高级编程》的代码
  • 求一小段代码: 编程使得本进程收到SIGIO信号(异步IO)
  • 请问从哪里可以下到UNIX网络编程代码例子里用的包裹函数啊
  • 100分相送,帮我推荐几个UNIX下C编程的软件代码,能大型一些更好。
  • 请问谁运行过《Java XML 编程指南》中的代码?
  • 哪儿有JSP和SERVLET一起编程的原代码网站?
  • javascript 添加到收藏夹和书签代码示例
  • 在JBuilder中,为什么编写的代码中,当代码出现关键字时,后面的部分代码就移位了,当在有关键字的那些代码行进行选择时,也会出现鼠标位
  • JSP中清空cookie代码参考
  • 为什么两行代码间不加入其他代码就崩溃,而加入了日志代码后就不崩溃?
  • Python获取网页编码的方法及示例代码
  • 在ubuntu8.10 新立得中安装anjuta,为什么没有代码提示功能,怎么做才有,还有自动代码补全和代码提示有什么区别,
  • HTML网页中的html body onload自动跳转方法介绍及自动跳转代码示例
  • 到底怎么样的代码算是有效代码?请教了。。
  • php通过socket_bind()设置IP地址代码示例
  • 如果要研究源代码以提高自己,哪一个开放源代码的软件比较合适?




  • 特别声明:169IT网站部分信息来自互联网,如果侵犯您的权利,请及时告知,本站将立即删除!

    ©2012-2017,169IT.COM,E-mail:www_169it_com#163.com(请将#改为@)

    浙ICP备11055608号