Golang?urfave/cli庫(kù)簡(jiǎn)單應(yīng)用示例詳解

更新時(shí)間：2023年09月07日 09:24:44 作者：EricLee

這篇文章主要為大家介紹了Golang?urfave/cli庫(kù)簡(jiǎn)單應(yīng)用示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪

引言

通過(guò)應(yīng)用cli庫(kù)可以在程序中像執(zhí)行cmd命令一樣運(yùn)行可執(zhí)行文件，同時(shí)也可以通過(guò)--help執(zhí)行的幫助說(shuō)明。

最簡(jiǎn)單的應(yīng)用

package main
import (
    "fmt"
    "log"
    "os"
    "github.com/urfave/cli/v2"
)
func main() {
    app := &cli.App{
        Name:  "greet",
        Usage: "fight the loneliness!",
        Action: func(*cli.Context) error {
            fmt.Println("Hello friend!")
            return nil
        },
    }
    if err := app.Run(os.Args); err != nil {
        log.Fatal(err)
    }
}

上面代碼編譯后，會(huì)生成對(duì)應(yīng)的可執(zhí)行文件（Name與App的參數(shù)Name并沒(méi)有強(qiáng)制關(guān)聯(lián)，但最好保持一致）。在無(wú)參數(shù)執(zhí)行可執(zhí)行文件時(shí)，會(huì)執(zhí)行對(duì)應(yīng)app的Action。上述代碼就會(huì)打印出Hello friend

cli最主要的幾個(gè)參數(shù)是：Arguments、Flag、Command。這三個(gè)就像linux命令（或cmd命令）一樣，給同一個(gè)應(yīng)用程序通過(guò)傳入不同的參數(shù)來(lái)執(zhí)行不同的邏輯。

Args

app := &cli.App{
        Action: func(cCtx *cli.Context) error {
            fmt.Printf("Hello %q", cCtx.Args().Get(0))
            return nil
        },
    }

通過(guò)cCTX.Args().Get(參數(shù)索引)獲取具體的參數(shù)。

Flag

package main
import (
    "fmt"
    "log"
    "os"
    "github.com/urfave/cli/v2"
)
func main() {
    app := &cli.App{
        Flags: []cli.Flag{
            &cli.StringFlag{
                Name:  "lang",
                Value: "english",
                Usage: "language for the greeting",
            },
        },
        Action: func(cCtx *cli.Context) error {
            name := "Nefertiti"
            if cCtx.NArg() > 0 {
                name = cCtx.Args().Get(0)
            }
            if cCtx.String("lang") == "spanish" {
                fmt.Println("Hola", name)
            } else {
                fmt.Println("Hello", name)
            }
            return nil
        },
    }
    if err := app.Run(os.Args); err != nil {
        log.Fatal(err)
    }
}

對(duì)于上述代碼執(zhí)行編譯和安裝（之后的代碼修改后都需要重新執(zhí)行，后面省略此步驟，"cliTest/greet"為項(xiàng)目目錄，細(xì)節(jié)自查go install命令的使用）

go install cliTest/greet

上述文件執(zhí)行完成之后會(huì)生成可執(zhí)行文件（windows注意文件所在目錄加入到環(huán)境變量path中）

執(zhí)行 greet --help

顯示如下：

NAME:
greet - A new cli application

USAGE:
greet [global options] command [command options] [arguments...]

COMMANDS:
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--lang value language for the greeting (default: "english")
--help, -h show help

可以看到內(nèi)容主要包含：

NAME:應(yīng)用名字及說(shuō)明

USAGE:應(yīng)用的用法及格式

COMMANDS：當(dāng)前應(yīng)用支持的命令（目前只有help）

GLOBAL OPTIONS: 當(dāng)前應(yīng)用支持的可選參數(shù)

執(zhí)行greet --lang spanish eric ，輸出Hola eric，因?yàn)橥ㄟ^(guò)--lang選項(xiàng)我們?cè)O(shè)置了語(yǔ)言為spanish，在后面的執(zhí)行中同樣根據(jù)lang選項(xiàng)執(zhí)行了不同的邏輯。

