CMDR-05: Tricks / Walks / Hooks

時間 2019-12-07

標籤 cmdr tricks walks hooks 简体版

原文原文鏈接

暫時來說，這是最後一篇關於 cmdr 的系列介紹文章了。git

全部這個系列包括：github

這一次的內容算是雜燴亂燉。數據庫

Tricks

`~~debug`

已經在前文講述過了。這裏再也不湊字數了。小程序

`--tree`

cmdr 提供了一個內置的選項：--tree。segmentfault

雖然這是一個選項，但它和 --version 同樣是有着命令同樣的效果：若是 cmdr 在命令行參數中檢測到了 --tree，那麼它會忽略已經處理的和將要處理的子命令、選項，直接執行 --tree 的 Action。markdown

要想達到相似的效果並不困難：
定義一個選項，重載其 Action 字段到一個響應函數，而且在該響應函數的結尾返回 cmdr.ErrShouldBeStopException，這樣就會在該選項被識別時並執行Action後直接退出應用程序了。函數

--tree 的功能是打印出所有命令和子命令，以樹結構方式呈現出來。微服務

一個樣例以下圖：ui

這是我在開發階段執行 examples/demo 小程序所獲得的結果。

Walk for all commands

--tree 其實是利用了 cmdr 內建的 WalkAllCommands() 所提供的遍歷方式。spa

對全部命令及其選項進行遍歷，實際上有兩種方式：一是利用 Painter 以及相應的內部機制，二是經過 WalkAllCommands 明確地遍歷。

`Painter`

Painter 是一個接口。它被用在輸出幫助屏這個方面。儘管輸出幫助屏只是一個小小的功能，但你仍是能夠自定義它的行爲。你能夠自行實現 Painter 接口並經過 SetCurrentHelpPainter(painter) 來更改幫助屏的顯示內容。

若是你真的想這麼作，能夠查閱 Painter 的定義，也能夠 issue 到我，或許說不定我可以有所建議。

`Walker`

WalAllCommands(cmd, index, walker) 是一個更爲強大的遍歷器，實際上 manpage，markdown 的輸出就是經過這個機制來實現的。利用這個遍歷器，你能夠便利整個命令集的樹狀結構。通常來講，你應該給它傳遞 cmd=nil, index=0 的參數值來開始你的遍歷，這表示將會從頂級命令開始遍歷，並且將其視做第 0 層。index 這個參數將會在遍歷器遞歸時自動修正到符合層級計數，而後會被傳遞給 walker。我只是懶得將它改爲 level 名字了，它就是那個用途。

例如 --tree 的實現源代碼以下：

func dumpTreeForAllCommands(cmd *Command, args []string) (err error) {
    command := &rootCommand.Command
    _ = walkFromCommand(command, 0, func(cmd *Command, index int) (e error) {
        if cmd.Hidden {
            return
        }

        deep := findDepth(cmd) - 1
        if deep == 0 {
            fmt.Println("ROOT")
        } else {
            sp := strings.Repeat("  ", deep)
            // fmt.Printf("%s%v - \x1b[%dm\x1b[%dm%s\x1b[0m\n",
            //     sp, cmd.GetTitleNames(),
            //     BgNormal, CurrentDescColor, cmd.Description)

            if len(cmd.Deprecated) > 0 {
                fmt.Printf("%s\x1b[%dm\x1b[%dm%s - %s\x1b[0m [deprecated since %v]\n",
                    sp, BgNormal, CurrentDescColor, cmd.GetTitleNames(), cmd.Description,
                    cmd.Deprecated)
            } else {
                fmt.Printf("%s%s - \x1b[%dm\x1b[%dm%s\x1b[0m\n",
                    sp, cmd.GetTitleNames(), BgNormal, CurrentDescColor, cmd.Description)
            }
        }
        return
    })
    return ErrShouldBeStopException
}

比較

能夠想象到你可以藉助這個遍歷器實現某些更強大的特性，在具有遍歷能力的基礎上，咱們其實能夠設計更強大的命令行界面結構，而沒必要擔憂過度複雜帶來的負面效果。

關於如何設計命令行界面的體系結構，保持其清晰性，這個不是咱們再這個系列文章中要討論的話題。

至於 Painter 和 Walker，其區別也很明顯。Painter 是被限定在幫助屏構造層面的，且不會遞歸下去，除非你想自行實現。Walker 是全局層面的遞歸遍歷器，面向的是全部的命令。

Actions

Action for `Command`

Command的 Action 字段能夠定義你的命令的業務實現邏輯。

func MsTagsList(cmd *cmdr.Command, args []string) (err error) {
    return
}

通常來講，你在 impl package 中定義業務實現邏輯的入口，如同上面的代碼示例，並在某個 Command 的數據定義中引用它。

msTagsListCommand = &cmdr.Command {
    BaseOpt: cmdr.BaseOpt {
        Short: "ls",
        Full: "list",
        Description: "list all tags of a micro-service",
        Action: impl.MsTagsList,
    }
}

因此，對於 Command 來講，Action 多是最重要的 Hook。

PreAction & PostAction for `Command`

在 Command 的 Action 被執行以前，其 PreAction 會被首先調用，你能夠定義本身的邏輯，例如檢查特定條件是否知足，若是不知足則返回一個error以通知cmdr錯誤性結束。若是你認爲並無錯誤發生，但仍應該結束處理，你能夠返回一個 cmdr.ErrShouldBeStopException，這樣的話 cmdr 也會結束處理，但整個 program 會被正常終止：反應到 Shell 層面上時，此時程序是無錯的，Shell返回值爲0。

在 Command 的 Action 被執行以後，不管處理結果如何，PostAction 將會被調用。它能夠用來進行某些退出時邏輯處理。

PreAction & PostAction for `RootCommand`

在被命中的命令的 PreAction 和 PostAction 被執行之際，RootCommand 的 PreAction 和 PostAction 也會分別被執行。這是一個關鍵性的特性。它使得你能夠妥善地實現你的全局預處理和後處理邏輯，例如註冊微服務到註冊中心以及撤銷註冊，鏈接到數據庫和關閉數據庫鏈接，等等。