golang 命令行cobra妙用

Posted 2020-12-25 xdao

为什么使用命令行

大型项目中少不了数据升级，如果采用web服务，一来不够安全，二来数据量大的时候也会出超时的情况。这时使用命令行是比较合适的方式了。

命令行中的MVC

web项目一般采用MVC模式，对于命令行有吗？
对于命令行则有command(命令)和flag（参数），golang自带了flag包，不过功能不够强大，这里我们使用第三方包cobra

cobra 的使用

具体用法可以参考官方文档，我就不细说了。

妙用

按照官方的结构，不好实现自动注册，每次增加新的命令或文件夹不好管理，需要改动代码。经过一番思考，发现可以利用golang的init机制来达到我的目的。
目录结构如下：

运行效果如图：

其中rootCmd.go 中初始化根命令rootCmd,同时封装两个函数，一个是添加子命令的，一个是执行的。

package rootcmd

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

var rootCmd = &cobra.Command{
    Use: "cli",
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("OK")
    },
}
//封装了两个函数
func AddCommand(cmd *cobra.Command) {
    rootCmd.AddCommand(cmd)
}

func Execute() error {
    return rootCmd.Execute()
}

对于子命令，我可以导入rootcmd所在的包，然后在init函数里，调用rootcmd.AddCommand
比如updateCmd.go

package update

import (
    "github.com/spf13/cobra"
    "fmt"
    "github.com/dwdcth/cli_sample/rootcmd"
)

// 注册命令
func init() {
    rootcmd.AddCommand(userCmd)
}

var userCmd = &cobra.Command{
    Short: "user",
    Use:   "user ",
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("run user update command")
    },
}

对于main包，使用"_",导入子命令文件夹，和rootcmd，并调用 rootcmd.Execute()即可。
这样添加新的命令不增加新的package时，就不需要更改cli.go,实现了自动注册的目的。

package main

import (
    "fmt"
    "os"
    "github.com/dwdcth/cli_sample/rootcmd"
    _"github.com/dwdcth/cli_sample/task"
    _"github.com/dwdcth/cli_sample/update"
)



func main() {

    if err := rootcmd.Execute(); err != nil {
        fmt.Println(err)
        os.Exit(1)
    }
}

完整的代码在此