執(zhí)行greet --lang english eric 和greet eric，都輸出了Hello eric，這是因?yàn)樵趌ang定義的時(shí)候設(shè)置了默認(rèn)值Value:"english"。

Flag中各個(gè)參數(shù)的含義

Name (string): 選項(xiàng)的名稱，通常由一個(gè)或多個(gè)字符組成，可以在命令行中使用來(lái)指定該選項(xiàng)。
Aliases ([]string): 選項(xiàng)的別名或替代名稱列表。這些是可選的，用于提供更多的方法來(lái)指定相同的選項(xiàng)。
Usage (string): 選項(xiàng)的簡(jiǎn)短描述，用于幫助消息和命令行幫助文檔中解釋選項(xiàng)的用途。
Value (Value): 表示選項(xiàng)的值的接口類型。這通常是一個(gè)指向變量的指針，用于存儲(chǔ)選項(xiàng)的值。
DefValue (string): 選項(xiàng)的默認(rèn)值，以字符串形式表示。如果用戶沒(méi)有提供選項(xiàng)的值，將使用此默認(rèn)值。
EnvVar (string): 選項(xiàng)的環(huán)境變量名。如果設(shè)置，可以通過(guò)環(huán)境變量來(lái)提供選項(xiàng)的值。
FilePath (string): 選項(xiàng)值表示文件路徑時(shí)，用于將相對(duì)路徑解釋為絕對(duì)路徑的基本路徑。
Required (bool): 如果為 true，表示選項(xiàng)是必需的，用戶必須提供一個(gè)值。否則，它是可選的。
Hidden (bool): 如果為 true，表示選項(xiàng)在幫助消息中不可見，通常用于隱藏高級(jí)或不常用的選項(xiàng)。
NoOptDefVal (bool): 如果為 true，表示選項(xiàng)的默認(rèn)值不會(huì)在幫助消息中顯示，用于隱藏默認(rèn)值。
HasBeenSet (bool): 用于表示用戶是否為該選項(xiàng)提供了值。通常在命令執(zhí)行時(shí)檢查此字段。
PlaceHolder (string): 用于在幫助消息中指定選項(xiàng)值的占位符，以幫助用戶理解如何提供值。
Category (string): 用于將選項(xiàng)分組到特定的類別，以便更好地組織和顯示幫助消息。
HasBeenSetExplicitly (bool): 用于表示用戶是否顯式設(shè)置了選項(xiàng)的值，以便區(qū)分用戶提供的值和默認(rèn)值。
CustomStringVar (cli.CustomStringVar): 用于提供自定義的字符串值處理函數(shù)，用于處理選項(xiàng)的字符串值。

常用的Flag類型

cli.StringFlag：用于接收字符串值的選項(xiàng)。例如：

goCopy code
cli.StringFlag{
    Name:  "config, c",
    Usage: "Load configuration from `FILE`",
}

cli.IntFlag：用于接收整數(shù)值的選項(xiàng)。例如：

goCopy code
cli.IntFlag{
    Name:  "port, p",
    Usage: "Listen on `PORT`",
}

cli.BoolFlag：用于接收布爾值（true 或 false）的選項(xiàng)。通常用于標(biāo)識(shí)性選項(xiàng)。例如：

goCopy code
cli.BoolFlag{
    Name:  "verbose, v",
    Usage: "Enable verbose mode",
}

cli.Float64Flag：用于接收浮點(diǎn)數(shù)值的選項(xiàng)。例如：

goCopy code
cli.Float64Flag{
    Name:  "threshold, t",
    Usage: "Set the threshold value",
}

cli.StringSliceFlag：用于接收多個(gè)字符串值的選項(xiàng)，返回一個(gè)字符串切片。例如：

