前言
相信只要部署過線上服務，都知道啟動參數一定是必不可少的，當你在不同的網絡、硬件、軟件環境下去啟動一個服務的時候，總會有一些啟動參數是不確定的，這時候就需要通過命令行模塊去解析這些參數，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",c.Args().First())
},
},
}
//啟動
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, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help
--version, -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",
Usage: "say a greeting",
Action: func(c *cli.Context) error {
fmt.Println("Greetings")
return nil
},
Subcommands: []*cli.Command{
daemonStopCmd,
},
}
// 接受os.Args啟動程序
app.Run(os.Args)
}
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。如有錯誤或未考慮完全的地方，望不吝賜教。
您可能感興趣的文章:- golang執行命令操作 exec.Command
- golang執行命令獲取執行結果狀態(推薦)
- Golang命令行進行debug調試操作
- golang中命令行庫cobra的使用方法示例
- 利用Golang如何調用Linux命令詳解
- Golang匯編命令解讀及使用
