玩轉Go命令列工具Cobra

2022-08-15 14:02:48

不知大家有沒有在使用Git命令、Linux的yum命令、Go命令、Maven命令的時候感覺到非常的酷，比如你剛剛拿到一個Go的開源專案，初始化時只需要輸入go mod tidy進行對依賴的下載，或者是git clone xxx之後拉下來一個GitHub上的專案，mvn package或者go build就可以將整合專案打包成一個可執行的檔案，當然這些操作現在大多數都能通過視覺化的UI介面進行，但是就少了一些韻味，還是使用原生的CLI工具最能體現程式執行的過程，並且真是的生產環境中大多數也只能通過這種命令的方式來進行，因此我們就有必要搞一下這個大蟒蛇工具——Cobra。

1 簡介

GitHub:https://github.com/spf13/cobra

Cobra是一個用於建立強大的現代CLI應用程式的庫。在很多圍棋專案中使用，比如Kubernetes, Hugo和GitHub CLI等等。

那麼什麼是CLI呢，簡單來講就是命令列工具介面，Command Line Interface for batch scripting的簡稱，在我們開發中廣泛的使用，比如你開啟Git Bash，輸入git clone XXX，這個就是操作Git的命令列工具介面。

除此之外，Cobra還提供：

簡單的基於子命令的cli:應用伺服器，應用獲取，等等。
完全相容posix的標誌(包括短版本和長版本)
巢狀的子命令
全域性、本地和級聯標誌
命令和標誌的自動幫助生成
自動識別-h、——help等幫助標誌。
為您的應用程式自動生成shell自動完成(bash, zsh, fish, powershell)
為您的應用程式自動生成的手冊頁
命令別名，以便您可以更改而不破壞它們
定義自己的幫助、用法等的靈活性。

什麼是命令&引數&識別符號？

Cobra 是構建在命令、引數和識別符號之上的：

Commands 表示執行動作
Args 就是執行引數
Flags 是這些動作的識別符號

基本的執行命令如下所示：

$ APPNAME Command Args --Flags 
# 或者
$ APPNAME Command --Flags Args

2 安裝

2.1 安裝Cobra-cli腳手架工具

go install github.com/spf13/cobra-cli@latest

下載完成之後會在我們的$GOPATH目錄的bin目錄下生成一個二進位制的檔案cobra-cli.exe（Windows下）或cobra-cli（LInux下），如果出現問題，如：

我們可以直接找到$GO_PATHpkgmodgithub.comspf13cobra-cli@v1.3.0目錄，直接go build自己編譯一個二進位制檔案。

之後一步，為了方便使用我們可以將生成的二進位制檔案放在環境變數裡，讓他在任何地方都能使用，步驟過於簡單就忽略了哈。

2.2 在專案中下載Cobra依賴

go get -u github.com/spf13/cobra@latest

3 使用方式

其實在使用方式這一塊有兩種方法，一種是自己直接寫程式碼，另一種就是使用剛剛我們安裝的cobra-cli來生成腳手架程式碼，我們就在Hello World裡面將cobra-cli生成程式碼試一遍。

3.1 Hello World

首先在專案根目錄下開啟終端（必須是Go Module專案），然後輸入命令cobra-cli init就會在專案中生成如下程式碼：

我們看下具體的程式碼：

main.go

package main

import "go-cobra/cmd"

func main() {
   cmd.Execute()
}

root.go

package cmd

import (
   "os"

   "github.com/spf13/cobra"
)

// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
   Use:   "go-cobra",
   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() {
   err := rootCmd.Execute()
   if err != nil {
      os.Exit(1)
   }
}

func init() {
   // 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/.go-cobra.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")
}

我們將root.go裡面的程式碼進行部分修改：

package cmd

import (
   "fmt"
   "github.com/spf13/cobra"
   "os"
)

var name string

var rootCmd = &cobra.Command{
   Use: "hello",
   Run: func(cmd *cobra.Command, args []string) {
      fmt.Println("hello ", name)
   },
}

func Execute() {
   err := rootCmd.Execute()
   if err != nil {
      os.Exit(1)
   }
}

func init() {
   rootCmd.Flags().StringVarP(&name, "name", "", "world", "")
}

測試：

$ go build

$ .go-cobra.exe --name zs
hello  zs

$ .go-cobra.exe
hello  world

3.2 開發自己的Cli命令

使用cobra-cli腳手架，或者也可以自己手寫如下程式碼

cobra-cli add hi

這個時候我們就會發現多了一個檔案，當然也可以自己手寫程式碼：

在hi.go檔案中程式碼：

package cmd

import (
   "fmt"
   "github.com/spf13/cobra"
)

var (
   age     int
   like    []string
   address string
)

var hiCmd = &cobra.Command{
   Use:   "hi",
   Short: "",
   Long:  "",
   Run: func(cmd *cobra.Command, args []string) {
      Print()
   },
}

func init() {
   rootCmd.AddCommand(hiCmd)
   hiCmd.Flags().StringVarP(&name, "name", "", "world", "")
   hiCmd.Flags().IntVarP(&age, "age", "", 1, "")
   hiCmd.Flags().StringSliceVarP(&like, "like", "", []string{}, "")
   hiCmd.Flags().StringVarP(&address, "address", "", "Beijing", "")
}

func Print() {
   fmt.Println("name:", name)
   fmt.Println("age:", age)
   fmt.Println("like:", like)
   fmt.Println("address:", address)
}

測試：

.go-cobra.exe hi --name zs --age 100 --like Coding,Running --address ShangHai
name: zs
age: 100
like: [Coding Running]
address: ShangHai

3.3 規則和擴充套件使用

3.3.1 我們不難看出規則

新增命令就是自定義&cobra.Command

新增識別符號就是命令.Flags().xxx

新增的命令都需要在rootCmd中新增，新增的識別符號都要在init中新增

3.3.2 小擴充套件

一些常用到的方法：

NoArgs：如果有任何引數，命令列將會報錯
ArbitraryArgs：命令列將會接收任何引數
OnlyValidArgs：如果有如何引數不屬於 Command 的 ValidArgs 欄位，命令列將會報錯
MinimumNArgs(int)：如果引數個數少於 N 個，命令列將會報錯
MaximumNArgs(int)：如果引數個數多於 N 個，命令列將會報錯
ExactArgs(int)：如果引數個數不等於 N 個，命令列將會報錯
RangeArgs(min, max)：如果引數個數不在 min 和 max 之間, 命令列將會報錯

3.3.3 自定義幫助命令

...
var hiCmd = &cobra.Command{
   Use:   "hi",
   Short: "sss",
   Long:  "lll",
   Run: func(cmd *cobra.Command, args []string) {
      if len(args) == 0 {
         cmd.Help()
         return
      }
      Print()
   },
}
...

測試：

$ .go-cobra.exe hi                                                             
Usage:
  hello hi [flags]


Usage:
  hello hi [flags]

Flags:
      --address string    (default "Beijing")
      --age int           (default 1)
  -h, --help             help for hi
      --like strings
      --name string       (default "world")