Go cobra庫使用教程

更新時間：2022年12月14日 15:20:23 作者：kina100

cobra既是一個用于創(chuàng)建強大現(xiàn)代CLI應用程序的庫，也是一個生成應用程序和命令文件的程序。cobra被用在很多go語言的項目中，比如 Kubernetes、Docker、Istio、ETCD、Hugo、Github CLI等等

一，安裝

$ go get -u github.com/spf13/cobra

二，簡單的cobra項目

先構建一個簡單的cobra命令，以此來熟悉cobra是怎么用的

創(chuàng)建一個cmd目錄，在目錄里創(chuàng)建一個myOrder.go，實際上這個名字可以隨便命名，一般來說，你創(chuàng)建的啥命令就寫啥名字，這不是為了好找么。

package cmd
import (
	"fmt"
	"github.com/spf13/cobra"
)
var rootCmd = cobra.Command{
	// 命令的名稱
	Use: "myOrder",
	// 剪短介紹
	Short: "這是一個我的私有命令",
	// 詳細介紹
	Long: "自定義私有命令，主要是想測試下這玩意能不能用",
	// 普通運行，如果需要返回error要使用RUNE
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("這是一條myOrder命令的反饋，反正啥也沒處理")
	},
}
func Execute() {
	if err := rootCmd.Execute(); err != nil {
		fmt.Println("這里有錯誤", err)
	}
}

然后在main.go 入口里運行Execute即可

main.go ↓

package main
import "cobraTest/cmd"
func main() {
	cmd.Execute()
}

cobraTest是這個項目的名字，cmd是剛才創(chuàng)建的那個包（目錄）。

此時是不能直接像往常一樣go run的，要先構建為可執(zhí)行文件，在windows上就是exe

go build

go build之后會發(fā)現(xiàn)目錄里多出了一個可執(zhí)行文件，

這時候我們可以進行簡單的測試

三，測試

執(zhí)行可執(zhí)行文件，并且?guī)衔覀儎偛诺哪莻€命令

.\cobraTest.exe myOrder

這就是剛才寫的那個RUN 里面的運行結果

四，增加flag參數(shù)

package cmd
import (
	"fmt"
	"github.com/spf13/cobra"
)
var rootCmd = cobra.Command{
	// 命令的名稱
	Use: "myOrder",
	// 剪短介紹
	Short: "這是一個我的私有命令",
	// 詳細介紹
	Long: "自定義私有命令，主要是想測試下這玩意能不能用",
	// 普通運行，如果需要返回error要使用RUNE
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("這是一條myOrder命令的反饋，反正啥也沒處理")
        // 讀取第一個flag 參數(shù)
		getString, _ := cmd.Flags().GetString("hahaha")
		fmt.Println(getString)
        // 讀取第二個flag 參數(shù)
		getString, _ = cmd.Flags().GetString("heiheihei")
		fmt.Println(getString)
	},
}
func Execute() {
    // 增加一個flag 參數(shù)
    // flag參數(shù)的名稱，示例值，flag參數(shù)解釋
	rootCmd.PersistentFlags().String("hahaha", "", "隨便寫點啥吧")
    // 再增加一個flag 參數(shù)
	rootCmd.Flags().String("heiheihei", "", "輸入一些東西")
	if err := rootCmd.Execute(); err != nil {
		fmt.Println("這里有錯誤", err)
	}
}

在設定完rootCmd后，就可以直接給rootCmd結構體增加flag參數(shù)，并在run里面讀取出來，修改代碼后要重新go build,之后執(zhí)行命令的時候，加上flag參數(shù)

.\cobraTest.exe myOrder --hahaha 哈哈哈 --heiheihei 嘿嘿嘿

五，額外命令

有的文章說這是子命令，其實是不恰當?shù)模@是為了讓一個工程可以有多條命令，而無需生成多個可執(zhí)行文件。

構建兩個命令，并在main.go里面寫一個根命令

firstOrder.go ↓

package cmd
import (
	"fmt"
	"github.com/spf13/cobra"
)
// 大寫可用于外部訪問
var FirstCmd = cobra.Command{
	// 命令的名稱
	Use: "firstOrder",
	// 剪短介紹
	Short: "1號命令",
	// 普通運行，如果需要返回error要使用RUNE
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("1號命令可以執(zhí)行")
	},
}

secondOrder.go ↓

package cmd
import (
	"fmt"
	"github.com/spf13/cobra"
)
var SecondCmd = cobra.Command{
	// 命令的名稱
	Use: "secondOrder",
	// 剪短介紹
	Short: "2號命令",
	// 普通運行，如果需要返回error要使用RUNE
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("2號命令可以執(zhí)行")
	},
}

main.go ↓

package main
import (
	"cobraTest/cmd"
	"fmt"
	"github.com/spf13/cobra"
)
func main() {
	rootCmd := cobra.Command{
		Use:              "rootOrder",
		Short:            "根命令",
		TraverseChildren: true,
	}
	// 把這兩條命令加入到根命令里面
	rootCmd.AddCommand(&cmd.FirstCmd)
	rootCmd.AddCommand(&cmd.SecondCmd)
	if err := rootCmd.Execute(); err != nil {
		fmt.Println("Could not run command")
	}
}

執(zhí)行go build