谷歌Shell脚本编程规范笔记_google shell规范

原文链接
英文原文：https://google.github.io/styleguide/shellguide.html
中文原文：https://zh-google-styleguide.readthedocs.io/en/latest/google-shell-styleguide/

手抄笔记用于后续查阅。

---

文件拓展名

平时脚本建议 chmod u+x script_name 给脚本添加执行权限，不用添加扩展名（Linux外编辑器可添加，如notepad++编辑保存为.sh扩展名文件可以帮助检查语法错误）

---

注释

文件头

每个文件必须包含一个顶层注释，对其内容进行简要概述。版权声明和作者信息是可选的

例如

#!/bin/bash
#
# 程序启动脚本
1
2
3

功能注释

所有的函数注释应该包含：

• 函数的描述
• 全局变量的使用和修改
• 使用的参数说明
• 返回值，而不是上一条命令运行后默认的推出状态

例如

#!/bin/bash
#
# 启动程序脚本

APP_NAME="Cluster_1"

###########################
# 程序启动函数
# 全局变量：
#   APP_NAME:应用名称
# 参数:
#   无
# 返回值:
#   无
###########################
start(){
  # TODO
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

实现部分的注释

针对某行复杂命令平时可以进行单行注释。

TODO注释

如果在实现时候觉得代码有缺陷用TODO注释起来。

TODO注释应该包含全部大写的字符串TODO，接着是括号中你的用户名。冒号是可选的。最好在TODO条目之后加上bug或者ticket的序号。

例如

# TODO(曹曹曹老板来了):此处可能存在不匹配的未知场景错误（bug ###）
1

---

格式

缩进

这一点很重要，平时代码过程忌讳制表符缩进，统一使用两个空格。

行的长度和长字符串

循环

循环结构尽量一次写完整再写循环体语句。

例如

# for循环语句
for fir in ${dirs_to_cleanup}; do
  if [[ -d "${ORACLE_SID}" ]]; then
    log_date "Cleaning up old files in ${dir}/${ORACLE_SID}"
    rm "${dir}/${ORACLE_SID}"*
    if [[ "$?" -ne 0 ]]; then
	  error_message
	fi
  else
    mkdir -p "${dir}/${ORACLE_SID}"
    if [[ "$?" -ne 0 ]]; then
	  error_message
	fi
  fi
done
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

这里有几个细节：

• 缩进采用两个空格
• if [[ "$?" -ne 0 ]] 需要和[ ] 留有一个空格（必须）
• if 语句使用的 [[ ]] 而不是 [ ]

case语句

匹配表达式比case和esac缩进一级。多行操作要再缩进一级。一般情况下，不需要引用匹配表达式。模式表达式前面不应该出现左括号。避免使用;&和;;&符号。

例如

# 匹配不同命令执行不同的函数
case "${input}" in
  start) 
    echo "开始启动程序..."
    start ${APP_NAME}
    ;;
  stop)
    echo "开始停止程序..."
    stop ${APP_NAME}
    ;;
  *)
    error "未知表达式。"
    ;;
esac
1
2
3
4
5
6
7
8
9
10
11
12
13
14

变量扩展

引用

使用变量时尽量带上引号，即 "${val}"

• 推荐引用是单词的字符串（而不是命令选项或者路径名）。
• 千万不要引用整数。
• 注意[[中模式匹配的引用规则。
• 请使用$@ 除非你有特殊的原因需要使用$*。

---

特性及错误

命令替换

嵌套的反引号要求用反斜杠转义内部的反引号。而$(command)形式嵌套时不需要改变，而且更易于阅读。

例如

# 倾向于这种
var="$(command "$(command)")"

# 而不是这种
var="`command \`command\``"
1
2
3
4
5

test，[ 和 [[

因为在[[和]]之间不会有路径名称扩展或单词分割发生，所以使用[[ … ]]能够减少错误。而且[[ … ]]允许正则表达式匹配，而[ … ]不允许。

测试字符串

Bash足以在测试中处理空字符串。所以，请使用空（非空）字符串测试，而不是填充字符，使得代码更易于阅读。

例如

# 推荐 -- 匹配字符串
if [[ "${my_var}" = "some_string"]]; then
  # TODO
fi

# 推荐 -- 判断字符串是否为空
if [[ -z "${my_var}" ]]; then
  # TODO
fi

# 推荐 -- 判断字符串不为空
if [[ -n "${my_var}" ]]; then
  # TODO
fi

# 不推荐 -- 匹配字符串
if [[ "${my_var}X" = "some_stringX"]]; then
  # TODO
fi

# 不推荐 -- 判断字符串是否为空
if [[ "${my_var}" = "" ]]; then
  # TODO
fi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

文件名的通配符扩展

因为文件名可能义-开头，所以使用扩展通配符./*比 * 来得安全的多。

Eval

当用于给变量赋值时，Eval解析输入，并且能够设置变量，但无法检查这些变量时什么。

管道导向while循环

例如

# 推荐
while read count filename; do
  total+="${count}"
  last_file="${filename}"
done << (your_command | uniq -c)

# 不推荐
last_line='NULL'
your_command | while read line; do
  last_line="${line}"
done

# 会输出NULL,因为管道命令 last_line="${line}"
# 是在子shell中进行的，而父shell中last_line变量还是NULL
echo "${last_line}"

#
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

命名约定

函数名

当函数名后存在( )时，关键词function是多余的。但是其促进了函数的快速辨识。

变量名

常量和环境变量名

源文件名

注意这里，源文件名是采用小写而不是大写

使用本地变量

例如

my_func2(){
  local name="$1"
  
  # 声明和赋值应该在不同行
  local my_var
  my_var="${my_func}" || return

  # 不推荐这种
  # 当赋值的值由命令替换时，声明和赋值必须分开。因为内建的 local 不会从命令替换中传递退出码
  local my_var="${my_func}"
}
1
2
3
4
5
6
7
8
9
10
11

调用命令

检查返回值

对于非管道命令，使用$?或直接通过一个if语句来检查保持其简洁

例如

if ! mv "${file_list}" "${dest_dir}/" ; then
  echo "无法移动 ${file_list} 到 ${dest_dir}" >&2
  exit "${E_BAD_MOVE}"
fi

# 或者
mv "${file_list}" "${dest_dir}/"
if [[ "$?" -ne 0 ]]; then  # 命令执行成功正常退出码为0。 -ne 不等于
  echo "无法移动 ${file_list} 到 ${dest_dir}" >&2
  exit "${E_BAD_MOVE}"
fi
1
2
3
4
5
6
7
8
9
10
11

---

终于抄完作业了！