检查传递给 Bash 脚本的参数数量

Question

如果未满足所需的参数计数，我希望我的 Bash 脚本打印一条错误消息。

我尝试了以下代码：

#!/bin/bash
echo Script name: $0
echo $# arguments 
if [$# -ne 1]; 
    then echo "illegal number of parameters"
fi

由于某些未知原因，我收到以下错误：

test: line 4: [2: command not found

我做错了什么？

Answer 1

就像任何其他简单命令一样，[ ... ] 或 test 在其参数之间需要空格。

if [ "$#" -ne 1 ]; then
    echo "Illegal number of parameters"
fi

或者

if test "$#" -ne 1; then
    echo "Illegal number of parameters"
fi

建议

在 Bash 中，更喜欢使用 [[ ]]，因为它不会对其变量进行分词和路径名扩展，除非它是表达式的一部分，否则可能不需要引用。

[[ $# -ne 1 ]]

它还具有其他一些功能，例如不带引号的条件分组、模式匹配（与extglob 的扩展模式匹配）和正则表达式匹配。

以下示例检查参数是否有效。它允许一个或两个参数。

[[ ($# -eq 1 || ($# -eq 2 && $2 == <glob pattern>)) && $1 =~ <regex pattern> ]]

对于纯算术表达式，使用(( )) 可能会更好，但在[[ ]] 中仍然可以使用其算术运算符，如-eq、-ne、-lt、-le、@ 987654344@，或-ge，将表达式作为单个字符串参数：

A=1
[[ 'A + 1' -eq 2 ]] && echo true  ## Prints true.

如果您还需要将它与[[ ]] 的其他功能结合起来，这应该会很有帮助。

请注意，[[ ]] 和 (( )) 是与 if、case、while 和 for 具有相同解析级别的关键字。

也正如Dave 所建议的那样，错误消息最好发送到stderr，这样在重定向stdout 时它们就不会被包含在内：

echo "Illegal number of parameters" >&2

退出脚本

当传递无效参数时让脚本退出也是合乎逻辑的。 ekangas 已经在 comments 中提出了这个建议，但是有人编辑了这个答案，让它以 -1 作为返回值，所以我不妨做对。

-1 虽然被 Bash 接受为 exit 的参数，但没有明确记录，也不适合用作常见建议。 64 也是最正式的值，因为它在 sysexits.h 和 #define EX_USAGE 64 /* command line usage error */ 中定义。大多数像ls 这样的工具也会在无效参数上返回2。我也曾经在我的脚本中返回2，但最近我不再关心，只是在所有错误中使用1。但是让我们将2 放在这里，因为它是最常见的并且可能不是特定于操作系统的。

if [[ $# -ne 1 ]]; then
    echo "Illegal number of parameters" >&2
    exit 2
fi

参考文献

• Bash Conditional Expressions
• Conditional Constructs
• Pattern Matching
• Word Splitting
• Filename Expansion (prev. Pathname Expansion)
• Simple Commands

Answer 2

如果您正在处理数字，使用arithmetic expressions 可能是个好主意。

if (( $# != 1 )); then
    >&2 echo "Illegal number of parameters"
fi

>&2用于将错误信息写入stderr。

Answer 3

On []: !=, =, == ... 是 string 比较运算符，-eq, -gt ... 是 算术 二元运算符。

我会使用：

if [ "$#" != "1" ]; then

或者：

if [ $# -eq 1 ]; then

Answer 4

如果您只对缺少特定参数的情况感兴趣，Parameter Substitution 非常棒：

#!/bin/bash
# usage-message.sh

: ${1?"Usage: $0 ARGUMENT"}
#  Script exits here if command-line parameter absent,
#+ with following error message.
#    usage-message.sh: 1: Usage: usage-message.sh ARGUMENT

Answer 5

可以使用以下方法完成一个简单的单行：

[ "$#" -ne 1 ] && ( usage && exit 1 ) || main

这分解为：

1. 测试 bash 变量的参数大小 $# 不等于 1（我们的子命令数）
2. 如果为 true，则调用 usage() 函数并以状态 1 退出
3. 否则调用 main() 函数

注意事项：

• usage() 可以只是简单的 echo "$0: params"
• main 可以是一个长脚本

Answer 6

查看this bash 备忘单，它可以提供很多帮助。

要检查传入参数的长度，请使用"$#"

要使用传入的参数数组，请使用"$@"

检查长度和迭代的示例是：

myFunc() {
  if [[ "$#" -gt 0 ]]; then
    for arg in "$@"; do
      echo $arg
    done
  fi
}

myFunc "$@"

这篇文章对我有帮助，但对我和我的情况来说缺少一些东西。希望这对某人有所帮助。

Answer 7

这里有一个简单的一行来检查是否只给出了一个参数，否则退出脚本：

[ "$#" -ne 1 ] && echo "USAGE $0 <PARAMETER>" && exit

Answer 8

这里有很多很好的信息，但我想添加一个我觉得有用的简单 sn-p。

它和上面的有什么不同？

• 将使用情况打印到 stderr，这比打印到 stdout 更合适
• 返回这个其他answer中提到的退出代码
• 无法将其制成单衬...

_usage(){
    _echoerr "Usage: $0 <args>"
}

_echoerr(){
    echo "$*" >&2
}

if [ "$#" -eq 0 ]; then # NOTE: May need to customize this conditional
    _usage
    exit 2
fi
main "$@"

Answer 9

如果您想安全起见，我建议使用 getopts。

这是一个小例子：

    while getopts "x:c" opt; do
      case $opt in
        c)
          echo "-$opt was triggered, deploy to ci account" >&2
          DEPLOY_CI_ACCT="true"
          ;;
            x)
              echo "-$opt was triggered, Parameter: $OPTARG" >&2 
              CMD_TO_EXEC=${OPTARG}
              ;;
            \?)
              echo "Invalid option: -$OPTARG" >&2 
              Usage
              exit 1
              ;;
            :)
              echo "Option -$OPTARG requires an argument." >&2 
              Usage
              exit 1
              ;;
          esac
        done

在此处查看更多详细信息，例如 http://wiki.bash-hackers.org/howto/getopts_tutorial

Answer 10

你应该在测试条件之间添加空格：

if [ $# -ne 1 ]; 
    then echo "illegal number of parameters"
fi

我希望这会有所帮助。