Golang 基于 flag 库实现一个命令行工具

标签：markdown return string err Golang flag 命令行 func

 

Golang 标准库中的 flag 库提供了解析命令行选项的能力，我们可以基于此来开发命令行工具。

 

假设我们想做一个命令行工具，我们通过参数提供【城市】，它自动能够返回当前这个【城市】的天气状况。这样一个简单的需求，今天我们就来试一下，看怎样实现。

 

 

flag 库

 

Package flag implements command-line flag parsing.

flag 库[1] 能够支持基础的命令行 flag 解析。使用起来并不复杂，

我们可以针对 string, integer, bool 三种类型来定义 flag，如：flag.String(), Bool(), Int()。

 

 

比如下面这样，我们就定义了一个 -n 的选项，默认值为 1234, 提示信息为 help message for flag n。返回值是一个 int 的指针。

 

import "flag"var nFlag = flag.Int("n", 1234, "help message for flag n")

当然，我们也可以直接将 flag 和变量绑定，这里要在上面三种方法的前面加上 Var 即可：

 

var flagvar intfunc init() { flag.IntVar(&flagvar, "flagname", 1234, "help message for flagname")}

区别只在于首个参数是个指针，直接赋值，而不是 return 回来。签名都是类似的，我们看一个 Int64Var:

 

在所有 flag 都定义好之后，我们调用 flag.Parse() 方法，将命令行数据解析到对应的 flag 中。这之后就可以直接用了：

fmt.Println("ip has value ", *ip)fmt.Println("flagvar has value ", flagvar)

有时候我们不止是一个简单的 flag，还需要参数，这个时候我们就可以用 flag.Args() 拿到一个 slice，或者直接 flag.Arg(i) 来拿指定参数，下标从 0 开始。

 

 

不熟悉的同学建议多看看看 go by example[2] 的示例，讲的很清楚。

 

从开发者的角度看，其实我们只要定义好变量，用 flag.XXVar 来绑定，最后 flag.Parse 就可以用：

package main
import (  "fmt"  "flag")
var (  intflag int  boolflag bool  stringflag string)
func init() {  flag.IntVar(&intflag, "intflag", 0, "int flag value")  flag.BoolVar(&boolflag, "boolflag", false, "bool flag value")  flag.StringVar(&stringflag, "stringflag", "default", "string flag value")}
func main() {  flag.Parse()
  fmt.Println("int flag:", intflag)  fmt.Println("bool flag:", boolflag)  fmt.Println("string flag:", stringflag)}

编译之后我们运行一下看看

$ ./main -intflag 12 -boolflag 1 -stringflag test
int flag: 12bool flag: truestring flag: test

如果没有设置 flag 的值，会取我们设置的默认值。

 

flag 支持的解析类型有下面四种

 

• -flag
• --flag
• -flag=x
• -flag x （bool 不能用这个）

 

有时候我们只需要一个 flag 就够了，选项本身就带着含义，不需要参数。而有些时候我们既需要 flag，也需要参数。注意区分好场景即可。如果用了第一种和第二种这种不带参数的，本质含义就是个 bool，出现就是 true，不出现就看默认值。

 

FlagSet

 

FlagSet 就是一组 flag 定义的集合，在 flag 库的底层是一个结构体：

 

