當(dāng)前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

Go命令行库Cobra的使用

發(fā)布時(shí)間：2024/4/11 编程问答 42 豆豆

生活随笔收集整理的這篇文章主要介紹了 Go命令行库Cobra的使用小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

點(diǎn)擊上方“朱小廝的博客”，選擇“設(shè)為星標(biāo)”

回復(fù)”1024“獲取獨(dú)家整理的學(xué)習(xí)資料

歡迎跳轉(zhuǎn)到本文的原文鏈接：https://honeypps.com/golang/go-command-lib-cobra-guide/

這篇文章是分析golang中命令行解析庫的。關(guān)注我公眾號(hào)的很多都是Java程序員，對(duì)于Java而言，有很多命令行解析庫，如：JOpt Simple、Commons CLI、JCommander，javaer也可以看看類比一下兩種語言不同解析的差異。

Cobra在golang項(xiàng)目里面應(yīng)用非常的廣泛，比如kubernetes、docker、openshift、Hugo等都用到了Cobra，如果要熟悉這些go開源項(xiàng)目實(shí)現(xiàn)的話，Cobra是必不可少的掌握項(xiàng)。

Cobra既是用于創(chuàng)建強(qiáng)大的現(xiàn)代CLI應(yīng)用程序的庫，也是用于生成應(yīng)用程序和命令文件的程序。

Cobra提供的功能：

簡(jiǎn)易的子命令行模式，如 app server， app fetch等等
完全兼容posix命令行模式
嵌套子命令subcommand
支持全局，局部，串聯(lián)flags
使用Cobra很容易的生成應(yīng)用程序和命令，使用cobra create appname和cobra add cmdname
如果命令輸入錯(cuò)誤，將提供智能建議，如 app srver，將提示srver沒有，是否是app server
自動(dòng)生成commands和flags的幫助信息
自動(dòng)生成詳細(xì)的help信息，如app help
自動(dòng)識(shí)別-h，--help幫助flag
自動(dòng)生成應(yīng)用程序在bash下命令自動(dòng)完成功能
自動(dòng)生成應(yīng)用程序的man手冊(cè)
命令行別名
自定義help和usage信息
可選的緊密集成的viper?apps

(Cobra是眼鏡蛇的意思。Steve Francia這位大佬取名真是diao，還有個(gè)項(xiàng)目叫viper。。)

Cobra是建立在結(jié)構(gòu)的命令、參數(shù)和標(biāo)志之上。命令（Commands）代表操作，參數(shù)（Args）和標(biāo)志（Flags）是這些行動(dòng)的修飾符。最好的應(yīng)用程序就像讀取句子。用戶會(huì)知道如何使用本機(jī)應(yīng)用程序，因?yàn)樗麄儗⒗斫馊绾问褂盟?/p>

要遵循的模式是

APPNAME VERB NOUN --ADJECTIVE

或

APPNAME COMMAND ARG --FLAG

命令是應(yīng)用程序的中心點(diǎn)。應(yīng)用程序支持的每個(gè)交互都將包含在命令中。命令可以具有子命令并可選地運(yùn)行動(dòng)作。

標(biāo)志是一種修改命令行為的方法。Cobra支持完全符合POSIX標(biāo)準(zhǔn)的標(biāo)志以及Go 標(biāo)志包。Cobra命令可以定義持久保存到子命令和標(biāo)志的標(biāo)志，這些命令和標(biāo)志僅對(duì)該命令可用。標(biāo)志功能由pflag庫提供，pflag庫是標(biāo)準(zhǔn)庫的一個(gè)分支，它在添加POSIX兼容性時(shí)保持相同的接口。

Github地址:?https://github.com/spf13/cobra

使用

安裝cobra

使用Cobra很簡(jiǎn)單。首先，使用go get安裝最新版本

go?get?github.com/spf13/cobra/cobra

由于各種問題，國內(nèi)使用 go get 安裝 golang 官方包可能會(huì)失敗。如果出現(xiàn)：