goCopy code
cli.StringSliceFlag{
    Name:  "tags",
    Usage: "Add one or more tags",
}

cli.GenericFlag：用于自定義類型的選項(xiàng)，需要實(shí)現(xiàn) cli.Generic 接口?？梢杂糜谔幚矸菢?biāo)準(zhǔn)選項(xiàng)類型。例如：

goCopy code
cli.GenericFlag{
    Name:  "myflag",
    Value: &MyCustomType{}, // MyCustomType 需要實(shí)現(xiàn) cli.Generic 接口
    Usage: "Custom flag",
}

這些是一些常見的 cli.Flag 類型，您可以根據(jù)需要選擇適當(dāng)?shù)念愋蛠?lái)定義您的命令行選項(xiàng)。不同的類型允許您接受不同類型的值，并提供了相應(yīng)的方法來(lái)解析和處理這些值。您還可以創(chuàng)建自定義的 cli.Flag 類型來(lái)處理特定需求。Flag的類型有很多，具體的參考cli官方文檔

Command

像上面的代碼，我們本身只存在一個(gè)App，同時(shí)執(zhí)行此app會(huì)執(zhí)行器Action方法，如果希望一個(gè)App中可以定義多個(gè)Action方法，可以引入Command。同時(shí)Command還支持定義SubCommand，可以對(duì)功能進(jìn)行更細(xì)化的區(qū)分。

app := &cli.App{
        Commands: []*cli.Command{
            {
                Name:    "add",
                Aliases: []string{"a"},
                Usage:   "add a task to the list",
                Action: func(cCtx *cli.Context) error {
                    fmt.Println("added task: ", cCtx.Args().First())
                    return nil
                },
            },
            {
                Name:    "complete",
                Aliases: []string{"c"},
                Usage:   "complete a task on the list",
                Action: func(cCtx *cli.Context) error {
                    fmt.Println("completed task: ", cCtx.Args().First())
                    return nil
                },
            },
            {
                Name:    "template",
                Aliases: []string{"t"},
                Usage:   "options for task templates",
                Subcommands: []*cli.Command{
                    {
                        Name:  "add",
                        Usage: "add a new template",
                        Action: func(cCtx *cli.Context) error {
                            fmt.Println("new task template: ", cCtx.Args().First())
                            return nil
                        },
                    },
                    {
                        Name:  "remove",
                        Usage: "remove an existing template",
                        Action: func(cCtx *cli.Context) error {
                            fmt.Println("removed task template: ", cCtx.Args().First())
                            return nil
                        },
                    },
                },
            },
        },
    }
    if err := app.Run(os.Args); err != nil {
        log.Fatal(err)
    }

greet --help顯示：

COMMANDS:
add, a add a task to the list
complete, c complete a task on the list
template, t options for task templates
help, h Shows a list of commands or help for one command

可以看到當(dāng)前包含的所有命令。但并沒(méi)有顯示template命令的子命令，我們可以通過(guò)greet template --help查看template命令的幫助文檔

NAME:
greet template - options for task templates

USAGE:
greet template command [command options] [arguments...]

COMMANDS:
add add a new template
remove remove an existing template
help, h Shows a list of commands or help for one command

命令的排序

通過(guò)在代碼中app.Run之前調(diào)用sort.Sort(cli.CommandsByName(app.Commands))可以對(duì)命令按名字排序。

命令的分類

同級(jí)的命令中可以通過(guò)增加Category對(duì)命令進(jìn)行分類（同類命令在展示時(shí)會(huì)再一個(gè)類下顯示）。

例如：

