怎么Golang快速构建一个CLI小东西

在实际开发的过程中，咱们会发现许多开源的结构都会有着自己的一个CLI东西库来帮助开发者们通过指令行的方法快速的到达某些意图，比方常见的docker 指令。那么在这篇文章当中，首要给咱们介绍一个golang的小结构，咱们能够凭借这个结构来快速建立一个小的CLI东西

先上效果

咱们这边构建了一个叫gtools的小东西，用来容纳咱们自已用golang开发的一些小的东西

>> 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是咱们自己的一个小东西，用来随机的从输入的字符列表中选一个作为结果：

>> gtools as 学习 看电影 仍是学习
学习
>> gtools as 学习 看电影 仍是学习
仍是学习

那么怎么完成呢？

在这边，咱们用了一个叫cobra的结构，这个结构被广泛运用到许多开源的产品当中，比方docker-compose, kubectl等。

首先，咱们要安装相应的环境：

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

在履行完上面两条指令后咱们就具有最根本的开发条件了，接下来开端咱们的开发吧！

运用Cobra初始化咱们的项目

cobra-cli init

履行完之后，咱们会在本地目录看到这样的结构

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

main.go就是咱们的主进口了，root是咱们指令的根指令

main.go

// 只是做了一个履行的操作
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")
}

参加咱们的子指令

现在，咱们需要参加一个子指令，如autoSelector, 只需履行一下指令即可：

cobra-cli add autoSelector

对应的一个叫autoSelector.go的文件就会出现在cmd目录底下，而且现已为你预备了根本的指令行结构

// 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`,  //详细描绘
   Run: func(cmd *cobra.Command, args []string) {
    // 在这里参加/调用你的首要逻辑
  }
}
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")
}

完成咱们的功能

咱们能够创建一个pkg包来存放咱们的具体完成逻辑，在cmd中只需要做简略的调用即可

import (
   "math/rand"
   "time"
)
// 简略完成逻辑
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
}

此时咱们的代码东西就根本完成完成了，只需要编译一下就能够直接运用。编译运行

go build -o gtools

你就能够得到一个叫gtools的二进制包，直接运行就能够看到咱们开头的效果啦~

代码仓库： github.com/819110812/G…

个人博客地址：doraemonabcd.xyz/