go Cobra命令行工具入门教程

《Go Cobra命令行工具入门教程》是一篇详细介绍如何使用Go语言编写命令行应用程序的教程，其中使用了Cobra作为命令行框架。本文将对该教程进行详细介绍。

简介

Cobra是一个用于构建命令行应用程序的Go语言库，提供了一个优雅的开发界面、简单的命令行接口、帮助指南和子命令。使用Cobra可以快速构建出一个功能强大的命令行应用程序。

安装Cobra

首先需要安装Cobra，可以通过以下命令进行安装：

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

安装完成后使用cobra init命令可以生成一个基础的Cobra项目，项目中含有一个默认的Cmd对象和根命令。通过这个命令可以快速开始一个新的Cobra项目。

定义命令

Cobra提供了cobra.Command类型来定义命令，每个命令都由一组属性组成，包括命令名称、命令描述、可选标志、必需参数等。以下是一个示例命令：

var exampleCmd = &cobra.Command{
    Use:   "example",
    Short: "This is an example command",
    Long:  `This is a longer description of the function`,
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("Running example command")
    },
}

在这个命令中，Use属性指定了命令的名称，Short属性指定了命令的简要描述，Long属性指定了命令的详细描述。Run方法定义了命令被执行后要运行的代码。

添加子命令

Cobra支持添加子命令来构建更复杂的CLI。子命令是从另一个已定义的命令中创建的，每个子命令都可以有自己的标志和参数。以下是一个示例子命令：

var subCmd = &cobra.Command{
    Use:   "sub",
    Short: "This is a sub command",
    Long:  `This is a longer description of the sub command`,
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("Running sub command")
    },
}

在这个子命令中，Use属性指定了子命令的名称，在rootCmd中使用rootCmd.AddCommand(subCmd)方法可以将子命令添加到根命令中。

添加标志

Cobra支持添加标志，可以通过标志传递参数给命令。以下是一个示例标志：

var exampleCmd = &cobra.Command{
    Use:   "example",
    Short: "This is an example command with flags",
    Long:  `This is a longer description of the function`,
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("Running example command")
    },
}

func init() {
    exampleCmd.Flags().StringP("file", "f", "", "The file to process")
}

在这个示例中，使用Flags()方法声明了标志并使用StringP()方法定义了标志的名称、缩写、默认值和描述。可以使用cmd.Flags().Lookup()方法获取标志的值，例如：

file, _ := cmd.Flags().GetString("file")

示例

以下是两个使用Cobra编写CLI的示例：

示例1：cowsay

下面是一个使用Cobra编写CLI的Cowsay程序。

package main

import (
    "fmt"

    "github.com/spf13/cobra"
)

func say(msg string, cowfile string) {
    fmt.Printf(" ____ \n")
    fmt.Printf("< %s >\n", msg)
    fmt.Printf(" ---- \n")
    fmt.Printf("        \\   ^__^ \n")
    fmt.Printf("         \\  (%s)\\_______ \n", cowfile)
    fmt.Printf("            (__)\\       )\\/\\ \n")
    fmt.Printf("             %v ||----w | \n", "'")
    fmt.Printf("                ||     || \n")
}

var rootCmd = &cobra.Command{
    Use:   "cowsay",
    Short: "Cowsay is a program that generates ASCII pictures of a cow with a message",
    Long:  `Cowsay is a program that generates ASCII pictures of a cow with a message. It accepts a message as a command line argument and outputs the cow with the message.`,
    Run: func(cmd *cobra.Command, args []string) {
        if len(args) == 0 {
            cmd.Help()
            return
        }
        msg := args[0]
        cowfile, _ := cmd.Flags().GetString("cowfile")
        say(msg, cowfile)
    },
}

func init() {
    rootCmd.Flags().StringP("cowfile", "c", "default", "A choice of cowfile to be used in the message")
}

func main() {
    rootCmd.Execute()
}

这个程序通过rootCmd定义了程序的基本信息和命令，并使用say函数输出一个ASCII画的牛和一个消息。

启动程序并输入一个命令，例如cowsay "Hello world!" --cowfile tux，将会打印出一个照片。

示例2：usepg

下面是另一个使用Cobra编写CLI的程序。

package main

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"

    "github.com/mattn/go-pg/v10"
)

type Post struct {
    ID      int64
    Content string
}

var db *pg.DB

var rootCmd = &cobra.Command{
    Use:   "usepg",
    Short: "A simple command line tool that allows you to interact with a PostgreSQL database",
}

var listCmd = &cobra.Command{
    Use:   "list",
    Short: "List all posts in the database",
    Run: func(cmd *cobra.Command, args []string) {
        var posts []Post
        err := db.Model(&posts).Select()
        if err != nil {
            fmt.Println(err)
            return
        }
        for _, post := range posts {
            fmt.Println(post.Content)
        }
    },
}

var addCmd = &cobra.Command{
    Use:   "add",
    Short: "Add a new post to the database",
    Args:  cobra.MinimumNArgs(1),
    Run: func(cmd *cobra.Command, args []string) {
        post := &Post{
            Content: args[0],
        }
        err := db.Insert(post)
        if err != nil {
            fmt.Println(err)
            return
        }
        fmt.Println("Post added successfully")
    },
}

func init() {
    db = pg.Connect(&pg.Options{
        User:     "user",
        Password: "password",
        Database: "mydb",
    })

    rootCmd.AddCommand(listCmd)
    rootCmd.AddCommand(addCmd)
}

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

这个程序使用了Go-pg库来连接并访问PostgreSQL数据库。usepg命令定义了一个根命令，并且使用listCmd和addCmd子命令来执行列表和添加操作。程序将连接到PostgreSQL数据库并执行所提供的操作。