set 命令和 shopt 命令

set 命令和 shopt 命令

set 命令是 Bash 脚本的重要环节，却常常被忽视，导致脚本的安全性和可维护性出问题。本章介绍 set 的基本用法，帮助你写出更安全的 Bash 脚本。

简介

我们知道，Bash 执行脚本时，会创建一个子 Shell。

关于子 Shell，请看《Bash 子 shell》

$ bash script.sh

上面代码中，script.sh 是在一个子 Shell 里面执行。这个子 Shell 就是脚本的执行环境，Bash 默认给定了这个环境的各种参数。

set 命令用来修改（子）Shell 环境的运行参数，即定制环境。一共有十几个参数可以定制，官方手册 有完整清单，本章介绍其中最常用的几个。

顺便提一下，如果命令行下不带任何参数，直接运行 set，会显示所有的环境变量和 Shell 函数。

关于 set 命令，我们在《Bash 变量》的 自定义变量 中有所提及

$ set

set -u

执行脚本时，如果遇到不存在的变量，Bash 默认忽略它。大多数情况下，这不是开发者想要的行为，遇到变量不存在，脚本应该报错，而不是一声不响地往下执行。

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

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

简单实践如下：

创建脚本 set_u.sh

#!/usr/bin/env bash

echo $name
echo script finished

赋权后执行

$ ./set_u.sh 

script finished

添加 set -u

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

echo $name
echo script finished

赋权后执行

$ ./set_u.sh 
./set_u.sh: line 4: name: unbound variable

提示变量未绑定，报错。

set -x

默认情况下，脚本执行后，只输出运行结果，没有其他内容。如果多个命令连续执行，它们的运行结果就会连续输出。有时会分不清，某一段内容是什么命令产生的。

set -x 用来在运行结果之前，先输出执行的那一行命令。这对于调试复杂的脚本是很有用的。可用于错误定位。

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

脚本当中如果要关闭命令输出，可以使用 set +x。于 set -x 结合，就可以只对某一段脚本开启这个功能

简单实践如下：

创建 set_x.sh

#!/usr/bin/env bash

set -x
for item in {1..10}; do
    if [ "$item" -lt 5 ]; then
        echo "${item}"
    fi
done
set +x

echo script finished

赋权后执行

[root@iZbp1ag455gf8nrfdeqknwZ shell_set]# ./set_x.sh 
+ for item in '{1..10}'
+ '[' 1 -lt 5 ']'
+ echo 1
1
+ for item in '{1..10}'
+ '[' 2 -lt 5 ']'
+ echo 2
2
+ for item in '{1..10}'
+ '[' 3 -lt 5 ']'
+ echo 3
3
+ for item in '{1..10}'
+ '[' 4 -lt 5 ']'
+ echo 4
4
+ for item in '{1..10}'
+ '[' 5 -lt 5 ']'
+ for item in '{1..10}'
+ '[' 6 -lt 5 ']'
+ for item in '{1..10}'
+ '[' 7 -lt 5 ']'
+ for item in '{1..10}'
+ '[' 8 -lt 5 ']'
+ for item in '{1..10}'
+ '[' 9 -lt 5 ']'
+ for item in '{1..10}'
+ '[' 10 -lt 5 ']'
+ set +x
script finished

可以看到 for 循环的执行过程看的非常的清楚。

Bash 的错误处理

如果脚本里面有运行失败的命令（返回值非 0），Bash 默认会继续执行后面的命令。

#!/usr/bin/env bash

foo
echo bar

上面脚本中，foo 是一个不存在的命令，执行时会报错。但是，Bash 会忽略这个错误，继续往下执行。

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

可以看到，Bash 只是显示有错误，并没有终止执行。

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

command || exit 1

上面的写法表示只要 command 有非零返回值，脚本就会停止执行。

如果停止执行之前需要完成多个操作，就要采用下面三种写法。

# 写法一
command || { echo "command failed"; exit 1; }

# 写法二
if ! command; then echo "command failed"; exit 1; fi

# 写法三
command
if [ "$?" -ne 0 ]; then echo "command failed"; exit 1; fi

另外，除了停止执行，还有一种情况。如果两个命令有继承关系，只有第一个命令成功了，才能继续执行第二个命令，那么就要采用下面的写法。

command1 && command2

我们在《Bash 的基本语法》的 命令的有条件的组合 小节中曾经学习过 Command1 && Command2 和 Command1 || Command2 这两个命令

