快捷導(dǎo)航

玩轉(zhuǎn)Go命令行工具Cobra

更新時(shí)間：2022年08月15日 09:44:01 作者：Barry Yan

這篇文章主要介紹了玩轉(zhuǎn)Go命令行工具Cobra,本文介紹了Cobra的最基本也是最常用的使用部分，但是Cobra仍然有很多優(yōu)秀的操作值得我們學(xué)習(xí)，需要的朋友可以參考下

不知大家有沒有在使用Git命令、Linux的yum命令、Go命令、Maven命令的時(shí)候感覺到非常的酷，比如你剛剛拿到一個(gè)Go的開源項(xiàng)目，初始化時(shí)只需要輸入go mod tidy進(jìn)行對依賴的下載，或者是git clone xxx之后拉下來一個(gè)GitHub上的項(xiàng)目，mvn package或者go build就可以將整合項(xiàng)目打包成一個(gè)可執(zhí)行的文件，當(dāng)然這些操作現(xiàn)在大多數(shù)都能通過可視化的UI界面進(jìn)行，但是就少了一些韻味，還是使用原生的CLI工具最能體現(xiàn)程序執(zhí)行的過程，并且真是的生產(chǎn)環(huán)境中大多數(shù)也只能通過這種命令的方式來進(jìn)行，因此我們就有必要搞一下這個(gè)大蟒蛇工具——Cobra。

1 簡介

在這里插入圖片描述

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

Cobra是一個(gè)用于創(chuàng)建強(qiáng)大的現(xiàn)代CLI應(yīng)用程序的庫。在很多圍棋項(xiàng)目中使用，比如Kubernetes, Hugo和GitHub CLI等等。

那么什么是CLI呢，簡單來講就是命令行工具界面，Command Line Interface for batch scripting的簡稱，在我們開發(fā)中廣泛的使用，比如你打開Git Bash，輸入git clone XXX，這個(gè)就是操作Git的命令行工具界面。

除此之外，Cobra還提供：

簡單的基于子命令的cli:應(yīng)用服務(wù)器，應(yīng)用獲取，等等。
完全兼容posix的標(biāo)志(包括短版本和長版本)
嵌套的子命令
全局、本地和級聯(lián)標(biāo)志
命令和標(biāo)志的自動(dòng)幫助生成
自動(dòng)識(shí)別-h、——help等幫助標(biāo)志。
為您的應(yīng)用程序自動(dòng)生成shell自動(dòng)完成(bash, zsh, fish, powershell)
為您的應(yīng)用程序自動(dòng)生成的手冊頁
命令別名，以便您可以更改而不破壞它們
定義自己的幫助、用法等的靈活性。

什么是命令&參數(shù)&標(biāo)識(shí)符？

Cobra 是構(gòu)建在命令、參數(shù)和標(biāo)識(shí)符之上的：

Commands 表示執(zhí)行動(dòng)作
Args 就是執(zhí)行參數(shù)
Flags 是這些動(dòng)作的標(biāo)識(shí)符

基本的執(zhí)行命令如下所示：

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

2 安裝

2.1 安裝Cobra-cli腳手架工具

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

下載完成之后會(huì)在我們的$GOPATH目錄的bin目錄下生成一個(gè)二進(jìn)制的文件cobra-cli.exe（Windows下）或cobra-cli（LInux下），如果出現(xiàn)問題，如：

在這里插入圖片描述

我們可以直接找到$GO_PATH\pkg\mod\github.com\spf13\cobra-cli@v1.3.0目錄，直接go build自己編譯一個(gè)二進(jìn)制文件。

之后一步，為了方便使用我們可以將生成的二進(jìn)制文件放在環(huán)境變量里，讓他在任何地方都能使用，步驟過于簡單就忽略了哈。

2.2 在項(xiàng)目中下載Cobra依賴

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

3 使用方式

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

3.1 Hello World

首先在項(xiàng)目根目錄下打開終端（必須是Go Module項(xiàng)目），然后輸入命令cobra-cli init就會(huì)在項(xiàng)目中生成如下代碼：

在這里插入圖片描述

我們看下具體的代碼：

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里面的代碼進(jìn)行部分修改：

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 開發(fā)自己的Cli命令

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

cobra-cli add hi

這個(gè)時(shí)候我們就會(huì)發(fā)現(xiàn)多了一個(gè)文件，當(dāng)然也可以自己手寫代碼：

在這里插入圖片描述

在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 規(guī)則和擴(kuò)展使用

3.3.1 我們不難看出規(guī)則

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

新增標(biāo)識(shí)符就是命令.Flags().xxx

新增的命令都需要在rootCmd中添加，新增的標(biāo)識(shí)符都要在init中添加

3.3.2 小擴(kuò)展

一些常用到的方法：

NoArgs：如果有任何參數(shù)，命令行將會(huì)報(bào)錯(cuò)
ArbitraryArgs：命令行將會(huì)接收任何參數(shù)
OnlyValidArgs：如果有如何參數(shù)不屬于 Command 的 ValidArgs 字段，命令行將會(huì)報(bào)錯(cuò)
MinimumNArgs(int)：如果參數(shù)個(gè)數(shù)少于 N 個(gè)，命令行將會(huì)報(bào)錯(cuò)
MaximumNArgs(int)：如果參數(shù)個(gè)數(shù)多于 N 個(gè)，命令行將會(huì)報(bào)錯(cuò)
ExactArgs(int)：如果參數(shù)個(gè)數(shù)不等于 N 個(gè)，命令行將會(huì)報(bào)錯(cuò)
RangeArgs(min, max)：如果參數(shù)個(gè)數(shù)不在 min 和 max 之間, 命令行將會(huì)報(bào)錯(cuò)

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")