cmdr 03 - 用流式接口定義命令行參數處理選項

時間 2019-12-07

標籤 cmdr 接口定義命令行參數處理選項简体版

原文原文鏈接

cmdr 03 - 用流式接口定義命令行參數處理選項
基於 v0.2.17git

轉眼已經來到了 cmdr v0.2.17 了，爲了解決此前版本中關於子命令和選項定義語句的太多嵌套的問題，咱們實現了流式調用接口（Fluent APIs）。github

cmdr 是我發佈的一個開源的 golang 命令行參數處理器。它是 golang flags 的替代品。之因此發佈它，是由於已有的 command line UI 三方包沒法知足個人平常要求，迫不得己本身造一個。若是還沒有有了解 cmdr 怎麼使用的，不妨抽空瀏覽個人早前文章，以求得到一些基本概念：golang

稍後我會繼續針對 cmdr 的用法作介紹文章。segmentfault

至於本文呢，只是簡單講述一下如何使用 cmdr 的流式接口（Fluent API）來完成定義。api

定義 RootCommand

root := cmdr.Root("aa", "1.0.1").Header("aa - test for cmdr - no version")
rootCmd = root.RootCommand()

第二句是拿到一個 *cmdr.Command 指針，稍後能夠作一下相關的其它操做。函數

此外，rootCmd 做爲函數返回值，也便於被用到向 cmdr.Exec() 作傳遞參數。post

func buildCmds() *cmdr.Command {
    root := ...
    rootCmdr = root.RootCommand()
    ...
    return rootCmdr
}

func main() {
    if err := cmdr.Exec(buildCmds()); err != nil {
        logrus.Fatal(err)
    }
}

定義命令 Command

頂級的命令其實就是 RootCommand 的子命令，因此：測試

co := root.NewSubCommand().
        Titles("ms", "micro-service").
        Description("", "").
        Group("")

在這裏，你能夠作的定義基本上和 cmdr.Command 結構定義是相匹配的，因此你可使用 OptCmd接口所支持的方法來完成一條命令的定義：ui

// OptCmd to support fluent api of cmdr.
// see also: cmdr.Root().NewSubCommand()/.NewFlag()
OptCmd interface {
    Titles(short, long string, aliases ...string) (opt OptCmd)
    Short(short string) (opt OptCmd)
    Long(long string) (opt OptCmd)
    Aliases(ss ...string) (opt OptCmd)
    Description(oneLine, long string) (opt OptCmd)
    Examples(examples string) (opt OptCmd)
    Group(group string) (opt OptCmd)
    Hidden(hidden bool) (opt OptCmd)
    Deprecated(deprecation string) (opt OptCmd)
    Action(action func(cmd *Command, args []string) (err error)) (opt OptCmd)

    // FlagAdd(flg *Flag) (opt OptCmd)
    // SubCommand(cmd *Command) (opt OptCmd)
    PreAction(pre func(cmd *Command, args []string) (err error)) (opt OptCmd)
    PostAction(post func(cmd *Command, args []string)) (opt OptCmd)
    TailPlaceholder(placeholder string) (opt OptCmd)

    NewFlag(typ OptFlagType) (opt OptFlag)
    NewSubCommand() (opt OptCmd)

    OwnerCommand() (opt OptCmd)
    SetOwner(opt OptCmd)

    RootCommand() *RootCommand
}

定義選項 Flag

對於每條命令，你均可覺得其附着一系列的選項，這是經過 NewFlag 來完成的：命令行

co.NewFlag(cmdr.OptFlagTypeUint).
        Titles("t", "retry").
        Description("", "").
        Group("").
        DefaultValue(3, "RETRY")

相似的，全部 OptFlag 接口支持的方法均可以用在這裏：

// OptFlag to support fluent api of cmdr.
// see also: cmdr.Root().NewSubCommand()/.NewFlag()
OptFlag interface {
    Titles(short, long string, aliases ...string) (opt OptFlag)
    Short(short string) (opt OptFlag)
    Long(long string) (opt OptFlag)
    Aliases(ss ...string) (opt OptFlag)
    Description(oneLine, long string) (opt OptFlag)
    Examples(examples string) (opt OptFlag)
    Group(group string) (opt OptFlag)
    Hidden(hidden bool) (opt OptFlag)
    Deprecated(deprecation string) (opt OptFlag)
    Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

    ToggleGroup(group string) (opt OptFlag)
    DefaultValue(val interface{}, placeholder string) (opt OptFlag)
    ExternalTool(envKeyName string) (opt OptFlag)

    OwnerCommand() (opt OptCmd)
    SetOwner(opt OptCmd)

    RootCommand() *RootCommand
}