hidden@hidden:~$?go?get?github.com/spf13/cobra/cobra package?golang.org/x/sys/unix:?unrecognized?import?path?"golang.org/x/sys/unix"?(https?fetch:?Get?https://golang.org/x/sys/unix?go-get=1:?dial?tcp?216.239.37.1:443:?connect:?connection?timed?out) package?golang.org/x/text/transform:?unrecognized?import?path?"golang.org/x/text/transform"?(https?fetch:?Get?https://golang.org/x/text/transform?go-get=1:?dial?tcp?216.239.37.1:443:?connect:?connection?timed?out) package?golang.org/x/text/unicode/norm:?unrecognized?import?path?"golang.org/x/text/unicode/norm"?(https?fetch:?Get?https://golang.org/x/text/unicode/norm?go-get=1:?dial?tcp?216.239.37.1:443:?connect:?connection?timed?out)

即使使用代理也不行，怎么解決這個(gè)問題？

其實(shí) golang 在 github 上建立了一個(gè)鏡像庫，如 https://github.com/golang/sys/，即是 https://golang.org/x/sys/ 的鏡像庫。要避免以上報(bào)錯(cuò)，其實(shí)只需要執(zhí)行以下步驟：

mkdir?-p?$GOPATH/src/golang.org/x cd?$GOPATH/src/golang.org/x git?clone?https://github.com/golang/sys git?clone?https://github.com/golang/text

然后再執(zhí)行g(shù)o get github.com/spf13/cobra/cobra即可。

安裝成功之后會(huì)生成一個(gè)名為cobra的可執(zhí)行文件：

hidden@hidden:~$?ls?-al?$GOPATH/bin?|?grep?cobra -rwxr-xr-x?1?zhuzhonghua?zhuzhonghua?11411056?Aug?12?15:48?cobra

使用Cobra生成應(yīng)用程序

假設(shè)現(xiàn)在我們要開發(fā)一個(gè)基于CLI的命令程序，名字為demo。執(zhí)行如下命令：

hidden@hidden:~$?cd?$GOPATH/src/github.com/spf13/ hidden@hidden:~/go/src/github.com/spf13$?cobra?init?demo?--pkg-name=github.com/spf13/demo Your?Cobra?applicaton?is?ready?at /home/zhuzhonghua/go/src/github.com/spf13/demohidden@hidden:~/go/src/github.com/spf13$?cd?demo/

在$GOPATH/src/github.com/spf13目錄下會(huì)生成一個(gè)demo的文件夾，結(jié)構(gòu)如下：

hidden@hidden:~/go/src/github.com/spf13/demo$?tree . ├──?cmd │???└──?root.go ├──?LICENSE └──?main.go1?directory,?3?files

在demo目錄下會(huì)有如下的內(nèi)容：

hidden@hidden:~/cobra/demo$?tree . ├──?cmd │???└──?root.go ├──?LICENSE └──?main.go1?directory,?3?files

測(cè)試cobra效果：

hidden@hidden:~/cobra/demo$?go?run?main.go A?longer?description?that?spans?multiple?lines?and?likely?contains examples?and?usage?of?using?your?application.?For?example:Cobra?is?a?CLI?library?for?Go?that?empowers?applications. This?application?is?a?tool?to?generate?the?needed?files to?quickly?create?a?Cobra?application.subcommand?is?required exit?status?1

在Cobra應(yīng)用程序中，通常main.go文件非常空洞。它主要只干一件事：初始化Cobra。

package?main//import?"{pathToYourApp}/cmd" import?"github.com/spf13/demo/cmd"func?main()?{cmd.Execute() }

添加子命令

可以定義其他命令，并且通常在cmd/目錄中為每個(gè)命令提供自己的文件。

如果要?jiǎng)?chuàng)建版本（version）命令，可以創(chuàng)建cmd/version.go并使用以下內(nèi)容填充它：

hidden@hidden:~/go/src/github.com/spf13/demo$?cobra?add?version version?created?at?/home/zhuzhonghua/go/src/github.com/spf13/demo

此目錄結(jié)構(gòu)變更為：

hidden@hidden:~/go/src/github.com/spf13/demo$?tree . ├──?cmd │???├──?root.go │???└──?version.go ├──?LICENSE └──?main.go1?directory,?4?files

現(xiàn)在我們來執(zhí)行以下這個(gè)子命令：

hidden@hidden:~/go/src/github.com/spf13/demo$?go?run?main.go?version version?called

生成的version代碼如下（cmd/version.go）：