set -e

上面这些写法多少有些麻烦，容易疏忽。set -e 从根本上解决了这个问题，它使得脚本只要发生错误，包括方法内部出现错误，就会终止执行。-e 还有另一种写法 -o errexit。

简单实践如下：

创建脚本 set_e.sh

#!/usr/bin/env bash

function throw_exception(){
    echo function error
    return 1
}

throw_exception

echo script finished

赋权后执行

$ ./set_e.sh 
function error
script finished

添加 set -e

#!/usr/bin/env bash

set -e

function throw_exception(){
    echo function error
    return 1
}

throw_exception

echo script finished

赋权后执行

$ ./set_e.sh 
function error

可见直接停止了执行。

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

set +e 表示关闭 -e 选项，set -e 表示重新打开 -e 选项。

还有一种方法是使用 command || true，使得该命令即使执行失败，脚本也不会终止执行。

#!/bin/bash
set -e

foo || true
echo bar

上面代码中，true 使得这一行语句总是会执行成功，后面的 echo bar 会执行。

set -o pipefail

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

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

创建 set_o.sh

#!/usr/bin/env bash

set -e

function throw_exception(){
    echo function error
    return 1
}

throw_exception | echo pipline execute

echo script finished

赋权后执行

$ ./set_o.sh 
pipline execute
script finished

可以发现脚本的执行并没有停止，set -o pipefail 用来解决这种情况，只要一个子命令失败，整个管道命令就失败，脚本就会终止执行。

添加 set -o pipefail

#!/usr/bin/env bash

set -eo pipefail

function throw_exception(){
    echo function error
    return 1
}

throw_exception | echo pipline execute

echo script finished

执行

$ ./set_o.sh 
pipline execute

可以看到整个管道命令的每个部分依然会完整执行，但是执行之后即停止。

set -E

一旦设置了 -e 参数，会导致函数内的错误不会被 trap 命令捕获。-E 参数可以纠正这个行为，使得函数也能触发 trap 命令。

关于 trap 命令，可参考《mktemp 命令和 trap 命令》中的 trap 命令 小节

简单实践如下：

创建 set_E.sh

#!/usr/bin/env bash

set -eo pipefail

trap "echo ERR trap fired!" ERR

function inner_error(){
    return 1
}

function test(){
    echo function execute
    inner_error
    echo function finish
}

test 

echo script finished

赋权后执行

$ ./set_E.sh 
function execute

脚本停止执行，但是没有出发 trap 命令，添加 set -E

#!/usr/bin/env bash

set -Eeo pipefail

trap "echo ERR trap fired!" ERR

function inner_error(){
    return 1
}

function test(){
    echo function execute
    inner_error
    echo function finish
}

test 

echo script finished

赋权后执行

$ ./set_E.sh 
function execute
ERR trap fired!

成功被 trap 命令捕获。

trap 命令在错误处理中的用处很大，可以让我们在出现错误之后执行相关的操作。

其他参数

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

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

set 命令总结

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

# 写法一
set -Eeuxo pipefail

# 写法二
set -Eeux
set -o pipefail

# 不开启 -x
set -ueEo pipefail

这两种写法建议放在所有 Bash 脚本的头部。同时配合 trap 命令 trap "echo ERR trap fired!" ERR

另一种办法是在执行 Bash 脚本的时候，从命令行传入这些参数。

$ bash -ueEo pipefail script.sh

一般主要会 bash -x 这样使用 -x 参数，其他参数比如 -ueEo pipefail 则直接写到脚本之中。

shopt 命令

在《Bash 的模式拓展》的 shopt 命令 小节已经学习过，在其他多个小节中也有提及

shopt 命令用来调整 Shell 的参数，跟 set 命令的作用很类似。也用来修改（子）Shell 环境的运行参数，即定制环境。

之所以会有这两个类似命令的主要原因是，set 是从 Ksh 继承的，属于 POSIX 规范的一部分，而 shopt 是 Bash 特有的。

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

$ shopt

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

$ shopt globstar
globstar  off

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

（1）-s

-s 用来打开某个参数。

$ shopt -s optionNameHere

（2）-u

-u 用来关闭某个参数。

$ shopt -u optionNameHere

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

$ shopt -u histappend

（3）-q

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

$ shopt -q globstar
$ echo $?
1

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

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

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

也就是说，我们可以很方便地通过脚本来保持某个环节变量的开启