在Bash脚本中检查程序是否存在的方法

技术背景

在编写Bash脚本时，经常需要检查某个程序是否存在，以便在程序存在时执行相应操作，或在程序不存在时给出提示并采取相应的处理措施。不同的检查方法有不同的特点和适用场景。

实现步骤

POSIX兼容方法

使用command -v命令可以检查程序是否存在。示例代码如下：

if ! command -v <the_command> 2>&1 >/dev/null
then
    echo "<the_command> could not be found"
    exit 1
fi

解释：command -v用于查找命令并返回其路径，如果命令不存在则返回空。2>&1 >/dev/null用于将标准输出和错误输出重定向到/dev/null，避免输出不必要的信息。

Bash特定环境方法

• 使用hash：用于检查常规命令。示例：

hash <the_command>

• 使用type：可以检查内置命令和关键字。示例：

type <the_command>

可执行性检查

可以使用[ -x "$(command -v foo)" ]来检查命令是否存在于$PATH中且可执行。示例：

if ! [ -x "$(command -v git)" ]; then
  echo 'Error: git is not installed.' >&2
  exit 1
fi

函数封装方法

可以将检查逻辑封装成函数，方便复用。示例：

command_exists () {
    type "$1" &> /dev/null ;
}

if command_exists mvim ; then
    export VISUAL="mvim --nofork"
fi

检查多个依赖

可以使用循环来检查多个依赖并告知用户状态。示例：

for cmd in latex pandoc; do
  printf '%-10s' "$cmd"
  if hash "$cmd" 2>/dev/null; then
    echo OK
  else
    echo missing
  fi
done

在Makefile中检查

可以在Makefile中使用类似的逻辑来检查程序是否存在。示例：

install:
    @if [[ ! -x "$(shell command -v ghead)" ]]; then \
        echo 'ghead does not exist. Please install it.'; \
        exit -1; \
    fi

Zsh特定方法

在Zsh中，可以使用zsh/parameter模块的commands哈希表来检查命令是否可用。示例：

if (( ${+commands[zsh]} )) && [[ -x $commands[zsh] ]]
then
  echo "zsh is available"
fi

核心代码

以下是几种常见的检查程序是否存在的核心代码示例：

# 使用command -v
command -v foo >/dev/null 2>&1 || { echo >&2 "I require foo but it's not installed.  Aborting."; exit 1; }

# 使用type
type foo >/dev/null 2>&1 || { echo >&2 "I require foo but it's not installed.  Aborting."; exit 1; }

# 使用hash
hash foo 2>/dev/null || { echo >&2 "I require foo but it's not installed.  Aborting."; exit 1; }

最佳实践

• 优先使用POSIX兼容的方法，如command -v，以保证脚本的可移植性。
• 避免使用which命令，因为它可能在不同系统上有不同的行为，且效率较低。
• 将检查逻辑封装成函数，提高代码的复用性和可读性。

常见问题

• which命令的问题：许多操作系统的which命令可能不会设置退出状态，导致if which foo的判断不准确。而且不同系统的which命令可能有自定义的行为。
• type和hash在POSIX中的问题：如果脚本的哈希bang是/bin/sh，type和hash的退出代码在POSIX中定义不太明确，而command的退出状态定义明确，所以使用command -v更安全。
• 非可执行文件的问题：bash在$PATH中找不到可执行文件时可能会返回非可执行文件，需要进行可执行性检查。