调试与排错是Bash 脚本的重要环节，可以帮助写出更安全的 Bash 脚本。

set命令调试

Bash 执行脚本时，会创建一个子 Shell，脚本将会在子Shell中执行，这个子 Shell 就是脚本的执行环境，Bash 默认给定了这个环境的各种参数。

set命令用来修改子 Shell 环境的运行参数，即定制环境。直接运行set，会显示所有的环境变量和 Shell 函数。

set -u（变量检查）

默认情况下，bash在执行脚本时，如果遇到不存在的变量，将忽略它继续执行下一步。

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

1
2

#!/usr/bin/env bash
set -u

set -u还有另一种写法set -o nounset，两者是等价的。

set -x（命令输出）

set -x用来在执行命令之前，先输出执行的那一条命令。

比如，在执行脚本中的echo bar之前，该命令会先打印出来。行首以+表示。

输出的命令之前的+号，是由系统变量PS4决定，可以修改这个变量。这对于调试复杂的脚本是很有用的。

如果想要对特定的代码段打开命令输出，可以使用set +x。比如下面例子中 只对if代码段进行调试。

1
2
3
4
5
6
7
8
9
10
11

#!/bin/bash

number=1

set -x
if [ $number = "1" ]; then
  echo "Number equals 1"
else
  echo "Number does not equal 1"
fi
set +x

set -x还有另一种写法set -o xtrace。

set -e（错误处理）

默认情况下，如果脚本里面有运行失败的命令（返回值非0），Bash 只是显示有错误，然后会继续执行后面的命令。

这种行为很不利于脚本安全和除错。实际开发中，如果某个命令失败，往往需要脚本停止执行，防止错误累积。这时，一般采用下面的写法。

1
2
3
4
5

# 只要`command`有非零返回值，脚本就会停止执行。
command || exit 1

# 如果停止执行之前需要完成多个操作，可以采用下面的写法
command || { echo "command failed"; exit 1; }

上面这些写法多少有些麻烦。set -e从根本上解决了这个问题，根据返回值判断命令是否运行失败。只要脚本发生错误，就终止执行。

1
2

#!/usr/bin/env bash
set -e

set -e但是，某些命令的非零返回值可能不表示失败，或者开发者希望在命令失败的情况下，脚本继续执行下去。这时可以暂时关闭set -e，该命令执行结束后，再重新打开set -e。

1
2
3
4
5
6
7

set +e
command1
command2
set -e

# 或者使命令即使执行失败，脚本也不终止执行
command || true

set -e还有另一种写法set -o errexit。

set -o pipefail（错误处理：管道符）

set -e有一个例外情况，就是不适用于管道命令。

所谓管道命令，就是多个子命令通过管道运算符（|）组合成为一个大的命令。Bash 会把最后一个子命令的返回值，作为整个命令的返回值。也就是说，只要最后一个子命令不失败，管道命令总是会执行成功，因此它后面命令依然会执行，set -e就失效了。

请看下面这个例子。

1
2
3
4
5

#!/usr/bin/env bash
set -e

foo | echo a
echo bar

执行结果如下。

1
2
3
4

$ bash script.sh
a
script.sh:行4: foo: 未找到命令
bar

上面代码中，foo是一个不存在的命令，但是foo | echo a这个管道命令会执行成功，导致后面的echo bar会继续执行。

set -o pipefail用来解决这种情况，只要一个子命令失败，整个管道命令就失败，脚本就会终止执行。

1
2
3
4
5

#!/usr/bin/env bash
set -eo pipefail

foo | echo a
echo bar

运行后，结果如下。

1
2
3

$ bash script.sh
a
script.sh:行4: foo: 未找到命令

可以看到，echo bar没有执行。

set -E（错误处理：trap）

一旦设置了-e参数，会导致函数内的错误不会被trap命令捕获（参考《trap 命令》一章）。-E参数可以纠正这个行为，使得函数也能继承trap命令。

1
2
3
4
5
6
7
8
9
10
11
12

#!/bin/bash
set -e

trap "echo ERR trap fired!" ERR

myfunc()
{
  # 'foo' 是一个不存在的命令
  foo
}

