getopt & getopts

https://blog.csdn.net/weixin_30482027/article/details/116578311

linux 运行命令行参数,linux shell命令行选项与参数用法详解¶

1. 综述¶

问题描述：在linux shell中如何处理tail -n 10 access.log这样的命令行选项？

在bash中，可以用以下三种方式来处理命令行参数，每种方式都有自己的应用场景。

直接处理，依次对$1,$2,...,$n进行解析，分别手工处理；
getopts来处理，单个字符选项的情况(如：-n 10 -f file.txt等选项)；
getopt，可以处理单个字符选项，也可以处理长选项long-option(如：--prefix=/home等)。

总结：小脚本手工处理即可，getopts能处理绝大多数的情况，getopt较复杂、功能也更强大。

2. 命令行的三种处理方式¶

2.1 直接手工处理位置参数¶

必须要要知道几个变量，

Bash

$0：即命令本身，相当于c/c++中的argv[0]
$1：第一个参数, $2, $3, $4 ... ：第2、3、4个参数，依次类推。
$#: 参数的个数，不包括命令本身
$@: 参数本身的列表，也不包括命令本身


*和@相同，"*"和"@"（加引号）并不同，"*"将所有的参数解析成一个字符串，面"@"是一个参数数组。

手工处理方式能满足多数的简单需求，配合shift使用也能构造出强大的功能，但处理复杂选项时建议用下面的两种方法。

例子，(getargs.sh)：

Bash

#!/bin/bash

if [ $# -lt 1 ]; then
  echo "error.. need args"
  exit 1
fi

echo "commond is $0"
echo "args are:"
for arg in "$@"
do
  echo $arg
done

运行命令：

Bash

./getargs.sh 11 22 zk
commond is ./getargs.sh
args are:
11
22
zk

2.2 getopts (shell内置命令)¶

getopts被shell程序用来分析位置参数，optstring包含需要被识别的选项字符，如果这里的字符后面跟着一个冒号，表明该字符选项需要一个参数，其参数需要以空格分隔。冒号和问号不能被用作选项字符。getopts每次被调用时，它会将下一个选项字符放置到变量name中。

变量OPTIND是下一个要被处理的位置参数的索引，初始值为1。shell不会自动的复位OPTIND，如果想再次对位置参数进行分析，则需要手动对OPTIND进行复位。当选项需要参数时，getopts将参数放置在变量OPTARG中。

当所有的位置参数分析结束，getopts退出并返回一个大于0的值，OPTIND变为首个不是选项的位置参数的索引，name被置为'?'。默认情况下getopts会去分析传入的位置参数，但如果args有值，则只会分析args里的参数，args只支持形如-abc形式。

如果遇到错误，getopts会打印出错误信息，但如果optstring第一个字符是冒号，或者变量OPTERR被置为0（此项只是不打印错误信息，不会在出错后设置OPTARG的值），则会进入静默模式，不会打印错误信息。遇到的错误通常有两种情况： 1、无效的选项，此时name会被置为'?'。静默模式下，会将此无效选项置于OPTARG。非静默模式，打印错误信息，并且unset OPTARG。 2、选项需要的参数未提供，静默模式下，name会被置为':'，无效选项会置于OPTARG。非静默模式，name被置为'?'，unset OPTARG并打印出错信息。

getopts如果遇到一个选项（无论是否有效），返回true(0)。如果遇到结束或者产生错误，返回false

处理命令行参数是一个相似而又复杂的事情，为此，c提供了getopt/getopt_long等函数，c++的boost提供了options库，在shell中，处理此事的是getopts和getopt。

getopts/getopt的区别，getopt是个外部binary文件，而getopts是shell builtin。

复制代码代码示例:

Bash

[root@jbxue ~]$ type getopt

getopt is /usr/bin/getopt

[root@jbxue ~]$ type getopts

getopts is a shell builtin

getopts不能直接处理长的选项(如：--prefix=/home等)

关于getopts的使用方法，可以man bash 搜索getopts

getopts有两个参数，第一个参数是一个字符串，包括字符和“：”，每一个字符都是一个有效的选项，如果字符后面带有“：”，表示这个字符有自己的参数。getopts从命令中获取这些参数，并且删去了“-”，并将其赋值在第二个参数中，如果带有自己参数，这个参数赋值在“optarg”中。提供getopts的shell内置了optarg这个变变，getopts修改了这个变量。

Bash

optarg: 存储相应选项的参数，
optind: 总是存储原始参数列表中下一个要处理的元素位置。

while getopts ":a:bc" opt : 第一个冒号表示忽略错误；字符后面的冒号表示该选项必须有自己的参数

Bash

#!/bin/bash

# echo $*
# echo $@

while getopts "a:bc" opt
do
  case $opt in
    a ) echo $OPTARG
        echo $OPTIND;;
    b ) echo "b $OPTIND";;
    c ) echo "c $OPTIND";;
    ? ) echo "error"
        exit 1;;
  esac
