《Go语言四十二章经》第三十四章 命令行 flag 包

    写命令行程序时需要对命令参数进行解析,这时我们可以使用os库。os可以通过变量Args来获取命令参数,os.Args返回一个字符串数组,其中第一个参数就是执行文件本身。

    编译执行后执行

    1. [./cmd -user=root]

    这种方式操作起来要自己封装,比较费时费劲。

    34.2 flag包

    Go提供了flag库,可以很方便的操作命名行参数,下面介绍下flag的用法。

    几个概念:

    1)命令行参数(或参数):是指运行程序提供的参数

    2)已定义命令行参数:是指程序中通过flag.Xxx等这种形式定义了的参数

    3)非flag(non-flag)命令行参数(或保留的命令行参数):先可以简单理解为flag包不能解析的参数

    一:flag参数定义或绑定

    定义flags有两种方式:

    1)flag.Xxx(),其中Xxx可以是Int、String等;返回一个相应类型的指针,如:

    2)flag.XxxVar(),将flag绑定到一个变量上,如:

    另外,还可以创建自定义flag,只要实现flag.Value接口即可(要求receiver是指针),这时候可以通过如下方式定义该flag:

    flag.Var(&flagVal, “name”, “help message for flagname”)

    命令行flag的语法有如下三种形式:
    -flag // 只支持bool类型
    -flag=x
    -flag x // 只支持非bool类型

    二:flag参数解析

    根据Parse()中for循环终止的条件,当parseOne返回false,nil时,Parse解析终止。

    1. return false, nil

    当遇到单独的一个“-”或不是“-”开始时,会停止解析。比如:./cli – -f 或 ./cli -f

    这两种情况,-f都不会被正确解析。像这些参数,我们称之为non-flag参数

    parseOne方法中接下来是处理-flag=x,然后是-flag(bool类型)(这里对bool进行了特殊处理),接着是-flag x这种形式,最后,将解析成功的Flag实例存入FlagSet的actual map中。

    Arg(i int)和Args()、NArg()、NFlag()
    Arg(i int)和Args()这两个方法就是获取non-flag参数的;NArg()获得non-flag个数;NFlag()获得FlagSet中actual长度(即被设置了的参数个数)。

    flag解析遇到non-flag参数就停止了。所以如果我们将non-flag参数放在最前面,flag什么也不会解析,因为flag遇到了这个就停止解析了。

    三:分支程序

    根据参数值,代码进入分支程序,执行相关功能。上面代码提供了 -h 参数的功能执行。

    Cobra是一个用来创建强大的现代CLI命令行的Go开源库。开源包可能比较合适构建更为复杂的命令行程序。开源地址: