关闭

[Shell]bash的良好编码实践

标签: shellbash规范
493人阅读 评论(0) 收藏 举报
分类:

最好的bash脚本不仅可以工作,而且以易于理解和修改的方式编写。很多好的编码实践都是来自使用一致的变量名称和一致的编码风格。验证用户提供的参数是否正确,并检查命令是否能成功运行,以及长时间运行是否能保持可用性。下面分享一下我的工作技巧。

1. 使用良好的缩进

使用良好的缩进能使代码可读性更好,从而能更好的维护。

当你有三级以上的逻辑时,缩进能使我们轻松的查看脚本的整体逻辑。使用多少个空格缩进并不重要,尽管大多数人更多的使用4个空格或8个空格进行缩进。

#!/bin/bash

if [ $# -ge 1 ] && [ -d $1 ]; then
  for file in `ls $1`
    do
        if [ $debug == "on" ]; then
            echo working on $file
         fi
         wc -l $1/$file
      done
else
  echo "USAGE: $0 directory"
    exit 1
fi

2. 提供使用说明

使用帮助语句可以帮助使用者运行脚本,即使两年后你自己也能知道脚本需要提供什么参数

#!/bin/bash

if [ $# == 0 ]; then
    echo "Usage: $0 filename"
    exit 1
fi

3. 使用合理的注释

提供说明你代码的注释,特别是当代码很复杂时,但也没有必要解释意图很明显的代码.解释你所使用的每一个命令,或组合中重要的命令。

#!/bin/bash

username=$1

# make sure the account exists on the system
grep ^$username: /etc/passwd
if [ $? != 0 ]; then
    echo "No such user: $username"
    exit 1
fi

4. 出现问题时使用返回码退出

当代码中出现问题时返回一个非0返回码,即使你自己不会看,但这也是一个好主意。假设有一天,你可能需要一个简单的方法来检查脚本中出现的问题,返回代码为1或4或11可能会帮助你快速找出问题。

#!/bin/bash

echo -n "In what year were you born?> "
read year

if [ $year -gt `date +%Y` ]; then
    echo "Sorry, but that's just not possible."
    exit 2
fi

5. 使用函数而不是重复一组命令

函数也可以使你的代码具有更好的可读性以及更易于维护。如果只是重复使用一个命令,没有必要使用函数,但是如果很简单的就能区分开一些常用的命令(separate a handful of focused commands),使用函数这是值得的。如果以后对此进行更改,你只需要在一个地方进行更改。

#!/bin/bash

function lower()
{
    local str="$@"
    local output
    output=$(tr '[A-Z]' '[a-z]'<<<"${str}")
    echo $output
}

6. 赋予变量有意义的名字

Unix管理员通常会尽最大努力的避免输入一些额外的字符,但不要在脚本中这样操作。花费一点时间为变量提供有意义的名称,并在命名时保持一致性。

#!/bin/bash

if [ $# != 1 ]; then
    echo "Usage: $0 address"
    exit 1
else
    ip=$1
fi

7. 检查参数是否是正确类型

如果在使用参数之前检查以确保提供给脚本的参数是符合预期类型的,那么可以节省很多麻烦。下面是一种简单检查参数是否为数字的方法:

#!/bin/bash

if ! [ "$1" -eq "$1" 2> /dev/null ]
then
  echo "ERROR: $1 is not a number!"
  exit 1
fi

8. 检查参数是否缺失或者顺序错误

如果提供一个以上的参数,最好要确认一下。

#!/bin/bash

if [ $# != 3 ]; then
    echo "What part of THREE ARGUMENTS don't you understand?"
fi

9. 检查需要的文件是否存在

在使用某个文件之前,很容易检查该文件是否存在。下面是一个简单的检查,来查看第一个参数指定的文件是否实际存在。

#!/bin/bash

if [ ! -f $1 ]; then
    echo "$1 -- no such file"
fi

10. 命令输出发送到/dev/null

将命令输出发送到/dev/null,并以更加“友好”的方式告诉用户出了什么问题,可以让你的脚本更容易的运行。

#!/bin/bash

if [ $1 == "help" ]; then
    echo "Sorry -- No help available for $0"
else
    CMD=`which $1 >/dev/null 2>&1`
    if [ $? != 0 ]; then
        echo "$1: No such command -- maybe misspelled or not on your search path"
        exit 2
    else
        cmd=`basename $1`
        whatis $cmd
    fi
fi

11. 充分利用错误代码

可以在脚本中使用返回码来确定命令是否得到预期的结果。

#!/bin/bash

# check if the person is still logged in or has running processes
ps -U $username 2> /dev/null
if [ $? == 0 ]; then
    echo "processes:" >> /home/oldaccts/$username
    ps -U $username >> /home/oldaccts/$username
fi

12. 给予反馈

不要忘记告诉运行你的脚本人需要知道什么。他们不必阅读代码就可以提醒他们为其创建文件的位置 - 特别是如果它不在当前目录中。

...
date >> /tmp/report$$
echo "Your report is /tmp/report$$"

13. 引号与扩展参数

如果你正在使用脚本中扩展的字符,不要忘记使用引号,这样就不会得到与预期不同的结果。

#!/bin/bash

msg="Be careful to name your files *.txt"
# this will expand *.txt
echo $msg # Be careful to name your files behavior_20170728.txt exception.txt
# this will not
echo "$msg" # Be careful to name your files *.txt

14. 使用$@引用所有参数

$@变量列出了提供给脚本的所有参数:

#!/bin/bash

for i in "$@"
do
    echo "$i"
done

原文:http://www.networkworld.com/article/2694433/unix-good-coding-practices-for-bash.html

1
0
查看评论

linux shell实现URL 编码/解码

(1)编码的两种方法 june@~ 23:40:29>echo '手机' | tr -d '\n' | xxd -plain | sed 's/\(..\)/%\1/g'     ...
  • B_H_L
  • B_H_L
  • 2014-01-07 12:14
  • 4760

谈谈良好的编码风格

能写出结构精巧的代码是一件令人羡慕的事情,能写出解决复杂问题模型的算法是一件令人羡慕而又佩服事情。虽然未必所有人能做到这些,但是每一个对代码有信仰的人至少要做到语法使用合理、代码简洁、逻辑清晰、变量的命名是见名知义的、注释是恰当可读的、会合理使用常量......总的来说是要有良好的编码风格。 一、...
  • lanyuxinkong
  • lanyuxinkong
  • 2015-08-27 16:26
  • 1734

Linux中Locale及shell编码问题

Locale是linux系统中多语言环境的设置接口,Locale根据计算机用户所使用的语言,所在国家或者地区,以及当地的文化传统所定义的一个软件运行时的语言环境。 locale把按照所涉及到的文化传统的各个方面分成12个大类,这12个大类分别是: 1、语言符号及其分类(LC_CTYPE) ...
  • zhaogehaozanennan
  • zhaogehaozanennan
  • 2017-06-05 11:09
  • 165

shell 下 urlencode/urldecode 编码/解码的几种方法

1、先弄清楚为什么要 urlencode? http://www.genome.iastate.edu/community/angenmap/URLEncoding.html URL Encoding is the process of converting string into valid UR...
  • carlostyq
  • carlostyq
  • 2012-08-31 11:54
  • 10120

bash和shell的区别

Linux 中的 shell 有很多类型,其中最常用的几种是: Bourne shell (sh)、C shell (csh) 和 Korn shell (ksh), 各有优缺点。Bourne shell 是 UNIX 最初使用的 shell,并且在每种 UNIX 上都可以使用, 在 shell 编...
  • MonMama
  • MonMama
  • 2016-11-29 11:22
  • 4822

Shell 脚本实践

Shell 脚本实践Shell 用 C 语言编写的程序,既是一种命令行语言,又是一种程序设计语言
  • lzch2105
  • lzch2105
  • 2017-01-03 17:35
  • 355

Shell基础之Bash的基本功能

Shell基础之Bash的基本功能  Bash是众多Shell中Linux使用的一个版本,由于早年的 Unix 年代,发展者众,所以由于 shell 依据发展者的不同就有许多的版本,例如常听到的 Bourne SHell (sh) 、在 Sun 里头预设的 C SHell、 商业上常用的...
  • u010456903
  • u010456903
  • 2015-09-25 21:44
  • 1571

如果你的shell终端中文是乱码

下面是各种尝试:[wz@supportserver-51 doc]$ ll total 0 -rw-rw-r-- 1 wz wz 0 Apr 10 17:53 linux?????鼙???.pdf [wz@supportserver-51 doc]$ export lang = zh_cn.gbk ...
  • qdujunjie
  • qdujunjie
  • 2015-04-10 17:58
  • 10346

Linux-SHELL中sh和bash的区别

什么是SHELL?shell的中文意思就是贝壳,其实比较类似于我们内核的壳。我们通过hsell和用户通信SHELL简而言之就是只要能够操作应用程序的接口都能够称为SHELL。狭义的shell指的是命令行方面的软件,广义的SHELL则包括图形界面。SHELL的版本在鸟哥的私房菜的一书中,介绍了UNIX...
  • li563868273
  • li563868273
  • 2016-04-28 20:35
  • 12907

bash shell 启动方式

bash
  • suremeng
  • suremeng
  • 2016-05-31 22:49
  • 385
    个人资料
    • 访问:1517568次
    • 积分:22609
    • 等级:
    • 排名:第378名
    • 原创:624篇
    • 转载:133篇
    • 译文:60篇
    • 评论:189条
    博客专栏
    文章分类
    最新评论