myfunc

上面示例中，myfunc函数内部调用了一个不存在的命令foo，导致执行这个函数会报错。

1
2

$ bash test.sh
test.sh:行9: foo：未找到命令

但是，由于设置了set -e，函数内部的报错并没有被trap命令捕获，需要加上-E参数才可以。

1
2
3
4
5
6
7
8
9
10
11
12

#!/bin/bash
set -Eeuo pipefail

trap "echo ERR trap fired!" ERR

myfunc()
{
  # 'foo' 是一个不存在的命令
  foo
}

myfunc

执行上面这个脚本，就可以看到trap命令生效了。

1
2
3

$ bash test.sh
test.sh:行9: foo：未找到命令
ERR trap fired!

其他参数

上面重点介绍的set命令的几个参数，一般都放在一起使用。

1
2
3
4
5
6

# 写在所有 Bash 脚本的头部
#!/bin/sh
set -Eeuxo pipefail

# 也可以在执行 Bash 脚本的时候，从命令行传入这些参数
$ bash -euxo pipefail script.sh

set命令还有一些其他参数。

• set -n：等同于set -o noexec，不运行命令，只检查语法是否正确。
• set -f：等同于set -o noglob，表示不对通配符进行文件名扩展。
• set -v：等同于set -o verbose，表示打印 Shell 接收到的每一行输入。
• set -o noclobber：防止使用重定向运算符>覆盖已经存在的文件。

上面的-f和-v参数，可以分别使用set +f、set +v关闭。

shopt 命令

shopt命令用来调整 Shell 的参数，跟set命令的作用很类似。之所以会有这两个类似命令的主要原因是，set是从 Ksh 继承的，属于 POSIX 规范的一部分，而shopt是 Bash 特有的。

直接输入shopt可以查看所有参数，以及它们各自打开和关闭的状态。

1

$ shopt

shopt命令后面跟着参数名，可以查询该参数是否打开。

1
2

$ shopt globstar
globstar  off

上面例子表示globstar参数默认是关闭的。

（1）-s

-s用来打开某个参数。

1

$ shopt -s optionNameHere

（2）-u

-u用来关闭某个参数。

1

$ shopt -u optionNameHere

举例来说，histappend这个参数表示退出当前 Shell 时，将操作历史追加到历史文件中。这个参数默认是打开的，如果使用下面的命令将其关闭，那么当前 Shell 的操作历史将替换掉整个历史文件。

1

$ shopt -u histappend

（3）-q

-q的作用也是查询某个参数是否打开，但不是直接输出查询结果，而是通过命令的执行状态（$?）表示查询结果。如果状态为0，表示该参数打开；如果为1，表示该参数关闭。

1
2
3

$ shopt -q globstar
$ echo $?
1

上面命令查询globstar参数是否打开。返回状态为1，表示该参数是关闭的。

这个用法主要用于脚本，供if条件结构使用。下面例子是如果打开了这个参数，就执行if结构内部的语句。

1
2
3

if (shopt -q globstar); then
  ...
fi

环境变量排错

有一些环境变量常用于除错。

LINENO

变量LINENO返回它在脚本里面的行号。

1
2
3

#!/bin/bash

echo "This is line $LINENO"

执行上面的脚本test.sh，$LINENO会返回3。

1
2

$ ./test.sh
This is line 3

FUNCNAME

变量FUNCNAME返回一个数组，内容是当前的函数调用堆栈。该数组的0号成员是当前调用的函数，1号成员是调用当前函数的函数，以此类推。

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

#!/bin/bash

function func1()
{
  echo "func1: FUNCNAME0 is ${FUNCNAME[0]}"
  echo "func1: FUNCNAME1 is ${FUNCNAME[1]}"
  echo "func1: FUNCNAME2 is ${FUNCNAME[2]}"
  func2
}

function func2()
{
  echo "func2: FUNCNAME0 is ${FUNCNAME[0]}"
  echo "func2: FUNCNAME1 is ${FUNCNAME[1]}"
  echo "func2: FUNCNAME2 is ${FUNCNAME[2]}"
}

func1

执行上面的脚本test.sh，结果如下。