package?cmdimport?("fmt""github.com/spf13/cobra" )//?versionCmd?represents?the?version?command var?versionCmd?=?&cobra.Command{Use:???"version",Short:?"A?brief?description?of?your?command",Long:?`A?longer?description?that?spans?multiple?lines?and?likely?contains?examples and?usage?of?using?your?command.?For?example:Cobra?is?a?CLI?library?for?Go?that?empowers?applications. This?application?is?a?tool?to?generate?the?needed?files to?quickly?create?a?Cobra?application.`,Run:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Println("version?called")}, }func?init()?{rootCmd.AddCommand(versionCmd)//?Here?you?will?define?your?flags?and?configuration?settings.//?Cobra?supports?Persistent?Flags?which?will?work?for?this?command//?and?all?subcommands,?e.g.://?versionCmd.PersistentFlags().String("foo",?"",?"A?help?for?foo")//?Cobra?supports?local?flags?which?will?only?run?when?this?command//?is?called?directly,?e.g.://?versionCmd.Flags().BoolP("toggle",?"t",?false,?"Help?message?for?toggle") }

注：命令的名稱使用駝峰式命名（camelCase），而不能使用蛇形命名（snake_case）。讀者可以自行創(chuàng)建一個(gè)蛇形命名的命令來查看一下實(shí)際的效果（hint: camelCase to snake_case）。

完善子命令功能

修改上面代碼中的函數(shù)Run：

????Run:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Println("version?called")},

修改為：

????Run:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Println("Version?1.0.0?for?demo")},

再次執(zhí)行g(shù)o run main.go version，結(jié)果如下：

Version?1.0.0?for?demo

另一個(gè)示例

在上面的cmd/version.go中我們發(fā)現(xiàn)在init函數(shù)有這么一行代碼：rootCmd.AddCommand(versionCmd)，這個(gè)rootCmd是什么呢？

package?cmdimport?("fmt""os""github.com/spf13/cobra"homedir?"github.com/mitchellh/go-homedir""github.com/spf13/viper")var?cfgFile?string//?rootCmd?represents?the?base?command?when?called?without?any?subcommands var?rootCmd?=?&cobra.Command{Use:???"demo",Short:?"A?brief?description?of?your?application",Long:?`A?longer?description?that?spans?multiple?lines?and?likely?contains examples?and?usage?of?using?your?application.?For?example:Cobra?is?a?CLI?library?for?Go?that?empowers?applications. This?application?is?a?tool?to?generate?the?needed?files to?quickly?create?a?Cobra?application.`,//?Uncomment?the?following?line?if?your?bare?application//?has?an?action?associated?with?it://????Run:?func(cmd?*cobra.Command,?args?[]string)?{?}, }//?Execute?adds?all?child?commands?to?the?root?command?and?sets?flags?appropriately. //?This?is?called?by?main.main().?It?only?needs?to?happen?once?to?the?rootCmd. func?Execute()?{if?err?:=?rootCmd.Execute();?err?!=?nil?{fmt.Println(err)os.Exit(1)} }func?init()?{cobra.OnInitialize(initConfig)//?Here?you?will?define?your?flags?and?configuration?settings.//?Cobra?supports?persistent?flags,?which,?if?defined?here,//?will?be?global?for?your?application.rootCmd.PersistentFlags().StringVar(&cfgFile,?"config",?"",?"config?file?(default?is?$HOME/.demo.yaml)")//?Cobra?also?supports?local?flags,?which?will?only?run//?when?this?action?is?called?directly.rootCmd.Flags().BoolP("toggle",?"t",?false,?"Help?message?for?toggle") }//?initConfig?reads?in?config?file?and?ENV?variables?if?set. func?initConfig()?{if?cfgFile?!=?""?{//?Use?config?file?from?the?flag.viper.SetConfigFile(cfgFile)}?else?{//?Find?home?directory.home,?err?:=?homedir.Dir()if?err?!=?nil?{fmt.Println(err)os.Exit(1)}//?Search?config?in?home?directory?with?name?".demo"?(without?extension).viper.AddConfigPath(home)viper.SetConfigName(".demo")}viper.AutomaticEnv()?//?read?in?environment?variables?that?match//?If?a?config?file?is?found,?read?it?in.if?err?:=?viper.ReadInConfig();?err?==?nil?{fmt.Println("Using?config?file:",?viper.ConfigFileUsed())} }