done

echo $OPTIND


# 通过shift $(($OPTIND - 1))的处理
# $*中就只保留了除去选项内容的参数，可以在其后进行正常的shell编程处理了
shift $(($OPTIND - 1))

echo $0  #  ./getopts.sh
echo $*

复制代码代码示例:

Bash

 ./getopts.sh -a 11 -b -c
11
3
b 4
c 5
5
./getopts.sh

2.3 getopt(一个外部工具)¶

https://www.cnblogs.com/lxhbky/p/14189189.html

https://blog.csdn.net/weixin_43999327/article/details/118968405

Bash

-o: 表示短选项，两个冒号表示该选项有一个可选参数，可选参数必须紧贴选项，如-carg 而不能是-c arg
--long: 表示长选项

例子，(getopt.sh)：

复制代码代码示例:

Bash

#!/bin/bash

# 使用getopt解析命令行参数的示例脚本
# 仅适用于Bash
# 解析规则:
# -a/--a-long: 无参数选项
# -b/--b-long: 必需参数选项
# -c/--c-long: 可选参数选项

# 使用getopt生成参数解析模板
temp=$(getopt -o ab:c:: --long a-long,b-long:,c-long:: \
-n 'getopt.sh' -- "$@")

# 检查getopt执行状态
if [ $? != 0 ]; then
    echo "参数解析失败，程序终止..." >&2
    exit 1
fi

# 重组参数顺序
eval set -- "$temp"

# 循环处理解析后的参数
while true; do
    case "$1" in
        -a|--a-long)
            echo "选项a"
            shift
            ;;
        -b|--b-long)
            echo "选项b，参数为 \`$2'"
            shift 2
            ;;
        -c|--c-long)
            # 处理可选参数
            case "$2" in
                "")
                    echo "选项c，无参数"
                    shift 2
                    ;;
                *)
                    echo "选项c，参数为 \`$2'"
                    shift 2
                    ;;
            esac
            ;;
        --)
            shift
            break
            ;;
        *)
            echo "内部错误!"
            exit 1
            ;;
    esac
done

# 输出剩余未解析的参数
echo "剩余参数:"
for arg in "$@"; do
    echo "--> \`$arg'"
done

代码分析¶

参数定义：
-o ab:c::：定义短选项，a无参数，b必需参数，c可选参数
--long a-long,b-long:,c-long::：定义长选项，规则同短选项
-n 'getopt.sh'：错误信息前缀
参数解析流程：
使用getopt生成格式化参数列表
通过eval set -- "$temp"重组参数顺序
使用case语句处理不同选项
选项处理规则：
-a/--a-long：无参数，直接输出选项信息
-b/--b-long：必需参数，后跟参数值
-c/--c-long：可选参数，参数必须紧跟选项（如-c33）
剩余参数处理：
使用--标记选项结束
之后的参数作为普通参数处理

示例运行分析¶

执行命令：

Bash

./getopt.sh --b-long abc -a -c33 remain

输出结果：

Bash

选项b，参数为 `abc'
选项a
选项c，参数为 `33'
剩余参数:
--> `remain'

解析过程：

--b-long abc：长选项b-long带参数abc
-a：短选项a
-c33：短选项c带参数33（参数紧跟选项）
remain：剩余普通参数