Commands: []*cli.Command{
            {
                Name:    "add",
                Aliases: []string{"a"},
                Category: "C1",
                Usage:   "add a task to the list",
                Action: func(cCtx *cli.Context) error {
                    fmt.Println("added task: ", cCtx.Args().First())
                    return nil
                },
            },
            {
                Name:    "complete",
                Aliases: []string{"c"},
                Category: "C1",
                Usage:   "complete a task on the list",
                Action: func(cCtx *cli.Context) error {
                    fmt.Println("completed task: ", cCtx.Args().First())
                    return nil
                },
            },

--help顯示

COMMANDS:
template, t options for task templates
help, h Shows a list of commands or help for one command
C1:
add, a add a task to the list
complete, c complete a task on the list

Comand中各個(gè)參數(shù)的作用

Name（字符串）：命令的名稱。用于從命令行中調(diào)用該命令。
Aliases（[]字符串）：命令的別名或替代名稱列表。可以用作調(diào)用相同命令的替代方式。
Usage（字符串）：命令的簡(jiǎn)短描述，用于說(shuō)明命令的用途或功能。通常在命令行幫助消息中顯示。
UsageText（字符串）：在幫助消息的 USAGE 部分顯示的自定義文本?？稍诖颂幪峁╊~外的使用說(shuō)明。
Description（字符串）：命令如何工作的詳細(xì)解釋。提供了有關(guān)命令功能的更詳細(xì)信息。
ArgsUsage（字符串）：對(duì)該命令預(yù)期的參數(shù)的簡(jiǎn)要描述。幫助用戶了解應(yīng)該提供哪些參數(shù)。
Category（字符串）：命令所屬的類別?？捎糜诮M織和分組相關(guān)命令。
BashComplete（BashCompleteFunc）：用于檢查 bash 命令完成時(shí)調(diào)用的函數(shù)。用于命令行自動(dòng)完成。
Before（BeforeFunc）：在運(yùn)行任何子命令之前但在上下文準(zhǔn)備好后執(zhí)行的操作。如果返回非 nil 錯(cuò)誤，則不運(yùn)行任何子命令。
After（AfterFunc）：在運(yùn)行任何子命令之后但子命令完成后執(zhí)行的操作。即使 Action() 恐慌，也會(huì)運(yùn)行它。
Action（ActionFunc）：在調(diào)用該命令時(shí)要調(diào)用的主要函數(shù)。在這里定義命令的行為。
OnUsageError（OnUsageErrorFunc）：如果發(fā)生使用錯(cuò)誤（如不正確的命令行參數(shù)或標(biāo)志），則執(zhí)行此函數(shù)。
Subcommands（[]*Command）：子命令的列表。您可以在父命令下創(chuàng)建子命令的層次結(jié)構(gòu)。
Flags（[]Flag）：要解析的標(biāo)志列表。標(biāo)志用于傳遞選項(xiàng)和參數(shù)給命令。
SkipFlagParsing（布爾）：如果為 true，則將所有標(biāo)志視為普通參數(shù)?？捎糜诮锰囟畹淖詣?dòng)標(biāo)志解析。
HideHelp（布爾）：如果為 true，則隱藏內(nèi)置的幫助命令和幫助標(biāo)志。
HideHelpCommand（布爾）：如果為 true，則隱藏內(nèi)置的幫助命令，但保留幫助標(biāo)志。如果 HideHelp 為 true，則忽略此選項(xiàng)。
Hidden（布爾）：如果為 true，則從幫助或完成中隱藏該命令。這使得該命令在幫助消息中不可見。
UseShortOptionHandling（布爾）：如果為 true，則啟用短選項(xiàng)處理，使用戶能夠?qū)⒍鄠€(gè)單字符布爾參數(shù)組合成一個(gè)參數(shù)（例如，-ov）。
HelpName（字符串）：用于幫助的命令的全名。默認(rèn)為完整命令名稱，包括父命令。
CustomHelpTemplate（字符串）：命令的幫助主題的文本模板。您可以通過(guò)設(shè)置此變量來(lái)提供自定義幫助文本。
categories（CommandCategories）：包含已分類命令的結(jié)構(gòu)，在應(yīng)用程序啟動(dòng)時(shí)填充。
isRoot（布爾）：指示是否為根 "特殊" 命令。
separator（separatorSpec）：用于分隔參數(shù)的分隔符配置。