深入理解Go Cobra的多個方面

一、Cobra簡介

Go Cobra是一個強大的CLI庫，提供了大量的互動式命令行工具，可以幫助構建出非常好的命令行程序。

它也可以作為獨立的程序框架，跟其他的開發框架結合使用。

Cobra提供了非常簡單和優雅的命令行界面，可以快速搭建命令行工具，還支持自定義命令行參數的解析。

下面是Cobra的基本命令：

cobra init myapp

Cobra還提供了非常豐富的功能，例如自動生成命令文檔、互動式命令行界面、網路REST API介面等等。

二、Cobra的基本使用

Cobra的核心是一個非常靈活的樹型結構，來管理不同的命令和子命令，下面是通過Cobra來創建一個CLI程序的實例：

package main

import (
	"fmt"

	"github.com/spf13/cobra"
)

func main() {
	var cmdPrintHello = &cobra.Command{
		Use:   "hello",
		Short: "Print `hello` to the screen",
		Long:  `This command prints out 'hello' to the screen`,
		Run: func(cmd *cobra.Command, args []string) {
			fmt.Println("Hello")
		},
	}

	var rootCmd = &cobra.Command{Use: "myapp"}
	rootCmd.AddCommand(cmdPrintHello)
	rootCmd.Execute()
}

每個命令都是由一個基礎的Command對象擴展而來的，包含了一個實現了Run()方法的函數，這個方法會在執行命令的時候被調用。

Command對象還可以指定一個或多個參數，以及添加任意數量的子命令。

三、Cobra的參數解析

Cobra可以非常方便地解析和驗證命令行參數，下面是一個基本的解析案例：

package main

import (
	"fmt"

	"github.com/spf13/cobra"
)

var flagVerbose bool

func main() {
	var cmdHello = &cobra.Command{
		Use:   "hello",
		Short: "Print 'Hello, World'",
		Long:  `This command prints out 'Hello, World' with an optional verbose flag.`,
		Run: func(cmd *cobra.Command, args []string) {
			if flagVerbose {
				fmt.Println("Running in verbose mode")
			}
			fmt.Println("Hello, World")
		},
	}

	cmdHello.Flags().BoolVarP(&flagVerbose, "verbose", "v", false, "verbose output")
	cmdHello.Execute()
}

在上面的例子中，我們添加了一個verbose命令行參數，如果使用了該參數，程序會列印出一些額外的調試信息。

FlagVarP()方法用於解析命令行參數，第一個參數是一個指向bool值的指針，用於保存參數的值。第二個參數指定了該命令行參數名字的完整和短名稱，第三個參數設置了默認值，第四個參數是參數描述文本。

四、Cobra的路由和子命令設置

Cobra的路由和子命令設置非常靈活，可以嵌套設置多級命令，形成一顆命令樹結構。

package main

import (
	"fmt"

	"github.com/spf13/cobra"
)

func main() {
	var cmdGreet = &cobra.Command{
		Use:   "greet",
		Short: "Greet someone",
		Long:  `This command greets someone with an optional message.`,
		Run: func(cmd *cobra.Command, args []string) {
			fmt.Println("Hello, World")
		},
	}

	var cmdGreetPerson = &cobra.Command{
		Use:   "person",
		Short: "Greet a specific person",
		Long:  `This command greets a specific person with an optional message.`,
		Run: func(cmd *cobra.Command, args []string) {
			fmt.Printf("Hello, %v\n", args[0])
		},
	}
	cmdGreetPerson.Args = cobra.ExactArgs(1)

	cmdGreet.AddCommand(cmdGreetPerson)

	cmdGreet.Execute()
}

在上面的例子中，我們定義了一個greet命令，它有一個子命令person，用於根據姓名來打招呼。

Args屬性用於指定子命令的參數設置，ExactArgs()方法用於限制參數的數量，第一個參數是參數數量，這裡限制只能傳入一個參數，即person的名字。

五、Cobra的自動生成文檔

