linux

编写 bash 脚本

脚本中多写注释

这是不仅可应用于 shell 脚本程序中，也可用在其他所有类型的编程中的一种推荐做法。在脚本中作注释能帮你或别人翻阅你的脚本时了解脚本的不同部分所做的工作。

对于刚入门的人来说，注释用 # 号来定义。
当命令运行失败时使脚本退出

有时即使某些命令运行失败（返回值非 0），bash 可能继续去执行脚本，这样就影响到脚本的其余部分（会最终导致逻辑错误）。用下面的行的方式在遇到命令失败时来退出脚本执行：
```
set -e
set -o errexit
```
1
2
例如：
```
#!/usr/bin/env bash
foo
echo bar

# ---- 执行结果 ----
$ bash script.sh
script.sh:行3: foo: 未找到命令
bar
# -----------------
```
1
2
3
4
5
6
7
8
9
foo是一个不存在的命令，执行时会报错。但是，Bash 会忽略这个错误，继续往下执行。这种行为很不利于脚本安全和除错。实际开发中，如果某个命令失败，往往需要脚本停止执行，防止错误累积。set -e 就用来改变这种行为。脚本在头部加上它，只要发生错误，就终止执行。
```
#!/usr/bin/env bash
set -e

echo $a
echo bar

# ---- 执行结果 ----
$ bash script.sh
script.sh:行4: foo: 未找到命令
# -----------------
```
1
2
3
4
5
6
7
8
9
10
set -e根据返回值来判断，一个命令是否运行失败。但是，某些命令的非零返回值可能不表示失败，或者开发者希望在命令失败的情况下，脚本继续执行下去。这时可以暂时关闭set -e，该命令执行结束后，再重新打开set -e。
```
set +e
command1
command2
set -e
```
1
2
3
4
上面代码中，set +e表示关闭-e选项，set -e表示重新打开-e选项。还有一种方法是使用command || true，使得该命令即使执行失败，脚本也不会终止执行。
```
#!/bin/bash
set -e

foo || true
echo bar
```
1
2
3
4
5
上面代码中，true使得这一行语句总是会执行成功，后面的echo bar会执行。

set -e有一个例外情况，就是不适用于管道命令。所谓管道命令，就是多个子命令通过管道运算符（|）组合成为一个大的命令。Bash 会把最后一个子命令的返回值，作为整个命令的返回值。也就是说，只要最后一个子命令不失败，管道命令总是会执行成功，因此它后面命令依然会执行，set -e就失效了。
```
#!/usr/bin/env bash
set -e

foo | echo a
echo bar

# ---- 执行结果 ----
$ bash script.sh
a
script.sh:行4: foo: 未找到命令
bar
# -----------------
```
1
2
3
4
5
6
7
8
9
10
11
12
上面代码中，foo是一个不存在的命令，但是foo | echo a这个管道命令会执行成功，导致后面的echo bar会继续执行。set -o pipefail用来解决这种情况，只要一个子命令失败，整个管道命令就失败，脚本就会终止执行。
```
#!/usr/bin/env bash
set -eo pipefail

foo | echo a
echo bar

# ---- 执行结果 ----
$ bash script.sh
a
script.sh:行4: foo: 未找到命令
# -----------------
```
1
2
3
4
5
6
7
8
9
10
11
可以看到，echo bar没有执行。
当 Bash 用未声明变量时使脚本退出

Bash 也可能会使用能导致起逻辑错误的未声明的变量。因此用下面行的方式去通知 bash 当它尝试去用一个未声明变量时就退出脚本执行：
```
set -u
set -o nounset
```
1
2
例如：
```
#!/usr/bin/env bash
echo $a
echo bar

# ---- 执行结果 ----
$ bash script.sh

bar
# -----------------
```
1
2
3
4
5
6
7
8
9
$a 是一个不存在的变量。执行后终端会输出一个空行，Bash 忽略了不存在的 $a，然后继续执行下面命令 echo bar。大多数情况下，这不是开发者想要的行为，遇到变量不存在，脚本应该报错，而不是一声不响地往下执行。

set -u 就用来改变这种行为。脚本在头部加上它，遇到不存在的变量就会报错，并停止执行。
```
#!/usr/bin/env bash
set -u

echo $a
echo bar

# ---- 执行结果 ----
$ bash script.sh
bash: script.sh:行4: a: 未绑定的变量
# -----------------
```
1
2
3
4
5
6
7
8
9
10
当 Bash 运行结果之前输出执行的命令
```
set -x
set -o xtrace
```
1
2
默认情况下，脚本执行后，屏幕只显示运行结果，没有其他内容。如果多个命令连续执行，它们的运行结果就会连续输出。有时会分不清，某一段内容是什么命令产生的。

set -x用来在运行结果之前，先输出执行的那一行命令。
```
#!/usr/bin/env bash
set -x

echo bar

# ---- 执行结果 ----
$ bash script.sh
+ echo bar
bar
# -----------------
```
1
2
3
4
5
6
7
8
9
10
可以看到，执行echo bar之前，该命令会先打印出来，行首以+表示。这对于调试复杂的脚本是很有用的。

使用双引号来引用变量

当引用时（使用一个变量的值）用双引号有助于防止由于空格导致单词分割开和由于识别和扩展了通配符而导致的不必要匹配。

#!/usr/bin/env bash
name="jaime romano jay"

for item in ${name}; do echo "${item}"; done
for item in "${name}"; do echo "${item}"; done

# ---- 执行结果 ----
➜ ~ bash -x script.sh
+ name='jaime romano jay'
+ for item in '${name}'
+ echo jaime
jaime
+ for item in '${name}'
+ echo romano
romano
+ for item in '${name}'
+ echo jay
jay
+ for item in '"${name}"'
+ echo 'jaime romano jay'
jaime romano jay
# -----------------

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

使用函数来使代码模块化且使得脚本更可读和可重用。

使用 $(command) 替换 `command`

processName=$(ps -p ${pid} -o comm=)
# processName=`ps -p ${pid} -o comm=`

1
2

用 readonly 来声明静态变量。静态变量不会改变；它的值一旦在脚本中定义后不能被修改：
```
readonly passwd_file="/etc/passwd"
readonly shadow_file="/etc/shadow"
```
1
2
环境变量用大写字母命名，而自定义变量用小写

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

# 总结

多写注释，方便后续阅读。
在 Bash 脚本的头部添加 set -euxo pipefail 或使用 bash -euxo pipefail script.sh 运行脚本。
- -e 当命令运行失败时使脚本退出
- -u 当遇见未声明变量时使脚本退出
- -x 在运行结果之前，先输出执行的那一行命令
- -o pipefail 解决 -e 情况中遇见管道命令失效的情况
使用双引号来引用变量

#

# 参考

← CentOS7 安装 pigz