Bash编程易错总结大全

Bash Pitfalls文章介绍了 40 多条日常 Bash  编程中，老手和新手都容易忽略的错误编程习惯。每条作者在给出错误的范例上，详细分析与解释错误的原因，同时给出正确的改写建议。文中有不少引用的文章，也值得大家仔细阅读。仔细阅读了这篇文章后，收获很多，不感独享，把这篇文章以半翻译半笔记的形式分享给大家。

1.for i in $(ls *.mp3)

Bash 写循环代码的时候，确实比较容易犯下面的错误：

for i in $(ls *.mp3); do    # 错误!
    some command $i         # 错误!
done

for i in $(ls)              # 错误!
for i in `ls`               # 错误!

for i in $(find . -type f)  # 错误!
for i in `find . -type f`   # 错误!

files=($(find . -type f))   # 错误!
for i in ${files[@]}        # 错误!

这里主要两个问题：

• 使用命令展开时不带引号，其执行结果会使用 IFS 作为分隔符，拆分成参数传递给 for 循环处理；

• 不应该让脚本去解析 ls 命令的结果；

我们不能避免某些文件名中包含空格，Shell 会对 $(ls *.mp3) 展开的结果会被做单词拆分 (WordSplitting) 的处理。假设有一个文件，名字为 01 - Don't Eat the Yellow Snow.mp3，for 循环处理的时候，会今次遍历文件名中的每个单词：01, -, Don't, Eat 等等：

$ for i in $(ls *.mp3); do echo $i; done
01
-
Don't
Eat
the
Yellow
Snow.mp3

比这更差的情况是，上面命令展开的结果可能被 Shell 进一步处理，比如文件名展开。比如，ls 执行的结果中包含*号，按照通配符的规则 , * 号会被展开成当前目录下的所有文件 :

$ touch "1*.mp3" "1.mp3" "11.mp3" "12.mp3"
$ for i in $(ls *.mp3); do echo $i; done
1*.mp3 1.mp3 11.mp3 12.mp3
1.mp3
11.mp3
12.mp3
1.mp3
11.mp3
12.mp3

不过，在这种场景下，你即使加上引号，也是无济于事的：

$ for i in "$(ls *.mp3)"; do echo --$i--; done
--1*.mp3 1.mp3 11.mp3 12.mp3--

加上引号后，ls 执行的结果会被当成一个整体，所以 for 循环只会执行一次，达不到预期的效果。

事实上，这种情况下，根本不需要使用 ls 命令。ls 命令的结果本身就设计成给人读的，而不是给脚本解析的。正确的处理方法是，直接使用文件名展开（通配符）的功能：

$ for i in *.mp3; do
>     echo "$i"
> done
1*.mp3
1.mp3
11.mp3
12.mp3

文件名展开是位于各种展开（花括号展开、变量替换、命令展开等）功能中的最后一个环节，所以不会有之前不带引号的命令展开的副作用。如果你需要递归地处理文件，可以考虑使用 Find 命令。

到这一步，之间的问题看样子已经修复了。但是，如果你进一步思考，假设当前目录上没有文件时会怎么样？没有文件的时候，*.mp3 不会被展开直接传递给 for 循环处理，所以这个时候循环还是会执行一次。这种情况不是我们预期的行为。保险起见，可以在循环处理的时候，检查下文件是否存在：

# POSIX
for i in *.mp3; do
    [ -e "$i" ] || continue
    some command "$i"
done

如果你有使用引号和避免单词拆分的习惯，你完全可以避免很多错误。

注意下循环体内部的 "$i"，这里会导致下面我们要说的另外一个比较容易犯的错误。

2. cp $file $target

上面的命令有什么问题呢？如果你提前知道，

和target 文件名中不会包含空格或者*号。否则，这行命令执行前在经过单词拆分和文件名展开的时候会出现问题。所以，两次强调，在使用展开的地方切勿忘记使用引号：

$ cp -- "$file" "$target"

如果不带引号，当你执行如下命令时就会出错：

$ file="01 - Don't Eat the Yellow Snow.mp3"
$ target="/tmp"
$ cp $file $target
cp: cannot stat ‘01’: No such file or directory
..

如果带上引号，就不会有上面的问题，除非文件名以 '-' 开头，在这种情况下，cp 会认为你提供的是一个命令行选项，这个错误下面会介绍。

3.文件名中包含短横 '-'

文件名以 '-' 开头会导致许多问题，*.mp3 这种通配符会根据当前的locale展开成一个列表，但在绝大多数环境下，'-' 排序的时候会排在大多数字母前。这个展开的列表传递给有些命令的时候，会错误的将-filename 解析成命令行选项。这里有两种方法来解决这个问题。

第一种方法是在命令和参数之间加上--，这种语法告诉命令不要继续对--之后的内容进行命令行参数 / 选项解析：

$ cp -- "$file" "$target"

这种方法可以解这个问题，但是你需要在每个命令后面都要加上--，而且依赖具体的命令解析的方式，如果一些命令不兼容这种约定俗成的规范，这种做法是无效的。

另外一种方法是，确保文件名都使用相对或者绝对的路径，以目录开头：

for i in ./*.mp3; do
    cp "$i" /target
    ...
done

这种情况下，即使某个文件以-开头，展开后文件名依然是 ./-foo.mp3 这种形式，完全不会有问题。

4.[ $foo = "bar" ]

这是一个与第 2 个问题类似的问题，虽然用到了引号，但是放错了位置，对于字符串字面值，除非有特殊符号，否则不大需要用引号括起来。但是，你应该把变量的值用括号括起来，从而避免它们包含空格或能通配符，这一点我们在前面的问题中都解释过。

这个例子在以下情况下会出错：

• 如果[中的变量不存在，或者为空，这个时候上面的例子最终解析结果是：

[ = "bar" ] # 错误 !

并且执行会出错：unary operator expected，因为 = 是二元操作符，它需要左右各一个操作数。

• 如果变量值包含空格，它首先在执行之前进行单词拆分，因此 [命令看到的样子可能是这样的：

[ multiple words here = "bar" ];

正确的做法应该是：

# POSIX
[ "$foo" = bar ]

这种写法，在 POSIX 兼容的实现中都不会有问题，即使 $foo 以短横 "-" 开头，因为 POSIX 实现的 test 命令通过传递的参数来确定执行的行为。

只有一些非常古老的 shell 可能会遇到问题，这个时候你可以使用下面的写法来解决（相信你肯定看到过这种写法）：

# POSIX / Bourne
[ x"$foo" = xbar ]

在 Bash 中，还有另外一种选择是使用[[关键字：