打開cmd/root.go（上面的示例代碼），你會(huì)發(fā)現(xiàn)rootCmd其實(shí)就是我們的根命令。我相信機(jī)智的同學(xué)已經(jīng)猜出來我們添加子命令的子命令的方法了?，F(xiàn)在讓我們?cè)赾md目錄下新建help.go文件，項(xiàng)目文件結(jié)構(gòu)為：

hidden@hidden:~/go/src/github.com/spf13/demo$?tree . ├──?cmd │???├──?help.go │???├──?root.go │???└──?version.go ├──?LICENSE └──?main.go1?directory,?5?files

其中cmd/help.go的內(nèi)容為(help為version的子命令)：

package?cmdimport?("fmt""github.com/spf13/cobra" )//?versionCmd?represents?the?version?command var?helpCmd?=?&cobra.Command{Use:???"help",Short:?"show?command?info",Long:?`<snip>`,Run:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Println("Here?is?the?help?information")}, }func?init()?{versionCmd.AddCommand(helpCmd)?//注意這里是verisonCmd不是rootCmd }

執(zhí)行g(shù)o run main.go version help命令之后，結(jié)果為：

hidden:demo?hidden$?go?run?main.go?version?help Here?is?the?help?information

使用Flags

Flags提供了修飾符來控制動(dòng)作命令的操作。

Persistent Flags：全局性flag, 可用于它所分配的命令以及該命令下的每個(gè)命令。在根上分配標(biāo)志作為全局flag。

Local Flags：局部性flag,在本args分配一個(gè)標(biāo)志，該標(biāo)志僅適用于該特定命令。

Required flags：必選flag，flag默認(rèn)是可選的。如果希望命令在未設(shè)置flag時(shí)報(bào)告錯(cuò)誤，請(qǐng)將其標(biāo)記為required。

添加Flags

如果仔細(xì)看過上面cmd/version.go中init函數(shù)中的注釋的話，你應(yīng)該已經(jīng)得到了足夠多的信息來自己操作添加flag。

不過這里我再解釋一下，首先是persistent參數(shù)，當(dāng)你的參數(shù)作為persistent flag存在時(shí)，如注釋所言，在其所有的子命令之下該參數(shù)都是可見的。而local flag則只能在該命令調(diào)用時(shí)執(zhí)行。

可以做一個(gè)簡(jiǎn)單的測(cè)試，在cmd/version.go的init函數(shù)中，添加如下內(nèi)容(添加在rootCmd.AddCommand(versionCmd)這一行之上):

versionCmd.PersistentFlags().String("global_foo",?"global_val",?"A?help?for?global_foo") versionCmd.Flags().String("local_foo","local_val",?"A?help?for?local_foo")

現(xiàn)在運(yùn)行g(shù)o run main.go version -h得到如下結(jié)果：

hidden:demo?hidden$?go?run?main.go?version?-h A?longer?description?that?spans?multiple?lines?and?likely?contains?examples and?usage?of?using?your?command.?For?example:Cobra?is?a?CLI?library?for?Go?that?empowers?applications. This?application?is?a?tool?to?generate?the?needed?files to?quickly?create?a?Cobra?application.Usage:demo?version?[flags]demo?version?[command]Available?Commands:help????????show?command?infoFlags:--global_foo?string???A?help?for?global_foo?(default?"global_val")-h,?--help????????????????help?for?version--local_foo?string????A?help?for?local_foo?(default?"local_val")Global?Flags:--config?string???config?file?(default?is?$HOME/.demo.yaml)Use?"demo?version?[command]?--help"?for?more?information?about?a?command.

接著我們對(duì)比著再運(yùn)行g(shù)o run main.go help -h試試：

hidden:demo?hidden$?go?run?main.go?version?help?-h <snip>Usage:demo?version?help?[flags]Flags:-h,?--help???help?for?helpGlobal?Flags:--config?string???????config?file?(default?is?$HOME/.demo.yaml)--global_foo?string???A?help?for?global_foo?(default?"global_val")

可以發(fā)現(xiàn)在Gloabal Flags的變化。version作為root的子命令，仍然可以使用root的persistent flag-> config（可以查看root.go），而help作為test的子命令，不僅可以使用test的persistent flag-> fool, 也可以使用test父命令的persistent flag。從而我們可以直觀的看出persistent的作用范圍是該命令之后的所有子命令。

