Golang開發命令行之flag包的使用方法
1、命令行工具概述
日常命令行操作,相對應的眾多命令行工具是提高生產力的必備工具,鼠標能夠讓用戶更容易上手,降低用戶學習成本。 而對於開發者,鍵盤操作模式能顯著提升生產力,還有在一些專業工具中, 大量使用快捷鍵代替繁瑣的鼠標操作,能夠使開發人員更加專註於工作,提高效率,因為鍵盤操作模式更容易產生肌肉記憶
舉個栗子:我司業務研發,前些年在我們的強力推動下(被迫)轉向使用瞭 git
作為版本控制,開始使用的是圖形化“小烏龜”工具。後續出現幾次問題解決起來較麻煩後,推薦其使用原生的 git 命令行。如今,使用 git 命令行操作版本控制可謂 “一頓操作猛如虎……”
命令行(鍵盤)操作在很大程度上可以提高工作效率,與之相對應的是鼠標(觸屏等)操作,這兩種模式是目前的主流人機交互方式
設計一款命令行工具的開發語言可以選擇原始的 shell
、甚至是更原始的語言 C ,更為容易上手且功能更多的有 node
、 python
、 golang
本文是基於 golang
開發命令行工具的開篇,主要是基於 golang
原生內置的、輕量的 flag
包實現,用 golang
設計命令行工具而不用 shell
、 python
的原因這裡就不做論述瞭
2、flag包介紹
flag 包用來解析命令行參數
相比簡單的使用 os.Args
來獲取命令行參數, flag
可以實現按照更為通用的命令行用法,例如 mysql -u root -p 123456
。其中 mysql
是命令行的名稱即這個命令, -u
和 -p
分別是這個命令的兩個參數:用戶名和密碼,後面接著的是對應的參數值,有瞭參數的聲明之後,兩個參數可以互換位置,參數值也可以選填或按照缺省(默認)值進行指定
flag
包支持的命令行參數的類型有 bool
、 int
、 int64
、 uint
、 uint64
、 float float64
、 string
、 duration
即佈爾值、整型、浮點型、字符串、時間段類型
3、flag包命令行參數的定義
定義 flag
命令行參數,用來接收命令行輸入的參數值,一般有以下兩種方法
flag.TypeVar():先定義參數(實際上是指針),再定義 flag.TypeVar
將命令行參數存儲(綁定)到前面參數的值的指針(地址)
var name string var age int var height float64 var graduated bool // &name 就是接收用戶命令行中輸入的-n後面的參數值 // 返回值是一個用來存儲name參數的值的指針/地址 // 定義string類型命令行參數name,括號中依次是變量名、flag參數名、默認值、參數說明 flag.StringVar(&name, "n", "", "name參數,默認為空") // 定義整型命令行參數age flag.IntVar(&age,"a", 0, "age參數,默認為0") // 定義浮點型命令行參數height flag.Float64Var(&height,"h", 0, "height參數,默認為0") // 定義佈爾型命令行參數graduated flag.BoolVar(&graduated,"g", false, "graduated參數,默認為false")
flag.Type():
用短變量聲明的方式定義參數類型及變量名
// 定義string類型命令行參數name,括號中依次是flag參數名、默認值、參數說明 namePtr := flag.String("n", "", "name參數,默認為空") // 定義整型命令行參數age age := flag.Int("a", 0, "age參數,默認為0") // 定義浮點型命令行參數height height := flag.Float64("h", 0, "height參數,默認為0") // 定義佈爾型命令行參數graduated graduated:= flag.Bool("g", false, "graduated參數,默認為false")
4、flag包命令行參數解析
固定用法,定義好參數後,通過調用 flag.Parse()
來對命令行參數進行解析寫入註冊的 flag
裡,進而解析獲取參數值,通過查看源碼中也是調用的 os.Args
源碼路徑 go/src/flag/flag.go
// Parse parses the command-line flags from os.Args[1:]. Must be called // after all flags are defined and before flags are accessed by the program. func Parse() { // Ignore errors; CommandLine is set for ExitOnError. CommandLine.Parse(os.Args[1:]) }
進而查看 Parse
方法的源碼
func (f *FlagSet) Parse(arguments []string) error { f.parsed = true f.args = arguments for { seen, err := f.parseOne() if seen { continue } if err == nil { break } switch f.errorHandling { case ContinueOnError: return err case ExitOnError: if err == ErrHelp { os.Exit(0) } os.Exit(2) case PanicOnError: panic(err) } } return nil }
真正解析參數的是 parseOne
方法(這裡省略源碼),結論是
- 當遇到單獨的一個 “-” 或不是 “-” 開始時,會停止解析
- 遇到連續的兩個 “-” 時,解析停止
- 在終止符”-“之後停止
解析參數時,對於參數的指定方式一般有”-“、”–“、以及是否空格等方式,組合下來有如下幾種方式
-flag xxx | 空格和一個 – 符號 |
---|---|
–flag xxx | 空格和兩個 – 符號 |
-flag=xxx | 等號和一個 – 符號 |
–flag=xxx | 等號和兩個 – 符號 |
其中, -flag xxx
方式最為常用,如果參數是佈爾型,隻能用等號方式指定
5、flag包命令行幫助
flag
包默認會根據定義的命令行參數,在使用時如果不輸入參數就打印對應的幫助信息
這樣的幫助信息我們可以對其進行覆蓋去改變默認的 Usage
package main import ( "flag" "fmt" ) func main() { var host string var port int var verbor bool var help bool // 綁定命令行參數與變量關系 flag.StringVar(&host, "H", "127.0.0.1", "ssh host") flag.IntVar(&port, "P", 22, "ssh port") flag.BoolVar(&verbor, "v", false, "detail log") flag.BoolVar(&help, "h", false, "help") // 自定義-h flag.Usage = func() { fmt.Println(` Usage: flag [-H addr] [-p port] [-v] Options: `) flag.PrintDefaults() } // 解析命令行參數 flag.Parse() if help { flag.Usage() } else { fmt.Println(host, port, verbor) } } /* ➜ go run flag_args.go -h Usage: flag [-H addr] [-p port] [-v] Options: -H string ssh host (default "127.0.0.1") -P int ssh port (default 22) -h help -v detail log */
6、flag定義短參數和長參數
簡單來說,短參數和長參數,就是例如我們在使用某些命令時,查看命令版本可以輸入 -V
,也可以輸入 --version
。這種情況下, flag
並沒有默認支持,但是可以通過可以兩個選項共享同一個變量來實現,即通過給某個相同的變量設置不同的選項,參數在初始化的時候其順序是不固定的,因此還需要保證其擁有相同的默認值
package main import ( "fmt" "flag" ) var logLevel string func init() { const ( defaultLogLevel = "DEBUG" usage = "set log level" ) flag.StringVar(&logLevel, "log_level", defaultLogLevel, usage) flag.StringVar(&logLevel, "l", defaultLogLevel, usage + "(shorthand)") } func main() { flag.Parse() fmt.Println("log level:", logLevel) }
通過 const
聲明公共的常量,並在默認值以及幫助信息中去使用,這樣就可以實現瞭
7、示例
實現計算字符串或目錄下遞歸計算文件 md5
的命令,類似 linux
的 md5sum
命令
其中利用 bufio
分批次讀取文件,防止文件過大時造成資源占用高
package main import ( "bufio" "crypto/md5" "flag" "fmt" "io" "os" "strings" ) func md5reader(reader *bufio.Reader) string { // hasher := md5.New() // 定義MD5 hash計算器 bytes := make([]byte, 1024*1024*10) // 分批次讀取文件 for { n, err := reader.Read(bytes) if err != nil { if err != io.EOF { return "" } break } else { hasher.Write(bytes[:n]) } } return fmt.Sprintf("%x", hasher.Sum(nil)) } func md5file(path string) (string, error) { file, err := os.Open(path) if err != nil { return "", err } else { defer file.Close() return md5reader(bufio.NewReader(file)), nil } } func md5str(txt string) (string, error) { return md5reader(bufio.NewReader(strings.NewReader(txt))), nil //return fmt.Sprintf("%x", md5.Sum([]byte(txt))) } func main() { txt := flag.String("s", "", "md5 txt") path := flag.String("f", "", "file path") help := flag.Bool("h", false, "help") flag.Usage = func() { fmt.Println(` Usage: md5 [-s 123abc] [-f path] Options: `) flag.PrintDefaults() } flag.Parse() if *help || *txt == "" && *path == "" { flag.Usage() } else { var md5 string var err error if *path != "" { md5, err = md5file(*path) } else { md5, err = md5str(*txt) } if err != nil { fmt.Println(err) } else { fmt.Println(md5) } } }
編譯生成二進制文件
➜ go build -o md5go -x md5_bufio.go ➜ ll md5go -rwxr-xr-x 1 ssgeek staff 1.9M Oct 2 00:54 md5go
測試使用
➜ ./md5go -h Usage: md5 [-s 123abc] [-f path] Options: -f string file path -h help -s string md5 txt ➜ ./md5go -s 123456 e10adc3949ba59abbe56e057f20f883e ➜ ./md5go -f md5_bufio.go 8607a07cbb98cec0e9abe14b0db0bee6
到此這篇關於Golang開發命令行之flag包的使用方法的文章就介紹到這瞭,更多相關Golang開發命令行之flag包的使用內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- go語言基礎 seek光標位置os包的使用
- Golang 基於 flag 庫實現一個簡單命令行工具
- GoLang讀取文件的10種方法實例
- Go語言中使用urfave/cli命令行框架
- golang逐行讀取文件的操作