Cobra可以自動生成命令行程序的使用文檔，非常方便，只需一個簡單的命令就可以生成標準的幫助文檔。

package main

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

func main() {
	var cmdGreet = &cobra.Command{
		Use:   "greet",
		Short: "Greet someone",
		Long:  `This command greets someone with an optional message.`,
		Run: func(cmd *cobra.Command, args []string) {
		},
	}

	var cmdGreetPerson = &cobra.Command{
		Use:   "person [name]",
		Short: "Greet a specific person",
		Long:  `This command greets a specific person with an optional message.`,
		Run: func(cmd *cobra.Command, args []string) {
		},
	}

	cmdGreet.AddCommand(cmdGreetPerson)

	cmdGreet.SetUsageFunc(func(cmd *cobra.Command) error {
		// 這裡是命令行程序的使用文檔，可以非常方便地自定義
		cmd.Printf("Usage: %s [command]\n", cmd.Name())
		cmd.Println("Available Commands:")
		for _, subCmd := range cmd.Commands() {
			cmd.Printf("  %s\n", subCmd.Name())
			cmd.Printf("    %s\n\n", subCmd.Short)
		}
		cmd.Println("Flags:")
		cmd.Print(cmd.FlagUsages())
		cmd.Println("Example Usage:")
		cmd.Printf("  %s %s\n", cmd.Name(), "person John")
		return nil
	})

	cmdGreet.Execute()
}

SetUsageFunc()方法用於自定義使用文檔，默認情況下，Cobra會為一個命令自動生成使用文檔，但是有時候我們可能需要根據自己的需求自定義這個文檔。

六、Cobra的互動式命令行界面

Cobra還提供了互動式的命令行界面，使用戶可以使用鍵盤輸入命令，並且可以動態監測用戶輸入的內容。

package main

import (
	"fmt"
	"os"

	"github.com/manifoldco/promptui"
	"github.com/spf13/cobra"
)

var cmdInteractive = &cobra.Command{
	Use:   "interactive",
	Short: "Launch the interactive mode",
	Long:  `This command allows users to enter interactive mode to execute commands.`,
	Run: func(cmd *cobra.Command, args []string) {
		var commands = []string{"hello", "bye", "exit"}
		prompt := promptui.Select{
			Label: "Select Command",
			Items: commands,
		}
		_, result, err := prompt.Run()
		if err != nil {
			fmt.Printf("Prompt failed %v\n", err)
			os.Exit(1)
		}

		switch result {
		case "hello":
			fmt.Println("Hello, World")
		case "bye":
			fmt.Println("Goodbye")
		case "exit":
			os.Exit(0)
		}
	},
}

在上面的例子中，我們使用了promptui庫來創建互動式的命令行界面，用戶可以使用箭頭鍵來選擇命令。

通過switch語句來根據用戶輸入執行相應的命令。

七、Cobra的REST API介面

Cobra還可以用來構建REST API介面，它提供了非常方便的路由管理和HTTP(S)服務功能，用於構建伺服器。

package main

import (
	"encoding/json"
	"fmt"
	"net/http"

	"github.com/gorilla/mux"
)

type User struct {
	Name    string `json:"name"`
	Age     int    `json:"age"`
	Address string `json:"address"`
}

func main() {
	r := mux.NewRouter()
	r.HandleFunc("/user/{name}", getUserByName).Methods("GET")
	fmt.Println("Starting API server...")
	http.ListenAndServe(":8080", r)
}

func getUserByName(w http.ResponseWriter, r *http.Request) {
	vars := mux.Vars(r)
	name := vars["name"]
	user := User{Name: name, Age: 32, Address: "Beijing"}
	w.Header().Set("Content-Type", "application/json")
	json.NewEncoder(w).Encode(user)
}

在上面的例子中，我們使用了gorilla/mux庫來實現REST API介面，通過定義路由方式來處理HTTP請求，並且返回JSON格式的數據。

在實際項目中，可以根據需要添加更多的路由和處理邏輯來實現功能強大的API介面服務。