1
2
3
4
5
6
7

$ ./test.sh
func1: FUNCNAME0 is func1
func1: FUNCNAME1 is main
func1: FUNCNAME2 is
func2: FUNCNAME0 is func2
func2: FUNCNAME1 is func1
func2: FUNCNAME2 is main

上面例子中，执行func1时，变量FUNCNAME的0号成员是func1，1号成员是调用func1的主脚本main。执行func2时，变量FUNCNAME的0号成员是func2，1号成员是调用func2的func1。

BASH_SOURCE

变量BASH_SOURCE返回一个数组，内容是当前的脚本调用堆栈。该数组的0号成员是当前执行的脚本，1号成员是调用当前脚本的脚本，以此类推，跟变量FUNCNAME是一一对应关系。

下面有两个子脚本lib1.sh和lib2.sh。

1
2
3
4
5
6
7
8

# lib1.sh
function func1()
{
  echo "func1: BASH_SOURCE0 is ${BASH_SOURCE[0]}"
  echo "func1: BASH_SOURCE1 is ${BASH_SOURCE[1]}"
  echo "func1: BASH_SOURCE2 is ${BASH_SOURCE[2]}"
  func2
}

1
2
3
4
5
6
7

# lib2.sh
function func2()
{
  echo "func2: BASH_SOURCE0 is ${BASH_SOURCE[0]}"
  echo "func2: BASH_SOURCE1 is ${BASH_SOURCE[1]}"
  echo "func2: BASH_SOURCE2 is ${BASH_SOURCE[2]}"
}

然后，主脚本main.sh调用上面两个子脚本。

1
2
3
4
5
6
7

#!/bin/bash
# main.sh

source lib1.sh
source lib2.sh

func1

执行主脚本main.sh，会得到下面的结果。

1
2
3
4
5
6
7

$ ./main.sh
func1: BASH_SOURCE0 is lib1.sh
func1: BASH_SOURCE1 is ./main.sh
func1: BASH_SOURCE2 is
func2: BASH_SOURCE0 is lib2.sh
func2: BASH_SOURCE1 is lib1.sh
func2: BASH_SOURCE2 is ./main.sh

上面例子中，执行函数func1时，变量BASH_SOURCE的0号成员是func1所在的脚本lib1.sh，1号成员是主脚本main.sh；执行函数func2时，变量BASH_SOURCE的0号成员是func2所在的脚本lib2.sh，1号成员是调用func2的脚本lib1.sh。

BASH_LINENO

变量BASH_LINENO返回一个数组，内容是每一轮调用对应的行号。${BASH_LINENO[$i]}跟${FUNCNAME[$i]}是一一对应关系，表示${FUNCNAME[$i]}在调用它的脚本文件${BASH_SOURCE[$i+1]}里面的行号。

下面有两个子脚本lib1.sh和lib2.sh。

1
2
3
4
5
6
7
8
9

# lib1.sh
function func1()
{
  echo "func1: BASH_LINENO is ${BASH_LINENO[0]}"
  echo "func1: FUNCNAME is ${FUNCNAME[0]}"
  echo "func1: BASH_SOURCE is ${BASH_SOURCE[1]}"

  func2
}

1
2
3
4
5
6
7

# lib2.sh
function func2()
{
  echo "func2: BASH_LINENO is ${BASH_LINENO[0]}"
  echo "func2: FUNCNAME is ${FUNCNAME[0]}"
  echo "func2: BASH_SOURCE is ${BASH_SOURCE[1]}"
}

然后，主脚本main.sh调用上面两个子脚本。

1
2
3
4
5
6
7

#!/bin/bash
# main.sh

source lib1.sh
source lib2.sh

func1

执行主脚本main.sh，会得到下面的结果。

1
2
3
4
5
6
7

$ ./main.sh
func1: BASH_LINENO is 7
func1: FUNCNAME is func1
func1: BASH_SOURCE is main.sh
func2: BASH_LINENO is 8
func2: FUNCNAME is func2
func2: BASH_SOURCE is lib1.sh

上面例子中，函数func1是在main.sh的第7行调用，函数func2是在lib1.sh的第8行调用的。