flag支持的參數(shù)類型可以參考文檔：https://godoc.org/github.com/spf13/cobra

注意：cmd.Flags().String()與 cmd.Flags().StringP()是不一樣的。假如我們?cè)趘ersion.go的init下增加如下兩行:

versionCmd.Flags().String("flag1","",?"flag1?usage") versionCmd.Flags().StringP("flga2","f","",?"flag2?usage")

前者調(diào)用需要如下形式：

go?run?main.go?version?--flag1

后者有如下兩種形式調(diào)用：

go?run?main.go?version?--flag2 go?run?main.go?version?-f

其它示例：

persistent flag:

rootCmd.PersistentFlags().BoolVarP(&Verbose, "verbose", "v", false, "verbose output")

local flag:

rootCmd.Flags().StringVarP(&Source, "source", "s", "", "Source directory to read from")

rootCmd.MarkFlagRequired("source") // Flags默認(rèn)是可選的。如果您希望命令在未設(shè)置Flags時(shí)報(bào)告錯(cuò)誤，請(qǐng)將其標(biāo)記為必需

獲取Flags值

在知道了如何設(shè)置參數(shù)后，我們的下一步當(dāng)然是需要在運(yùn)行時(shí)獲取改參數(shù)的值?，F(xiàn)在我們把注意力放到version.go的這個(gè)部分：

var?versionCmd?=?&cobra.Command{Use:???"version",Short:?"A?brief?description?of?your?command",Long:?`A?longer?description?that?spans?multiple?lines?and?likely?contains?examples and?usage?of?using?your?command.?For?example:Cobra?is?a?CLI?library?for?Go?that?empowers?applications. This?application?is?a?tool?to?generate?the?needed?files to?quickly?create?a?Cobra?application.`,Run:?func(cmd?*cobra.Command,?args?[]string)?{//待下面的示例插入fmt.Println("Version?1.0.0?for?demo")}, }

讓我們把注意力重新放到上面的代碼上。我們也很容易可以猜測(cè)到Use,Short,Long三個(gè)參數(shù)的作用，這里便不做闡述。

顯而易見，我們應(yīng)該在Run這里來獲取參數(shù)并執(zhí)行我們的命令功能。獲取參數(shù)其實(shí)也并不復(fù)雜。以versionCmd.Flags().StringP("flag2", "f", "", "flag2 usage")此為例，我們可以在Run函數(shù)里添加：

str,_?:=?cmd.Flags().GetString("flag2") fmt.Printf("The?param?vale?is?%s\n",?str)

運(yùn)行命令go run main.go version -f vvvv，獲得結(jié)果如下：

The?param?vale?is?vvvv Version?1.0.0?for?demo

使用Args

可以使用Args字段來指定位置參數(shù)的驗(yàn)證Command。

以下驗(yàn)證器內(nèi)置：

NoArgs - 如果存在任何位置參數(shù)，該命令將報(bào)告錯(cuò)誤。
ArbitraryArgs - 該命令將接受任何args。
OnlyValidArgs- 如果存在任何不在ValidArgs字段中的位置參數(shù)，該命令將報(bào)告錯(cuò)誤Command。
MinimumNArgs(int) - 如果沒有至少N個(gè)位置參數(shù)，該命令將報(bào)告錯(cuò)誤。
MaximumNArgs(int) - 如果有多于N個(gè)位置參數(shù)，該命令將報(bào)告錯(cuò)誤。
ExactArgs(int) - 如果沒有確切的N位置參數(shù)，該命令將報(bào)告錯(cuò)誤。
RangeArgs(min, max) - 如果args的數(shù)量不在預(yù)期args的最小和最大數(shù)量之間，則該命令將報(bào)告錯(cuò)誤。

為了演示Args的用法，我們?cè)赾md目錄下再創(chuàng)建一個(gè)args.go文件，其內(nèi)容如下（注意多了一個(gè)Args函數(shù)）：

mport?("fmt""github.com/pkg/errors""github.com/spf13/cobra" )var?argsCmd?=?&cobra.Command{Use:???"args",Short:?"args?demo",Long:?`<snip>`,Args:?func(cmd?*cobra.Command,?args?[]string)?error?{if?len(args)<1{return?errors.New("requires?at?least?one?arg")}return?nil},Run:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Println("args?called,?args:?",?args)}, }func?init()?{rootCmd.AddCommand(argsCmd) }

