Linux shell 编写规范化、标准化

脚本中多写注释

作注释不仅方便自己还能帮助别人在翻阅你的脚本时了解脚本的不同部分所做的工作。

注释用 # 号来定义。

当运行失败时使脚本退出

有时即使某些命令运行失败，bash 可能继续去执行脚本，这样就影响到脚本的其余部分(会最终导致逻辑错误)。

此时可以把下面的内容写在脚本的前面在遇到命令失败时来退出脚本执行：

# 如果命令运行失败让脚本退出执行 
set -o  errexit  
# 或者
set -e

当 Bash 用未声明变量时使脚本退出

Bash 也可能会使用能导致起逻辑错误的未声明的变量。因此用下面行的方式去通知 bash

当它尝试去用一个未声明变量时就退出脚本执行：

# 若有用未设置的变量即让脚本退出执行 
set -o nounset 
#或者
set -u

使用双引号来引用变量

用双引号有助于防止由于空格导致单词分割开和由于识别和扩展了通配符而导致的不必要匹配。

在脚本中使用函数

除了非常小的脚本(只有几行代码)，总是记得用函数来使代码模块化且使得脚本更可读和可重用。

写函数的语法如下所示：

function  demo(){   
    command1;    
    command2; 
 } 
 # 或 
 demo(){   
     command1;    
     command2; 
 }

如果写成单行代码时，每个命令后要用终止符号：

demo(){ command1; command2; }

字符串比较时用 = 而不是 ==

注意： == 是 = 的同义词，因此仅用个单 = 来做字符串比较，

用 $(command) 来做代换

命令代换是用这个命令的输出结果取代命令本身。用 $(command) 而不是引号 command 来做命令代换。

这种做法也是 shellcheck tool (可针对 shell 脚本显示警告和建议)所建议的。例如：

user=`echo “$UID”` 
user=$(echo “$UID”)

用 readonly 来声明静态变量

静态变量不会改变;它的值一旦在脚本中定义后不能被修改：

readonly mycountry=”China” 

环境变量用大写字母命名，而自定义变量用小写

所有的 bash 环境变量用大写字母去命名，因此用小写字母来命名你的自定义变量以避免变量名冲突：

其他需要注意的

• 变量名，函数名要有实际意义，函数名以动名词形式，第二个单词首字母要大写。例如：updateConfig()
• 取变量值使用大括号，如${varname}
• 删除文件时，如果路径有变量的，要判断变量有值，如rm -f ${abc}/* 如果变量abc没有值，则会把根目录下的文件删除
• 脚本中尽量不要使用cd变换目录
• 函数中也要有功能描述，使用依法，版本，日期等
• 函数的功能要单一，不要太复杂
• $()比 更好
• 尽量不要使用多层if语句，而应该以case语句替代
• 如果需要执行确定次数的循环，应该用for语句替代while语句
• 输入的参数要有正确性判断