前言
相信只要部署過線上服務,都知道啟動參數一定是必不可少的,當你在不同的網絡、硬件、軟件環境下去啟動一個服務的時候,總會有一些啟動參數是不確定的,這時候就需要通過命令行模塊去解析這些參數,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
*/
}
上面代碼只實現了兩個簡單命令,兩個命令最后的處理函數不同,自然使用不同命令,最后的輸出也不一樣。