Golang基于flag庫實現(xiàn)一個命令行工具

Golang 標(biāo)準(zhǔn)庫中的 flag 庫提供了解析命令行選項的能力，我們可以基于此來開發(fā)命令行工具。

假設(shè)我們想做一個命令行工具，我們通過參數(shù)提供【城市】，它自動能夠返回當(dāng)前這個【城市】的天氣狀況。這樣一個簡單的需求，今天我們就來試一下，看怎樣實現(xiàn)。

flag 庫

Package flag implements command-line flag parsing.

flag 庫[1]能夠支持基礎(chǔ)的命令行 flag 解析。使用起來并不復(fù)雜，

我們可以針對 string, integer, bool 三種類型來定義 flag，如：flag.String(), Bool(), Int()。

比如下面這樣，我們就定義了一個-n的選項，默認(rèn)值為 1234, 提示信息為help message for flag n。返回值是一個 int 的指針。

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

當(dāng)然，我們也可以直接將 flag 和變量綁定，這里要在上面三種方法的前面加上 Var 即可：

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

區(qū)別只在于首個參數(shù)是個指針，直接賦值，而不是 return 回來。簽名都是類似的，我們看一個 Int64Var:

在所有 flag 都定義好之后，我們調(diào)用flag.Parse()方法，將命令行數(shù)據(jù)解析到對應(yīng)的 flag 中。這之后就可以直接用了：

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

有時候我們不止是一個簡單的 flag，還需要參數(shù)，這個時候我們就可以用flag.Args()拿到一個 slice，或者直接flag.Arg(i)來拿指定參數(shù)，下標(biāo)從 0 開始。

不熟悉的同學(xué)建議多看看看go by example[2]的示例，講的很清楚。

從開發(fā)者的角度看，其實我們只要定義好變量，用 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: 12
bool flag: true
string flag: test

如果沒有設(shè)置 flag 的值，會取我們設(shè)置的默認(rèn)值。

flag 支持的解析類型有下面四種

-flag

--flag

-flag=x

-flag x （bool 不能用這個）

有時候我們只需要一個 flag 就夠了，選項本身就帶著含義，不需要參數(shù)。而有些時候我們既需要 flag，也需要參數(shù)。注意區(qū)分好場景即可。如果用了第一種和第二種這種不帶參數(shù)的，本質(zhì)含義就是個 bool，出現(xiàn)就是 true，不出現(xiàn)就看默認(rèn)值。

FlagSet

FlagSet 就是一組 flag 定義的集合，在 flag 庫的底層是一個結(jié)構(gòu)體：

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 函數(shù)，當(dāng)解析 flag 出問題時就會調(diào)用這個。前面 flag 庫封裝的那些能力底層都是共用同一個默認(rèn)的 CommandLine FlagSet實現(xiàn)的：

// src/flag/flag.go
var 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) }

當(dāng)我們調(diào)用 NewFlagSet 時需要指定這個集合的名稱以及對應(yīng)的錯誤處理。

第二個參數(shù)這個錯誤處理有三種選項，flag 已經(jīng)提供

ContinueOnError：發(fā)生錯誤后繼續(xù)解析，CommandLine就是使用這個選項；

ExitOnError：出錯時調(diào)用os.Exit(2)退出程序；

PanicOnError：出錯時產(chǎn)生 panic。

需求拆解

我們的需求很簡單，提供一個 weather flag，接受輸入的城市名稱，隨后我們返回天氣數(shù)據(jù)即可。

所以，從 flag 的角度看，這里并不復(fù)雜，我們將【城市名稱】綁定到一個 flag 上即可。

關(guān)鍵是要實現(xiàn)基于城市名稱查天氣的能力。這個也有公開的網(wǎng)站能實現(xiàn)，參照此前 Golang 教程中給出的 wttr 就可以。大家可以試一下，訪問wttr.in/wuhan[3]將會展示【武漢】的天氣預(yù)報：

這里其實比較 trick，由于是網(wǎng)站，并不是公開的 open api，所以返回的數(shù)據(jù)也是 html 格式的，我們要思考一下怎么在命令行展示。

下面我們一步步來解決。

實現(xiàn) weather flag

這一步基本是復(fù)用 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 實現(xiàn)根據(jù) city 名稱拿天氣，并打印的效果
 }


 return nil
}

最終在 main() 函數(shù)中直接調(diào)用我們的 Execute 即可，注意我們解析到 weatherCity 不為空時，核心邏輯就在這個分支，我們留了個 TODO，下面看看怎么解。

天氣數(shù)據(jù)打印

前一節(jié)的 TODO 里本質(zhì)需要我們實現(xiàn)的簽名很簡單:

func GetWeather(city string) (string, error)

這樣拿到一個用字符串表示的天氣數(shù)據(jù)，然后回到主流程里一個fmt.Printf就可以解決。

而同時我們也有了 wttr 的能力，可以拿到數(shù)據(jù)，只不過是 html。關(guān)鍵是怎么轉(zhuǎn)字符串。我們一步一步來：

獲取源數(shù)據(jù)

一個簡單的 http.Get 拿到 html 數(shù)據(jù)即可，這一步不復(fù)雜，大家直接看代碼：

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
}

數(shù)據(jù)轉(zhuǎn)換

在開源社區(qū)，我們找到了"github.com/JohannesKaufmann/html-to-markdown"這個庫提供 html 轉(zhuǎn)換為 markdown 的能力，而"github.com/MichaelMure/go-term-markdown"又可以將 markdown 格式轉(zhuǎn)為可在 terminal 打印的字符串，我們可以通過這兩步來轉(zhuǎn)換，實現(xiàn)整體的 GetWeather 函數(shù)：

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
}

運行效果

好了，現(xiàn)在我們實現(xiàn)了兩步，大家只需要把主流程里 TODO 的注釋換成實際對下面 GetWeather 函數(shù)的調(diào)用即可，我們來看看運行效果。

$ opb -weather beijing

完美，一個展示天氣狀況的命令行工具就做完了。這里的 opb 是我們的 package 名稱，大家可以自己試一下，包名更換為你喜歡的名稱即可。

小結(jié)

其實開源社區(qū)各種能力基本都有同學(xué)研究過，大家可以打開思路，碰到知識點就思考如何能落地。筆者也是初學(xué) flag 的時候本著實踐的目的來試一試。正好發(fā)現(xiàn)了 html => markdown => terminal 打印這條路徑，不一定是最好的，但作為一個 toy tool 足夠了。

今天我們只是展示了下 flag 包的基礎(chǔ)能力，建議示例代碼大家都嘗試跑一下看看，感興趣的同學(xué)可以進(jìn)一步了解如何基于 flag 包封裝出更高級的應(yīng)用。

審核編輯：湯梓紅