记录一下go语言开源项目cobra的使用
可以参考官网上的函数说明Cobra
cobra真是一个应用广泛的工具，许多鼎鼎有名的项目，都是基于这个开发的控制台版本，比如docker、hugo、filebrowser等。
可以说，如果对cobra没有基础的了解，学习这些应用可能会感到比较混乱，毕竟，一开始的地方就看不懂，就很难再看下去了。
真如cobra官网所说，你的文件夹结构通常是这样的。
While you are welcome to provide your own organization, typically a Cobra-based application will follow the following organizational structure:
▾ appName/
▾ cmd/
add.go
your.go
commands.go
here.go
main.go
In a Cobra app, typically the main.go file is very bare. It serves one purpose: initializing Cobra.
package main
import (
"{pathToYourApp}/cmd"
)
func main() {
cmd.Execute()
}
以下是filebrowser的main.go
package main
import (
"github.com/filebrowser/filebrowser/v2/cmd"
)
func main() {
cmd.Execute()
}
以下是本机的目录结构
目录结构：
d:\git\cobra
|-- cmd
| |-- root.go
| `-- show.go
|-- cobra.exe
|-- go.mod
|-- go.sum
`-- main.go
1 directory, 6 files
这里，本人只是根据https://cobra.dev/来入门学习一番。
main.go
package main
import "cobra/cmd"
func main() {
cmd.Execute()
}
root.go
package cmd
import (
"errors"
"fmt"
"os"
"github.com/spf13/cobra"
)
//检查字符串是否是需要的
func IsValid(str string) bool {
if str == "hh" {
return false
}
return true
}
var rootCmd = &cobra.Command{
Short: "短的介绍，在a.exe help中显示",
Long: `长的介绍在a.exe show -h，也就是每个子功能的help中展示`,
Args: func(cmd *cobra.Command, args []string) error { //很好，把args数据的检验做好了，Run里面专心处理参数
if len(args) < 1 {
return errors.New("requires at least one arg")
}
if IsValid(args[0]) {
return nil
}
return fmt.Errorf("invalid specified: %s", args[0])
},
Run: func(cmd *cobra.Command, args []string) {
// Do Stuff Here
fmt.Println("这是根命令")
// 读取第一个flag 参数
getString, _ := cmd.Flags().GetString("p1")
fmt.Println(getString)
// 读取第二个flag 参数
getString, _ = cmd.Flags().GetString("p2")
fmt.Println(getString)
// 处理未解析的参数
for _, arg := range args {
fmt.Println("rootCmd argument:", arg)
}
},
}
func Execute() {
rootCmd.AddCommand(showCmd)
cobra.OnInitialize(func() {
fmt.Println("start,this is in OnInitialize")
})
cobra.OnFinalize(func() {
fmt.Println("end,this is in OnFinalize")
})
// 增加一个flag 参数
// flag参数的名称，示例值，flag参数解释
rootCmd.PersistentFlags().String("p1", "default", "这是PersistentFlags的p1参数") //PersistentFlags可以在rootcmd和showcmd中使用
// 再增加一个flag 参数
rootCmd.Flags().String("p2", "", "这是Flags的p2参数") //flags命令只能在自己的cmd中使用
showCmd.Flags().String("h1", "", "这是Flags的h1参数") //中间的value默认参数
showCmd.Flags().String("h2", "", "这是Flags的h2参数")
if err := rootCmd.Execute(); err != nil {
fmt.Println(err)
os.Exit(1)
}
}
show.go
package cmd
import (
"fmt"
"github.com/spf13/cobra"
)
var showCmd = &cobra.Command{
Use: "show",
Short: "show is print now time", //使用主命令时显示的helo
Long: `show time and it will change every time in use.`, //每个指令展示的helo
Args: cobra.MinimumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
// Do Stuff Here
fmt.Println("show your input")
// 读取第一个flag 参数
getString, _ := cmd.Flags().GetString("h1") //func (c *Command) Flags() *pflag.FlagSet goland准确指出了变量真正的本源的数据类型
fmt.Println(getString)
// 读取第二个flag 参数
getString, _ = cmd.Flags().GetString("h2")
fmt.Println(getString)
getString, _ = cmd.Flags().GetString("p1")
if getString != "" {
fmt.Println(getString)
}
// 处理未解析的参数
for _, arg := range args {
fmt.Println("Extra argument:", arg)
}
},
PersistentPreRun: func(cmd *cobra.Command, args []string) {
fmt.Println("PersistentPreRun")
},
PreRun: func(cmd *cobra.Command, args []string) {
fmt.Println("PreRun")
},
PostRun: func(cmd *cobra.Command, args []string) {
fmt.Println("PostRun")
},
PersistentPostRun: func(cmd *cobra.Command, args []string) {
fmt.Println("PersistentPostRun")
},
}
运行结果：
go run main.go show --p1 hello --h1 第一个参数 --h2 第二个参数 hh xx
start,this is in OnInitialize
PersistentPreRun
PreRun
show your input
第一个参数
第二个参数
hello
Extra argument: hh
Extra argument: xx
PostRun
PersistentPostRun
end,this is in OnFinalize
可以清晰的看见这几个函数执行的先后顺序，把这个代码修改运行，测试几次，相信就能对cobra有个基础的了解了。
参数解析完成后，就可以基于此开发应用真正的功能了。