shell自定义长选项参数，getopt用法及注意事项

博主：想长胖的阿鹏
发布时间：2022 年 10 月 22 日
247次浏览
暂无评论
5165字数
分类： Shell Linux

> 转载文章，排版可能出现错误，建议到原文阅读：
> [shell小技巧–长选项参数getopt用法 - 腾讯云开发者社区-腾讯云 (tencent.com)](https://cloud.tencent.com/developer/article/1671654)
> [(23条消息) getopt长参数（长选项）获取不到参数BUG_weixin_34257076的博客-CSDN博客](https://blog.csdn.net/weixin_34257076/article/details/91994182)

在编写shell脚本时，往往需要我们传入相应的参数，来完成我们的一些目的，传入参数大体有三种方法：

1、`$1` `$2` .... 按顺序取参

2、getopts，这是shell内置的一种处理参数的方法，可以处理单个字符选项，例如 -h 192.168.1.1 这种形式的参数

3、getopt，这是unix自带的一种处理命令行参数的方法，既可以处理单个字符选项，也可以处理长选项，例如：--host=192.168.1.1

这里介绍下getopt的用法

### 使用介绍

```js
SYNOPSIS
       getopt optstring parameters
       getopt [options] [--] optstring parameters
       getopt [options] -o|--options optstring [options] [--] parameters
```

复制

### 参数介绍

```js
OPTIONS
       -a, --alternative
              Allow long options to start with a single '-'.

-h, --help
              Output a small usage guide and exit successfully.  No other output is generated.

-l, --longoptions longopts
              The long (multi-character) options to be recognized.  More than one option name may be specified at once, by separating the names with commas.  This option may be given more than once, the longopts are  cumulative.
              Each long option name in longopts may be followed by one colon to indicate it has a required argument, and by two colons to indicate it has an optional argument.

-n, --name progname
              The name that will be used by the getopt(3) routines when it reports errors.  Note that errors of getopt(1) are still reported as coming from getopt.

-o, --options shortopts
              The  short  (one-character)  options to be recognized.  If this option is not found, the first parameter of getopt that does not start with a '-' (and is not an option argument) is used as the short options string.
              Each short option character in shortopts may be followed by one colon to indicate it has a required argument, and by two colons to indicate it has an optional argument.  The first character of shortopts may be  '+'
              or '-' to influence the way options are parsed and output is generated (see section SCANNING MODES for details).

-q, --quiet
              Disable error reporting by getopt(3).

-Q, --quiet-output
              Do not generate normal output.  Errors are still reported by getopt(3), unless you also use -q.

-s, --shell shell
              Set quoting conventions to those of shell.  If no -s argument is found, the BASH conventions are used.  Valid arguments are currently 'sh' 'bash', 'csh', and 'tcsh'.

-u, --unquoted
              Do not quote the output.  Note that whitespace and special (shell-dependent) characters can cause havoc in this mode (like they do with other getopt(1) implementations).

-T, --test
              Test  if  your  getopt(1)  is  this  enhanced  version or an old version.  This generates no output, and sets the error status to 4.  Other implementations of getopt(1), and this version if the environment variable
              GETOPT_COMPATIBLE is set, will return '--' and error status 0.

-V, --version
              Output version information and exit successfully.  No other output is generated.
```

复制

### shell实例参考

```js
#处理参数，规范化参数
ARGS=`getopt -a -o nmc:H:N:G:D: --long name:,mem:,cpu:,host:,netmask:,gateway:,dns:,help -- "$@"`
if [ $? != 0 ];then
        echo "Terminating..."
        exit 1
fi
#重新排列参数顺序
eval set -- "${ARGS}"
#通过shift和while循环处理参数
while :
do
    case $1 in
        -n|--name)
            name=$2
            shift
            ;;
        -m|--mem)
            mem=$2
            shift
            ;;
        -c|--cpu)
            cpu=$2
            shift
            ;;
        -h|--host)
            host=$2
            shift
            ;;
        -n|--netmask)
            netmask=$2
            shift
            ;;
        -g|--gateway)
            gateway=$2
            shift
            ;;
        -d|--dns)
            dns=$2
            shift
            ;;
        --help)
            usage
            ;;
        --)
            shift
            break
            ;;
        *)
            echo "Internal error!"
            exit 1
            ;;
    esac
shift
done
echo "name: $name"
echo "mem: $mem"
echo "cpu: $cpu"
echo "host: $host"
echo "netmask: $netmask"
echo "gateway: $gateway"
echo "dns: $dns"
```

### 踩坑：getopt长参数（长选项）获取不到第一个参数

**BUGS**

```
The  syntax  if  you  do  not  want  any  short option variables at all is not very intuitive (you have to set them explicitly to the empty  string).

如果你确实不想要任何短参数（短选项），那么语法不是很适合。（你必须用空字符串显示的声明）
```

例如：

```bash hljs
getopt -al arg1:,arg2:,agr3: -- "$@"
```

由于上述语法只声明了长参数（长选项），没有任何短参数（短选项），解析的时候会遇到第一个参数的值无法取到的问题。

如果不想用任何短参数（短选项），以下为正确的写法：

```bash hljs
getopt -o "" -al connect:,sql:,parallel:,id: -- "$@"
```

区别在于加了一个`-o`，`-o`表示短参数（短选项），空字符表示不用任何短参数（短选项）。

总结：

遇到问题，应该先去文档里找答案。

这个问题就是通过 man getopt 命令获取帮助文档找到的解决方法。

另外 `$@` 表示参数列表，一定要加引号，这样写 `"$@"`,且前面的 -- 不能省略。

最后修改：2022 年 10 月 22 日 09 : 05 PM

要多恰饭才能长胖

发表评论取消回复

评论 *

私密评论

名称 *

🎲

邮箱

地址

shell自定义长选项参数，getopt用法及注意事项

想长胖的阿鹏 • 2022 年 10 月 22 日