type FlagSet struct { // Usage is the function called when an error occurs while parsing flags. // The field is a function (not a method) that may be changed to point to // a custom error handler. What happens after Usage is called depends // on the ErrorHandling setting; for the command line, this defaults // to ExitOnError, which exits the program after calling Usage. Usage func() // contains filtered or unexported fields}

注意有一个 Usage 函数，当解析 flag 出问题时就会调用这个。前面 flag 库封装的那些能力底层都是共用同一个默认的 CommandLine FlagSet实现的：

 

// src/flag/flag.govar CommandLine = NewFlagSet(os.Args[0], ExitOnError)
func Parse() {  CommandLine.Parse(os.Args[1:])}
func IntVar(p *int, name string, value int, usage string) {  CommandLine.Var(newIntValue(value, p), name, usage)}
func Int(name string, value int, usage string) *int {  return CommandLine.Int(name, value, usage)}
func NFlag() int { return len(CommandLine.actual) }
func Arg(i int) string {  return CommandLine.Arg(i)}
func NArg() int { return len(CommandLine.args) }

当我们调用 NewFlagSet 时需要指定这个集合的名称以及对应的错误处理。

 

 

第二个参数这个错误处理有三种选项，flag 已经提供

 

• ContinueOnError：发生错误后继续解析，CommandLine就是使用这个选项；
• ExitOnError：出错时调用os.Exit(2)退出程序；
• PanicOnError：出错时产生 panic。

 

需求拆解

 

我们的需求很简单，提供一个 weather flag，接受输入的城市名称，随后我们返回天气数据即可。

 

所以，从 flag 的角度看，这里并不复杂，我们将【城市名称】绑定到一个 flag 上即可。

 

关键是要实现基于城市名称查天气的能力。这个也有公开的网站能实现，参照此前 Golang 教程中给出的 wttr 就可以。大家可以试一下，访问 wttr.in/wuhan[3] 将会展示【武汉】的天气预报：

 

 

这里其实比较 trick，由于是网站，并不是公开的 open api，所以返回的数据也是 html 格式的，我们要思考一下怎么在命令行展示。

 

下面我们一步步来解决。

 

实现 weather flag

 

这一步基本是复用 flag 包提供的能力，这里我们用 StringVar 从命令行拿到值之后写入变量，这里相对比较通用，大家以后有需求可以直接改一下即可：

 

package main
import (    "flag"    "fmt"    "os")
type arguments struct { weatherCity string}
func (a *arguments) parseArgs(args []string) error { f := flag.NewFlagSet(os.Args[0], flag.ContinueOnError)
 f.StringVar(&a.weatherCity, "weather", "", "check weather")
 f.Usage = func() {  fmt.Fprintf(os.Stderr, `flags: %s`, os.Args[0])  f.PrintDefaults()  os.Exit(1) } if err := f.Parse(args[1:]); err != nil {  return err }
 return nil}
func Execute() error {
 args := &arguments{} if err := args.parseArgs(os.Args); err != nil {  fmt.Println(err)  os.Exit(2) }
 // weather if args.weatherCity != "" {                // TODO 实现根据 city 名称拿天气，并打印的效果 }
 return nil}

最终在 main() 函数中直接调用我们的 Execute 即可，注意我们解析到 weatherCity 不为空时，核心逻辑就在这个分支，我们留了个 TODO，下面看看怎么解。

 

天气数据打印

 

前一节的 TODO 里本质需要我们实现的签名很简单:

func GetWeather(city string) (string, error)

这样拿到一个用字符串表示的天气数据，然后回到主流程里一个 fmt.Printf 就可以解决。

 

而同时我们也有了 wttr 的能力，可以拿到数据，只不过是 html。关键是怎么转字符串。我们一步一步来：

 

获取源数据

 

一个简单的 http.Get 拿到 html 数据即可，这一步不复杂，大家直接看代码：

 

func getWeatherData(city string) string {    url := "https://wttr.in/" + city    response, err := http.Get(url)    if err != nil {            return "", err    }    all, err := ioutil.ReadAll(response.Body)    if err != nil {            return "", err    }    weather := string(all)    return weather}

数据转换

 

在开源社区，我们找到了 "github.com/JohannesKaufmann/html-to-markdown" 这个库提供 html 转换为 markdown 的能力，而 "github.com/MichaelMure/go-term-markdown" 又可以将 markdown 格式转为可在 terminal 打印的字符串，我们可以通过这两步来转换，实现整体的 GetWeather 函数：

package weather
import ( "io/ioutil" "net/http"
 md "github.com/JohannesKaufmann/html-to-markdown" markdown "github.com/MichaelMure/go-term-markdown")
func GetWeather(city string) (string, error) { url := "https://wttr.in/" + city response, err := http.Get(url) if err != nil {  return "", err } all, err := ioutil.ReadAll(response.Body) if err != nil {  return "", err } weather := string(all) md := getMD(weather) result := markdown.Render(md, 280, 6) return string(result), nil}
func getMD(html string) string { converter := md.NewConverter("", true, nil) markdown, err := converter.ConvertString(html) if err != nil {  return "" } return markdown}

运行效果

 

好了，现在我们实现了两步，大家只需要把主流程里 TODO 的注释换成实际对下面 GetWeather 函数的调用即可，我们来看看运行效果。

$ opb -weather beijing

 

完美，一个展示天气状况的命令行工具就做完了。这里的 opb 是我们的 package 名称，大家可以自己试一下，包名更换为你喜欢的名称即可。

 

小结

 

其实开源社区各种能力基本都有同学研究过，大家可以打开思路，碰到知识点就思考如何能落地。笔者也是初学 flag 的时候本着实践的目的来试一试。正好发现了 html => markdown => terminal 打印这条路径，不一定是最好的，但作为一个 toy tool 足够了。

 

今天我们只是展示了下 flag 包的基础能力，建议示例代码大家都尝试跑一下看看，感兴趣的同学可以进一步了解如何基于 flag 包封装出更高级的应用。

 

链接：https://juejin.cn/post/7137669791879266335

标签：markdown,return,string,err,Golang,flag,命令行,func
From： https://www.cnblogs.com/cheyunhua/p/16840429.html