示例中限定參數(shù)的格式至少為一個(gè)否則會(huì)報(bào)錯(cuò)。我們來運(yùn)行一下看一看結(jié)果如何，首先是不添加參數(shù)（go run main.go args）：

hidden:demo?hidden$?go?run?main.go?args Error:?requires?at?least?one?arg Usage:demo?args?[flags]Flags:-h,?--help???help?for?argsGlobal?Flags:--config?string???config?file?(default?is?$HOME/.demo.yaml)requires?at?least?one?arg exit?status?1

可以看到報(bào)錯(cuò)：Error: requires at least one arg。

我們?cè)賮碓囈幌绿砑訁?shù)的結(jié)果：

hidden:demo?hidden$?go?run?main.go?args?1 args?called,?args:??[1] hidden:demo?hidden$?go?run?main.go?args?1?2?3?4 args?called,?args:??[1?2?3?4]

示例中的Args函數(shù)可以替換為

Args:?cobra.MinimumNArgs(1),

讀者可以自行驗(yàn)證一下效果。

Help命令

前面的示例中出現(xiàn)了cmd/help.go，為了不產(chǎn)生迷惑，我們把這個(gè)文件先刪除掉。

當(dāng)您有子命令時(shí)，Cobra會(huì)自動(dòng)為您的應(yīng)用程序添加一個(gè)幫助命令。當(dāng)用戶運(yùn)行“app help”時(shí)會(huì)調(diào)用此方法。此外，幫助還將支持所有其他命令作為輸入。比如說，你有一個(gè)名為'create'的命令，沒有任何額外的配置; 當(dāng)'app help create'被調(diào)用時(shí)，Cobra會(huì)工作。每個(gè)命令都會(huì)自動(dòng)添加' - help'標(biāo)志。

可以在終端輸入cobra或者cobra help命令看一下實(shí)際的效果:

hidden@hidden:~$?cobra?help Cobra?is?a?CLI?library?for?Go?that?empowers?applications. This?application?is?a?tool?to?generate?the?needed?files to?quickly?create?a?Cobra?application.Usage:cobra?[command]Available?Commands:add?????????Add?a?command?to?a?Cobra?Applicationhelp????????Help?about?any?commandinit????????Initialize?a?Cobra?ApplicationFlags:-a,?--author?string????author?name?for?copyright?attribution?(default?"YOUR?NAME")--config?string????config?file?(default?is?$HOME/.cobra.yaml)-h,?--help?????????????help?for?cobra-l,?--license?string???name?of?license?for?the?project--viper????????????use?Viper?for?configuration?(default?true)Use?"cobra?[command]?--help"?for?more?information?about?a?command.

自定義Help命令

可以提供自定義的help命令或自定義的模板，通過以下函數(shù)實(shí)現(xiàn)：

cmd.SetHelpCommand(cmd?*Command) cmd.SetHelpFunc(f?func(*Command,?[]string)) cmd.SetHelpTemplate(s?string)

后兩者也適用于子命令。

Usage

當(dāng)用戶提供無效標(biāo)志或無效命令時(shí)，Cobra會(huì)通過向用戶顯示“usage”來做出響應(yīng)。

示例：

hidden@hidden:~$?cobra?--invalid Error:?unknown?flag:?--invalid Usage:cobra?[command]Available?Commands:add?????????Add?a?command?to?a?Cobra?Applicationhelp????????Help?about?any?commandinit????????Initialize?a?Cobra?ApplicationFlags:-a,?--author?string????author?name?for?copyright?attribution?(default?"YOUR?NAME")--config?string????config?file?(default?is?$HOME/.cobra.yaml)-h,?--help?????????????help?for?cobra-l,?--license?string???name?of?license?for?the?project--viper????????????use?Viper?for?configuration?(default?true)Use?"cobra?[command]?--help"?for?more?information?about?a?command.

自定義Usage

您可以提供自己的使用功能或模板供Cobra使用。與Help一樣，函數(shù)和模板可以通過公共方法覆蓋：

