Bash中检查变量是否设置的方法

技术背景

在Bash脚本编程中，经常需要检查变量是否已经被设置，以便根据不同情况执行相应的操作。然而，由于Bash中变量的不同状态（未设置、设置为空字符串、设置为非空值），检查变量是否设置的方法有多种，且各有特点和适用场景。

实现步骤

正确的检查方法

使用参数扩展 ${var+x}

if [ -z ${var+x} ]; then 
    echo "var is unset"; 
else 
    echo "var is set to '$var'"; 
fi

其中 ${var+x} 是一个参数扩展，如果 var 未设置，它的值为空；否则，它的值为 x。引号可以省略，因为这种语法和用法保证了它只会扩展为不需要引号的内容。不过，为了代码的可读性和避免潜在的混淆，有时加上引号 [ -z "${var+x}" ] 更好。

使用 [[ -v ]] 条件测试（Bash 4.2+）

if [[ -v foo ]]; then
    echo "foo is set";
else
    echo "foo is unset";
fi

这种方法不会在 set -u 或 set -o nounset 模式下检查未设置的变量时导致错误。

自定义函数 variable-is-set

variable-is-set() {
    declare -p "$1" &>/dev/null
}

if variable-is-set var; then
    echo "var is set";
else
    echo "var is unset";
fi

该函数通过 declare -p 命令检查变量是否已声明，如果已声明则返回状态码 0（成功），否则返回状态码 1。

常见的错误方法

if [ -z "$var" ]; then 
    echo "var is blank"; 
else 
    echo "var is set to '$var'"; 
fi

这种方法的问题在于它无法区分变量未设置和变量设置为空字符串的情况。

核心代码

检查变量是否设置的多种方式示例

# 使用 ${var+x}
var="test"
if [ -z ${var+x} ]; then
    echo "var is unset";
else
    echo "var is set to '$var'";
fi

# 使用 [[ -v ]]
if [[ -v var ]]; then
    echo "var is set";
else
    echo "var is unset";
fi

# 使用自定义函数
variable-is-set() {
    declare -p "$1" &>/dev/null
}
if variable-is-set var; then
    echo "var is set";
else
    echo "var is unset";
fi

不同参数扩展表达式的测试示例

# 测试不同参数扩展表达式
FOO="world"
echo "\${FOO:-hello}: ${FOO:-hello}"
echo "\${FOO-hello}: ${FOO-hello}"
echo "\${FOO:=hello}: ${FOO:=hello}"
echo "\${FOO=hello}: ${FOO=hello}"
echo "\${FOO:?hello}: ${FOO:?hello}"
echo "\${FOO?hello}: ${FOO?hello}"
echo "\${FOO:+hello}: ${FOO:+hello}"
echo "\${FOO+hello}: ${FOO+hello}"

unset FOO
echo "\${FOO:-hello}: ${FOO:-hello}"
echo "\${FOO-hello}: ${FOO-hello}"
echo "\${FOO:=hello}: ${FOO:=hello}"
echo "\${FOO=hello}: ${FOO=hello}"
echo "\${FOO:?hello}: ${FOO:?hello}"
echo "\${FOO?hello}: ${FOO?hello}"
echo "\${FOO:+hello}: ${FOO:+hello}"
echo "\${FOO+hello}: ${FOO+hello}"

最佳实践

• 区分未设置和空字符串：在需要严格区分变量未设置和设置为空字符串的场景中，使用 ${var+x} 或 [[ -v ]] 方法。
• 脚本兼容性：如果脚本需要兼容多个 shell，优先使用 POSIX 标准的方法，如 [ -n "${var+x}" ]。
• 避免错误：在 set -u 模式下，使用 ${var-} 或 ${var:-} 进行变量扩展，避免引用未定义变量导致的错误。

常见问题

引号的使用

虽然在某些情况下引号可以省略，但为了代码的可读性和避免潜在的错误，建议在条件测试中使用引号，如 [ -z "${var+x}" ]。

数组变量的检查

对于数组变量，一些常见的检查方法可能无法正确工作。例如，[ -n "$var" ] 只检查数组的第一个元素是否非空。使用 declare -p 方法可以可靠地检查数组变量是否已设置。

特殊变量的检查

某些特殊变量（如 $!, $@, $#, $$, $*, $?, $-, $0, $1, $2 等）不能使用 declare -p 方法检查，可使用 [ -n "${var+x}" ] 方法。但要注意，在函数中调用时，许多特殊变量的值或存在性可能会改变。