亚洲乱码中文字幕综合,中国熟女仑乱hd,亚洲精品乱拍国产一区二区三区,一本大道卡一卡二卡三乱码全集资源,又粗又黄又硬又爽的免费视频

詳解Go?flag實(shí)現(xiàn)二級(jí)子命令的方法

 更新時(shí)間:2022年07月08日 10:45:58   作者:YahuiAn  
這篇文章主要介紹了Go?flag?詳解,實(shí)現(xiàn)二級(jí)子命令,本文就探討一下?Go?語(yǔ)言中如何寫(xiě)一個(gè)擁有類(lèi)似特性的命令行程序,需要的朋友可以參考下

前言

日常開(kāi)發(fā)使用到的命令行工具大都支持如下特性:

  • 文檔自動(dòng)生成(如 -h --help)
  • 多級(jí)子命令(如 docker exec -it)
  • 支持參數(shù)(如 ls -color=auto)
  • 長(zhǎng)短選項(xiàng)(如 -v 和 --verbose)
  • 全局選項(xiàng)(如 docker -D run -d nginx)
  • Tab 自動(dòng)補(bǔ)全

本文就探討一下 Go 語(yǔ)言中如何寫(xiě)一個(gè)擁有類(lèi)似特性的命令行程序。

os.Args

類(lèi)似于 shell 中的 $1 $2 ,在 Go 中可以使用 os.Args 來(lái)獲取命令行參數(shù),這種臨時(shí)使用一兩個(gè)參數(shù)還可以,代碼可維護(hù)性太差了,不推薦使用。

其中 Args[0] 是程序的名稱,Args[1] 是第一個(gè)參數(shù),依此類(lèi)推。

flag 快速開(kāi)始

Go 標(biāo)準(zhǔn)庫(kù)自帶的 flag 包可以實(shí)現(xiàn)簡(jiǎn)單的命令行解析,我們模仿一下 ls 命令的參數(shù),示例如下:

func main() {
	// 直接定義 flag,返回值為指針
	all := flag.Bool("all", true, "do not ignore entries starting with .")
	color := flag.String("color", "omitted", "colorize the output")

	// 也可以將 flag 綁定到變量
	var almostAll bool
	flag.BoolVar(&almostAll, "almost-all", false, "do not list implied . and ..")

	// 除過(guò)上面的 Bool String 還有 Int Float64 等其他常用類(lèi)型

	flag.Parse()

	// Parse 后就可以獲取到具體參數(shù)的值
	fmt.Println(*all, *color, almostAll)
}

可以看到非常簡(jiǎn)單的幾行代碼,就實(shí)現(xiàn)了一個(gè)還不錯(cuò)的命令行小工具,支持 --- (效果是一致的),對(duì)于非 bool 類(lèi)型的 flag 其值支持 -flag=val 或者 -flag val。

長(zhǎng)短選項(xiàng)

短選項(xiàng)書(shū)寫(xiě)快捷,適合在終端下面執(zhí)行,而長(zhǎng)選項(xiàng)可讀性高,適合在腳本中書(shū)寫(xiě),通過(guò)共享一個(gè)變量,即可達(dá)到此效果

func main() {
	var name string
	defaultVal := "tom"
	useage := "your name"
	flag.StringVar(&name, "n", defaultVal, useage+" (shorthand)")
	flag.StringVar(&name, "name", defaultVal, useage)
	flag.Parse()

	fmt.Println(name)
}

自定義類(lèi)型

flag 也支持我們自定義參數(shù)的類(lèi)型,方便我們對(duì)參數(shù)的格式,輸出形式做更加自由的處理,更好的封裝。

type Durations []time.Duration

func (d *Durations) String() string {
	return fmt.Sprint(*d)
}

func (d *Durations) Set(value string) error {
	// 支持逗號(hào)分割的參數(shù),如:-d 1m,2s,1h
	// 也支持 -d 1m -d 2s -d 1h 這種寫(xiě)法
	// 如果不想 -d 被指定多次,可以加上這段 if 邏輯
	// if len(*d) > 0 {
	// 	return errors.New("-d flag already set")
	// }

	for _, v := range strings.Split(value, ",") {
		duration, err := time.ParseDuration(v)
		if err != nil {
			return err
		}
		*d = append(*d, duration)
	}

	return nil
}

func main() {
	var param Durations
	// 第一個(gè)參數(shù)是接口類(lèi)型,我們自定義的 Durations 只需要實(shí)現(xiàn) String() 和 Set() 方法即可
	flag.Var(&param, "d", "time duration, comma-separated list")
	flag.Parse()
	fmt.Println(param)
}

二級(jí)子命令

在說(shuō)二級(jí)子命令前,我們先看一下 flag 的核心流程,幫助我們更好的理解二級(jí)子命令的實(shí)現(xiàn)。

// src/flag/flag.go

