Go命令行解析flag包之扩展新类型-免费源码丞旭猿-丞旭猿

上篇文章说到，除布尔类型Flag，flag 支持的还有整型（int、int64、uint、uint64）、浮点型（float64）、字符串（string）和时长（duration）。

flag 内置支持能满足大部分的需求，但某些场景，需要自定义解析规则。一个优秀的库肯定要支持扩展的。本文将介绍如何为 flag 扩展一个新的类型支持？

扩展目标

在gvg这个小工具中，list子命令支持获取 Go 的版本列表。但版本的信息来源有多处，比如installed（已安装）、local（本地仓库）和remote（远程仓库）。

查看下list的帮助信息，如下：

NAME:
   gvg list - list go versions

USAGE:
   gvg list[commandoptions][arguments...]OPTIONS:
   --origin value  the origin of version information , such as installed, local, remote(default:"installed")

可以看出，list子命令支持一个Flag选项，--origin。它用于指定版本信息的来源，允许值的范围是installed、local和remote。

如果要求不严格，用StringVar也可以实现。但问题是，使用String，即使输入不在指定范围也能成功解析，不够严谨。虽说在获取后也可以检查，但还是不够灵活、可配置型也差。

接下来，我们要实现一个新的类型的Flag，使选项的值必需在指定范围，否则要给出一定的错误提示信息。

实现思路

如何展一个新类型呢？

可以参考 flag 包内置类型的实现思路，比如flag.DurationVar。Duration不是基础类型，解析结果是存放到了time.Duration类型中，可能更有参考价值。

进入到flag.DurationVar查看源码，如下：

funcDurationVar(p*time.Duration,namestring,valuetime.Duration,usagestring){CommandLine.Var(newDurationValue(value,p),name,usage)}

通过newDurationValue创建了一个类型为durationValue的变量，并传入到了CommandLine.Var方法中。

如果继续往下追，会根据 Value 创建一个Flag变量。如下：

func(f*FlagSet)Var(valueValue,namestring,usagestring){flag:=&Flag{name,usage,value,value.String()}...}

从Var的定义可以看出，它的第一个参数类型是Value接口类型，也就说，durationValue 是实现了Value接口的类型。

注意，源码中出现的FlagSet可以先忽略，它是下篇介绍子命令时重点关注的对象。

看下Value的定义，如下：

typeValueinterface{String()stringSet(string)error}

那么，durationValue的实现代码如何？

// 传入参数分别是默认值和获取 Flag 值的变量地址funcnewDurationValue(valtime.Duration,p*time.Duration)*durationValue{// 将默认值设置到 p 上*p=val// 使用 p 创建新的类型，保证可以获取到解析的结果return(*durationValue)(p)}// Set 方法负责解析传入的值func(d*durationValue)Set(sstring)error{v,err:=time.ParseDuration(s)iferr!=nil{err=errParse}*d=durationValue(v)returnerr}// 获取真正的值func(d*durationValue)String()string{return(*time.Duration)(d).String()}

核心在两个地方。

一个是创建新类型变量时，要使用传入的变量地址创建新类型变量，以实现将解析结果放到其中，让前端能获取到，二是Set方法中实现命令行传入字符串的解析。

逻辑梳理

看完上个小节，基本已经了解如何扩展一个新类型了。本质是是实现Value接口。

再看下之前提到的几个变量，分别是存放解析结果的指针、解析命令行输入的Value和表示一个选项的Flag。对应于flag.DurationVar，这个变量的类型分别是*time.Duration、durationValue和Flag。

比如有duration=1h，大致流程是首先从os.Args获取参数，按规则解析出选项名称duration，查找是否存在名称为duration的Flag，如果存在，使用Flag.Value.Set解析1h，如果不满足duration的要求，将给出错误提示。

实现新类型

现在实现文章开头要求的目标。

新类型定义如下：

typestringEnumValuestruct{options[]stringp*string}

名为StringEnumValue，即字符串枚举。它有options和p两个成员，options指定一定范围的值，p是string指针，保存解析结果的变量的地址。

下面定义创建StringEnumValue变量的函数newStringEnumValue，代码如下：

funcnewStringEnumValue(valstring,p*string,options[]string)*StringEnumValue{*option=valreturn&stringEnumValue{options:options,p:p}}

除了val和p两个必要的输入外，还有一个string切片类型的数，名为options，它用于范围的限定。而函数主体，首先设置默认值，然后使用options和p创建变量返回。

Set是核心方法，解析命令行传入字符串。代码如下：

func(s*StringEnumValue)Set(vstring)error{for_,option:=ranges.options{ifv==option{*(s.p)=vreturnnil}}returnfmt.Errorf("must be one of %v",s.options)}

循环检查输入参数v是否满足要求。定义如下：

最后是String()方法，

func(s*StringEnumValue)String()string{return*(s.p)}

返回p指针中的值。前面分析实现思路时，Flag在设置默认值时就调用了它。

使用 StringEnumValue

直接看代码吧。如下：

varoriginstringfuncinit(){flag.Var(newStringEnumValue("installed",// 默认值&origin,[]string{"installed","local","remote"},),"origin",`the origin of version information, such as installed, local, remote (default: "installed")`,)}funcmain(){flag.Parse()fmt.Println(option)}

重点就是flag.Var(newStringEnumValue(...)，...)。如果觉得有点啰嗦，希望和其他类型新建过程相同，在这个基础上可以再包装。代码如下：

funcStringEnumVar(p*string,namestring,options[]string,defValstring,usagestring){flag.Var(newStringEnumValue(defVal,p,options),name,usage)}

编译测试下，结果如下：

$ gvg --origin=any
invalid value"any"forflag -origin: must be one of[installedlocalremote]Usage of gvg:
  -origin value
    the origin of version information, such as installed, local, remote(default installed)$ gvg --origin=remote
origin remote

总结

本文介绍了如何为 flag 扩展一个类型支持，通过分析源码理清实现思路。最后创建了一个只接收指定范围值 Value。

欢迎关注我的微信公众号。

声明：本文部分素材转载自互联网，如有侵权立即删除。

1. 本站所有资源来源于用户上传和网络，如有侵权请邮件联系站长！邮箱：cxysz1@tom.com
2. 分享目的仅供大家学习和交流，您必须在下载后24小时内删除！
3. 不得使用于非法商业用途，不得违反国家法律。否则后果自负！
4. 本站提供的源码、模板、插件等等其他资源，都不包含技术服务请大家谅解！
5. 如有链接无法下载、失效或广告，请联系管理员处理！
6. 本站资源售价只是赞助，收取费用仅维持本站的日常运营所需！
7. 如遇到加密压缩包，请使用WINRAR解压,如遇到无法解压的请联系管理员！
8. 精力有限，不少源码未能详细测试（解密），不能分辨部分源码是病毒还是误报，所以没有进行任何修改，大家使用前请进行甄别
丞旭猿论坛

THE END

行业资讯