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

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

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

一、不可改变的全局变量

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

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

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

二、一切皆是局部的

所有变量都应为局部的。
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
}
</div>

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

kfir@goofy ~ $ local a
bash: local: can only be used in a function
</div>

三、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
</div>

四、一切皆是函数

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

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

main() {
    local files=$(ls /tmp | grep pid | grep -v daemon)
}
</div>
temporary_files() {
    local dir=$1

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

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

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
}
</div>

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

五、调试函数

带-x标志运行程序：
bash -x my_prog.sh
</div>

只调试一小段代码，使用set-x和set+x，会只对被set -x和set +x包含的当前代码打印调试信息。
temporary_files() {
    local dir=$1

    set -x
    ls $dir \
        | grep pid \
        | grep -v daemon
    set +x
}
</div>

打印函数名和它的参数：
temporary_files() {
    echo $FUNCNAME $@
    local dir=$1

    ls $dir \
        | grep pid \
        | grep -v daemon
}
</div>

调用函数：
temporary_files /tmp
</div>

会打印到标准输出：

六、代码的清晰度

这段代码做了什么？

main() {
    local dir=/tmp

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

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

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

    [[ -d $dir ]] \
        && do_something...
}
main
</div>

让你的代码说话：