// 代表了每一個(gè) flag,如 --name=tom
type Flag struct {
	Name     string // name as it appears on command line
	Usage    string // help message
	Value    Value  // value as set
	DefValue string // default value (as text); for usage message
}
// 代表本次命令輸出的所有 flag ,如 -l --size=10 --verbose
type FlagSet struct {
	Usage func()

	name          string
	parsed        bool
	actual        map[string]*Flag
	formal        map[string]*Flag
	args          []string // arguments after flags
	errorHandling ErrorHandling
	output        io.Writer // nil means stderr; use Output() accessor
}

在快速開(kāi)始的代碼中,核心代碼就兩句,就對(duì)應(yīng)了 flag 的流程,先注冊(cè)后解析。

color := flag.String("color", "omitted", "colorize the output")
flag.Parse()

追著 flag.String 可以看到它其實(shí)調(diào)用的是 CommandLine.String,CommandLine 是一個(gè)全局的 FlagSet 實(shí)例,最終 flag.String 會(huì)調(diào)用 FlagSetVar 方法,完成所有命令的注冊(cè)。

// src/flag/flag.go

func String(name string, value string, usage string) *string {
	return CommandLine.String(name, value, usage)
}
var CommandLine = NewFlagSet(os.Args[0], ExitOnError)

// 省略到校驗(yàn)的一部分邏輯,可以看到核心就是 f.formal[name] = flag
func (f *FlagSet) Var(value Value, name string, usage string) {
	// ...

	// Remember the default value as a string; it won't change.
	flag := &Flag{name, usage, value, value.String()}
	// ...
    
	if f.formal == nil {
		f.formal = make(map[string]*Flag)
	}
	f.formal[name] = flag
}

flag.Parse 則最終調(diào)用的是 FlagSetParse 方法,完成實(shí)際輸入值的解析。

func (f *FlagSet) Parse(arguments []string) error {
	f.parsed = true
	f.args = arguments
	for { // 循環(huán)直到所有的 flag 都解析完成
		seen, err := f.parseOne()
		if seen {
			continue
		}
		// ...
	}
	return nil
}

在理解了上面了流程后,我們就基于 FlagSet 來(lái)模仿一下 docker 的二級(jí)命令,代碼如下:

type MyFlagSet struct {
	*flag.FlagSet
	cmdComment string // 二級(jí)子命令本身的注釋
}

func main() {
	// docker ps
	psCmd := &MyFlagSet{
		FlagSet:    flag.NewFlagSet("ps", flag.ExitOnError),
		cmdComment: "List containers",
	}
	psCmd.Bool("a", false, "Show all containers (default shows just running)")
	psCmd.Bool("s", false, "Display total file sizes")

	// docker run
	runCmd := &MyFlagSet{
		FlagSet:    flag.NewFlagSet("run", flag.ExitOnError),
		cmdComment: "Run a command in a new container",
	}
	runCmd.Int("c", 1, "CPU shares (relative weight)")
	runCmd.String("name", "", "Assign a name to the container")

	// 用 map 保存所有的二級(jí)子命令,方便快速查找
	subcommands := map[string]*MyFlagSet{
		psCmd.Name():  psCmd,
		runCmd.Name(): runCmd,
	}

	useage := func() { // 整個(gè)命令行的幫助信息
		fmt.Printf("Usage: docker COMMAND\n\n")
		for _, v := range subcommands {
			fmt.Printf("%s %s\n", v.Name(), v.cmdComment)
			v.PrintDefaults() // 使用 flag 庫(kù)自帶的格式輸出子命令的選項(xiàng)幫助信息
			fmt.Println()
		}
		os.Exit(2)
	}

	if len(os.Args) < 2 { // 即沒(méi)有輸入子命令
		useage()
	}

	cmd := subcommands[os.Args[1]] // 第二個(gè)參數(shù)必須是我們支持的子命令
	if cmd == nil {
		useage()
	}

    cmd.Parse(os.Args[2:]) // 注意這里是 cmd.Parse 不是 flag.Parse,且值是 Args[2:]

	// 輸出解析后的結(jié)果
	fmt.Println("command name is:", cmd.Name())
	cmd.Visit(func(f *flag.Flag) {
		fmt.Printf("option %s, value is %s\n", f.Name, f.Value)
	})
}

可以看到效果還不錯(cuò)呢,到目前為止,除了全局選項(xiàng)和自動(dòng)補(bǔ)全未實(shí)現(xiàn),其他的特性都有了,可以看到總體來(lái)說(shuō) flag 簡(jiǎn)單易用,對(duì)于一些小程序來(lái)說(shuō)完全足夠了。

當(dāng)然對(duì)于比較復(fù)雜的程序,還是推薦使用更加強(qiáng)大的 cobra,可以參考筆者寫(xiě)的 Markdown 小幫手 marker

參考

https://pkg.go.dev/flag

https://gobyexample.com/command-line-subcommands

到此這篇關(guān)于Go flag 詳解,實(shí)現(xiàn)二級(jí)子命令的文章就介紹到這了,更多相關(guān)Go flag二級(jí)子命令內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

最新評(píng)論