Golang如何快速構(gòu)建一個CLI小工具詳解

更新時間：2022年11月01日 10:13:55 作者：user8592760267165

這篇文章主要為大家介紹了Golang如何快速構(gòu)建一個CLI小工具詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

如何Golang快速構(gòu)建一個CLI小工具

在現(xiàn)實(shí)開發(fā)的過程中，大家會發(fā)現(xiàn)很多開源的框架都會有著自己的一個CLI工具庫來幫助開發(fā)者們通過命令行的方式快速的達(dá)到某些目的，比如常見的docker 命令。

那么在這篇文章當(dāng)中，主要給大家介紹一個golang的小框架，我們可以借助這個框架來快速搭建一個小的CLI工具

先上效果

我們這邊構(gòu)建了一個叫gtools的小工具，用來容納我們自已用golang開發(fā)的一些小的工具

>> gtools            
gtools is a CLI application for golang command tools.
Usage:
  gtools [command]
Available Commands:
  autoSelector randomly select string from a list
  completion   Generate the autocompletion script for the specified shell
  help         Help about any command
Flags:
  -h, --help     help for gtools
  -t, --toggle   Help message for toggle
Use "gtools [command] --help" for more information about a command.

這邊的autoSeletor是我們自己的一個小工具，用來隨機(jī)的從輸入的字符列表中選一個作為結(jié)果：

>> gtools as 學(xué)習(xí) 看電影還是學(xué)習(xí)
學(xué)習(xí)

>> gtools as 學(xué)習(xí) 看電影還是學(xué)習(xí)
還是學(xué)習(xí)

那么如何實(shí)現(xiàn)呢？

在這邊，我們用了一個叫cobra的框架，這個框架被廣泛運(yùn)用到很多開源的產(chǎn)品當(dāng)中，比如docker-compose, kubectl等。

首先，我們要安裝相應(yīng)的環(huán)境：

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

在執(zhí)行完上面兩條命令后我們就具備最基本的開發(fā)條件了，接下來開始我們的開發(fā)吧！

使用Cobra初始化我們的項(xiàng)目

cobra-cli init

執(zhí)行完之后，我們會在本地目錄看到這樣的結(jié)構(gòu)

├── main.go
├── cmd
│   └── root.go

main.go就是我們的主入口了，root是我們命令的根命令

main.go

// 只是做了一個執(zhí)行的操作
func main() {
   cmd.Execute()
}

Root.go 定義了根命令，還有一些初始化的操作

var rootCmd = &cobra.Command{
   Use:   "gtools",  // 這是你的命令的名字
   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/.main.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")
}

加入我們的子命令

現(xiàn)在，我們需要加入一個子命令，如autoSelector, 只需執(zhí)行一下命令即可：

cobra-cli add autoSelector

對應(yīng)的一個叫autoSelector.go的文件就會出現(xiàn)在cmd目錄底下，并且已經(jīng)為你準(zhǔn)備了基本的命令行框架

// autoSelectorCmd represents the autoSelector command
var autoSelectorCmd = &cobra.Command{
   Use:     "autoSelector",  // 名字
   Aliases: []string{"as"}, // 命令行的簡寫
   Short:   "randomly select string from a list",  //簡單的描述
   Long:    `randomly select string from a list`,  //詳細(xì)描述
   Run: func(cmd *cobra.Command, args []string) {
    // 在這里加入/調(diào)用你的主要邏輯
  }
}
func init() {
  // 注冊到根命令下
   rootCmd.AddCommand(autoSelectorCmd)
   // Here you will define your flags and configuration settings.
   // Cobra supports Persistent Flags which will work for this command
   // and all subcommands, e.g.:
   // autoSelectorCmd.PersistentFlags().String("foo", "", "A help for foo")
   // Cobra supports local flags which will only run when this command
   // is called directly, e.g.:
   // autoSelectorCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
}

實(shí)現(xiàn)我們的功能

我們可以創(chuàng)建一個pkg包來存放我們的具體實(shí)現(xiàn)邏輯，在cmd中只需要做簡單的調(diào)用即可

import (
   "math/rand"
   "time"
)
// 簡單實(shí)現(xiàn)邏輯
func AutoSelect(inputs []string) (selected string, err error) {
   source := rand.NewSource(time.Now().UnixNano())
   r := rand.New(source)
   randomIndex := r.Intn(len(inputs))
   selected = inputs[randomIndex]
   return selected, nil
}

此時我們的代碼工具就基本實(shí)現(xiàn)完成了，只需要編譯一下就可以直接使用。編譯運(yùn)行