cmd.SetUsageFunc(f?func(*Command)?error) cmd.SetUsageTemplate(s?string)

PreRun 和 PostRun鉤子

我們可以在Run方法之前或者之后運(yùn)行一些其它的方法（函數(shù)）。PersistentPreRun和PreRun在Run之前執(zhí)行。PersistentPostRun和PostRun將Run之后執(zhí)行。Persistent***Run如果子程序沒有聲明他們自己的功能，他們將繼承這些功能。這些功能按以下順序運(yùn)行：

PersistentPreRun PreRun Run PostRun PersistentPostRun

下面是使用所有這些功能的兩個(gè)命令的示例。執(zhí)行子命令時(shí)，它將運(yùn)行root命令的PersistentPreRun，但不運(yùn)行root命令的PersistentPostRun：

import?("fmt""github.com/spf13/cobra" )func?main(){var?rootCmd?=?&cobra.Command{Use:?"root",PersistentPreRun:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Printf("[root]?PersistentPreRun?with?args:?%v?\n",?args)},PreRun:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Printf("[root]?PreRun?with?args:?%v?\n",?args)},Run:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Printf("[root]?Run?with?args:?%v?\n",?args)},PostRun:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Printf("[root]?PostRun?with?args:?%v?\n",?args)},PersistentPostRun:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Printf("[root]?PersistentPostRun?with?args:?%v?\n",?args)},}var?subCmd?=?&cobra.Command{Use:???"sub",PreRun:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Printf("[sub]?PreRun?with?args:?%v?\n",?args)},Run:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Printf("[sub]?Run?with?args:?%v?\n",?args)},PostRun:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Printf("[sub]?PostRun?with?args:?%v?\n",?args)},PersistentPostRun:?func(cmd?*cobra.Command,?args?[]string)?{fmt.Printf("[sub]?PersistentPostRun?with?args:?%v?\n",?args)},}rootCmd.AddCommand(subCmd)rootCmd.SetArgs([]string{""})rootCmd.Execute()fmt.Println()rootCmd.SetArgs([]string{"sub",?"arg1",?"arg2",})rootCmd.Execute() }

運(yùn)行結(jié)果：

[root]?PersistentPreRun?with?args:?[] [root]?PreRun?with?args:?[] [root]?Run?with?args:?[] [root]?PostRun?with?args:?[] [root]?PersistentPostRun?with?args:?[][root]?PersistentPreRun?with?args:?[arg1?arg2] [sub]?PreRun?with?args:?[arg1?arg2] [sub]?Run?with?args:?[arg1?arg2] [sub]?PostRun?with?args:?[arg1?arg2] [sub]?PersistentPostRun?with?args:?[arg1?arg2]

參考資料及衍生讀物

Golang: Cobra命令行參數(shù)庫的使用【博客園】
golang命令行庫Cobra的使用【簡(jiǎn)書】
Cobra Generator
https://golang.org/pkg/flag/
https://godoc.org/github.com/spf13/cobra#Command
https://github.com/spf13/pflag
https://godoc.org/github.com/spf13/cobra
github.com/spf13/cobra go cobra包介紹
golang命令行庫cobra使用【博客園】

歡迎跳轉(zhuǎn)到本文的原文鏈接：https://honeypps.com/golang/go-command-lib-cobra-guide/

想知道更多？掃描下面的二維碼關(guān)注我

相關(guān)推薦：

《科普 | 明星公司之Netflix》
《看我如何作死 | 將CPU、IO打爆》
《看我如何作死 | 網(wǎng)絡(luò)延遲、丟包、中斷一個(gè)都沒落下》
《7102-2019年技術(shù)文全套整理，建議收藏》
《看我如何假死！》
《總結(jié)緩存使用過程中的幾種策略以及優(yōu)缺點(diǎn)組合分析》

加技術(shù)群入口（備注：技術(shù)）：>>>Learn More<<

免費(fèi)資料入口（備注：1024）：>>>Learn More<<

免費(fèi)星球入口：>>>Free<<<

?
點(diǎn)個(gè)"在看"唄^_^

總結(jié)

以上是生活随笔為你收集整理的Go命令行库Cobra的使用的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

上一篇：史上最难10道Java面试题！
下一篇： HR 的那些黑话大全，太扎心了！（漫画）