Golang中基礎的命令列模組urfave/cli的用法說明
前言
相信只要部署過線上服務，都知道啟動引數一定是必不可少的，當你在不同的網路、硬體、軟體環境下去啟動一個服務的時候，總會有一些啟動引數是不確定的，這時候就需要通過命令列模組去解析這些引數，urfave/cli是Golang中一個簡單實用的命令列工具。
安裝
通過 go get github.com/urfave/cli 命令即可完成安裝。
正文
使用了urfave/cli之後，你的程式就會變成一個命令列程式，以下就是通過urfave/cli建立的一個最簡單的命令列程式，它設定了一些基礎的資訊，這個程式的最終只是簡單的列印了Test資訊。
package main
import (
"github.com/urfave/cli"
"os"
"log"
"fmt"
)
func main() {
//例項化一個命令列程式
oApp := cli.NewApp()
//程式名稱
oApp.Name = "GoTool"
//程式的用途描述
oApp.Usage = "To save the world"
//程式的版本號
oApp.Version = "1.0.0"
//該程式執行的程式碼
oApp.Action = func(c *cli.Context) error {
fmt.Println("Test")
return nil
}
//啟動
if err := oApp.Run(os.Args); err != nil {
log.Fatal(err)
}
/*
result:
[root@localhost cli]# go run main.go help
NAME:
GoTool - To save the world
USAGE:
main [global options] command [command options] [arguments...]
VERSION:
1.0.0
COMMANDS:
help,h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help,-h show help
--version,-v print the version
[root@localhost cli]# go run main.go
Test
*/
}我們看到執行 go run main.go help 之後會輸出一些幫助資訊，說明你的程式已經成功成為一個命令列程式，接著使用命令 go run main.go 執行這個程式，結果是列印了Test資訊，所以這個程式實際執行的函式由oApp.Action來控制，你後面的程式碼應該都在這個函式的內部去實現。
接下來我們設定一些常見的啟動引數，非常的簡單，程式碼如下
package main
import (
"github.com/urfave/cli"
"os"
"log"
"fmt"
)
func main() {
//例項化一個命令列程式
oApp := cli.NewApp()
//程式名稱
oApp.Name = "GoTool"
//程式的用途描述
oApp.Usage = "To save the world"
//程式的版本號
oApp.Version = "1.0.0"
//預置變數
var host string
var debug bool
//設定啟動引數
oApp.Flags = []cli.Flag{
//引數型別string,int,bool
cli.StringFlag{
Name: "host",//引數名字
Value: "127.0.0.1",//引數預設值
Usage: "Server Address",//引數功能描述
Destination: &host,//接收值的變數
},cli.IntFlag{
Name: "port,p",Value: 8888,Usage: "Server port",},cli.BoolFlag{
Name: "debug",Usage: "debug mode",Destination: &debug,}
//該程式執行的程式碼
oApp.Action = func(c *cli.Context) error {
fmt.Printf("host=%v \n",host)
fmt.Printf("host=%v \n",c.Int("port")) //不使用變數接收，直接解析
fmt.Printf("host=%v \n",debug)
/*
result:
[root@localhost cli]# go run main.go --port 7777
host=127.0.0.1
host=7777
host=false
[root@localhost cli]# go run main.go help
NAME:
GoTool - To save the world
USAGE:
main [global options] command [command options] [arguments...]
VERSION:
1.0.0
COMMANDS:
help,h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--host value Server Address (default: "127.0.0.1")
--port value,-p value Server port (default: 8888)
--debug debug mode
--help,-h show help
--version,-v print the version
*/
return nil
}
//啟動
if err := oApp.Run(os.Args); err != nil {
log.Fatal(err)
}
}執行 go run main.go --port 7777 之後，可以看到輸出了設定的7777埠而非預設的8888埠，而伺服器地址（host）和除錯模式（debug）都輸出了預設的數值。
如果第三方人員第一次使用你的程式也可以通過help命令看到可以設定的引數都有哪些，非常的人性化。
當然，urfave/cli還允許我們設定多個命令，不同的命令執行不同的操作，具體如下
package main
import (
"github.com/urfave/cli"
"os"
"log"
"fmt"
)
func main() {
//例項化一個命令列程式
oApp := cli.NewApp()
//程式名稱
oApp.Name = "GoTool"
//程式的用途描述
oApp.Usage = "To save the world"
//程式的版本號
oApp.Version = "1.0.0"
//設定多個命令處理函式
oApp.Commands = []cli.Command{
{
//命令全稱
Name:"lang",//命令簡寫
Aliases:[]string{"l"},//命令詳細描述
Usage:"Setting language",//命令處理函式
Action: func(c *cli.Context) {
// 通過c.Args().First()獲取命令列引數
fmt.Printf("language=%v \n",c.Args().First())
},{
Name:"encode",Aliases:[]string{"e"},Usage:"Setting encoding",Action: func(c *cli.Context) {
fmt.Printf("encoding=%v \n",}
//啟動
if err := oApp.Run(os.Args); err != nil {
log.Fatal(err)
}
/*
[root@localhost cli]# go run main.go l english
language=english
[root@localhost cli]# go run main.go e utf8
encoding=utf8
[root@localhost cli]# go run main.go help
NAME:
GoTool - To save the world
USAGE:
main [global options] command [command options] [arguments...]
VERSION:
1.0.0
COMMANDS:
lang,l Setting language
encode,e Setting encoding
help,-v print the version
*/
}上面程式碼只實現了兩個簡單命令，兩個命令最後的處理函式不同，自然使用不同命令，最後的輸出也不一樣。
補充：Go語言命令列庫-urfave/cli（gopkg.in/urfave/cli.v2）
Go語言命令列庫-urfave/cli
官網：https://github.com/urfave/cli
很多用Go寫的命令列程式都用了urfave/cli這個庫。urfave/cli是一個命令列的框架。
用C寫過命令列程式的人應該都不陌生，我們需要根據argc/argv一個個地解析命令列引數，呼叫不同的函式，最後還要寫一個usage()函式用於列印幫助資訊。urfave/cli把這個過程做了一下封裝，抽象出flag/command/subcommand這些模組，使用者只需要提供一些模組的配置，引數的解析和關聯在庫內部完成，幫助資訊也可以自動生成。
總體來說，urfave/cli這個庫還是很好用的，完成了很多routine的工作，程式設計師只需要專注於具體業務邏輯的實現。
怎麼使用urfave/cli
go如何編寫命令列(cli)程式
首先下載類庫包
go get github.com/urfave/cli
main.go
package main
import (
"os"
"github.com/urfave/cli/v2"
"fmt"
)
func main() {
app := &cli.App{
Name: "greet",Usage: "say a greeting",Action: func(c *cli.Context) error {
fmt.Println("Greetings")
return nil
},}
// 接受os.Args啟動程式
app.Run(os.Args)
}
Flags 用於設定引數。
Action 對應的函式就是你具體對各個引數具體的處理邏輯。
“gopkg.in/urfave/cli.v2” 和 “github.com/urfave/cli”
官網：https://github.com/urfave/cli
gopkg：一種方便的go pakcage管理方式
根據官網 readme描述，現在2個版本，主版本使用的是 v2 分支。
匯入包為： “github.com/urfave/cli/v2”
有些 go 的程式碼庫地址是gopkg.in開頭的，比如gopkg.in/urfave/cli.v2。
v2 表明版本號為 v2，而程式碼則為 github 上面相應的 v2 branch。
這個也是 Go 的包管理解決方案之一，就是 gopkg.in 做了一個轉發過程，實際上是使用了 github 裡面的相應的 tag 的程式碼
子命令 Subcommands
如下 demo所示，我們再Action:同層新增 我們定義指標 &cli.Command 變數即可。
demo:
var daemonStopCmd = &cli.Command{
Name: "stop",Usage: "Stop a running lotus daemon",Flags: []cli.Flag{},Action: func(cctx *cli.Context) error {
panic("wombat attack")
},}
func main() {
app := &cli.App{
Name: "greet",Subcommands: []*cli.Command{
daemonStopCmd,}
// 接受os.Args啟動程式
app.Run(os.Args)
}
以上為個人經驗，希望能給大家一個參考，也希望大家多多支援我們。如有錯誤或未考慮完全的地方，望不吝賜教。