set -x 打印的不是你写的命令:xtrace 的五个坑与可抄的 PS4
最小复现:
set -x
foo="bar baz"
[ $foo = test ]
stderr 上是:
+ foo='bar baz'
+ '[' bar baz = test ']'
bash: [: too many arguments
第二行里 bar 和 baz 是两个独立单词——后面几个坑都从这里长出来。
坑 1:打印的是展开后的结果,不是源码
-x 在展开之后、执行之前打印简单命令及其参数。看 trace 要看的是「Bash 最终拿到的参数」,加不加引号会直接体现在输出里:
foo="bar baz"
[ $foo = test ] # + '[' bar baz = test ']'
[ "$foo" = test ] # + '[' 'bar baz' = test ']'
Bash 用单引号标出识别出来的每个词。第一行 bar、baz 分开了,[ 拿到 4 个参数,报 too many arguments;第二行 'bar baz' 是一个词,正常比较。这行 trace 本身就是判断词分割是否发生的依据。
坑 2:PS4 必须用单引号
PS4="+${LINENO}: " # 错
PS4='+${LINENO}: ' # 对
双引号在赋值那一刻就展开了 ${LINENO},之后每行显示同一个固定行号;单引号让 Bash 每次打印前再展开,行号才会跟着走。
坑 3:+/++ 的深度来自 PS4 首字符
嵌套调用时前缀变长,不是另有一套深度标记:Bash 把 PS4 的第一个字符重复 depth 次,再接上 PS4 的剩余部分。默认 + ,二层就是 ++ ;首字符换成 |,二层就是 ||。自定义 PS4 时留一个固定首字符(比如 +),否则 trace 的层级一眼看不出来。
坑 4:trace 默认走 stderr,会和脚本报错混在一起
set -x 写 fd 2。set -x 2>trace.log 会把脚本自身写的错误信息一并重定向,问题反而藏起来了。Bash 4.1 起可用 BASH_XTRACEFD 分离:
exec 9>trace.log
BASH_XTRACEFD=9
set -x
# ...
set +x
unset BASH_XTRACEFD
unset BASH_XTRACEFD(或赋空串)把 trace 送回 stderr,同时关闭 fd 9:文件描述符在 BASH_XTRACEFD 被 unset 或赋新值时就会关闭。所以结尾不要再补一句 exec 9>&-。
有一条边界要记牢:把 BASH_XTRACEFD 设成 2(标准错误本身)再 unset,会导致 stderr 被关闭。之后所有 echo >&2、2> 重定向、依赖 stderr 的子进程都会出问题。要么用专用 fd,要么不设。
坑 5:命令替换和 subshell 会继承 -x
$(...)、( ... ) 里执行时 xtrace 是开着的,前缀按嵌套深度加深,输出量迅速膨胀。只调一段就成对写:
set -x
# 需要观察的几行
set +x
函数里 set -x 忘了 set +x,回到调用方会继续打印,这是最常见的「trace 停不下来」。
可抄的 PS4
export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
单引号必须保留。函数外输出:
+(somefile.bash:412): echo 'Hello world'
函数内输出:
+(somefile.bash:412): myfunc(): echo 'Hello world'
${FUNCNAME[0]:+...} 让函数外不出现空冒号。核对某个变量的真实内容时配 printf '%q',比盯着 trace 数引号可靠。
边界
-x 只跟踪简单命令、for、case、select、算术 for 及其参数和关联词表;复合结构本身(if、while、函数体的 {)不会单独打印一行,但里面的条件命令会打印。所以看到 + [[ -f x ]] 而没有 + if 是正常的。
-n 只读不执行,用来查语法错误;它不展开、不执行,看不到任何运行时值,不能替代 -x。
静态检查用 ShellCheck;需要断点、单步、变量观察时用 bashdb。