網(wǎng)站首頁(yè) 編程語(yǔ)言正文

Golang?flag包的具體使用_Golang

作者：sparkdev ? 更新時(shí)間： 2023-05-21 編程語(yǔ)言

在 Golang 程序中有很多種方法來(lái)處理命令行參數(shù)。簡(jiǎn)單的情況下可以不使用任何庫(kù)，直接處理 os.Args；其實(shí) Golang 的標(biāo)準(zhǔn)庫(kù)提供了 flag 包來(lái)處理命令行參數(shù)；還有第三方提供的處理命令行參數(shù)的庫(kù)，比如 Pflag 等。本文將介紹 Golang 標(biāo)準(zhǔn)庫(kù)中 flag 包的用法。本文的演示環(huán)境為 ubuntu 18.04。

入門(mén) demo

在 Go workspace 的 src 目錄下創(chuàng)建 flagdemo 目錄，并在目錄下創(chuàng)建 main.go 文件，編輯其內(nèi)容如下：

package main

import "flag"
import "fmt"

// 定義命令行參數(shù)對(duì)應(yīng)的變量，這三個(gè)變量都是指針類(lèi)型
var cliName = flag.String("name", "nick", "Input Your Name")
var cliAge = flag.Int("age", 28, "Input Your Age")
var cliGender = flag.String("gender", "male", "Input Your Gender")

// 定義一個(gè)值類(lèi)型的命令行參數(shù)變量，在 Init() 函數(shù)中對(duì)其初始化
// 因此，命令行參數(shù)對(duì)應(yīng)變量的定義和初始化是可以分開(kāi)的
var cliFlag int
func Init() {
    flag.IntVar(&cliFlag, "flagname", 1234, "Just for demo")
}

func main() {
    // 初始化變量 cliFlag
    Init()
    // 把用戶傳遞的命令行參數(shù)解析為對(duì)應(yīng)變量的值
    flag.Parse()
    
    // flag.Args() 函數(shù)返回沒(méi)有被解析的命令行參數(shù)
    // func NArg() 函數(shù)返回沒(méi)有被解析的命令行參數(shù)的個(gè)數(shù)
    fmt.Printf("args=%s, num=%d\n", flag.Args(), flag.NArg())
    for i := 0; i != flag.NArg(); i++ {
        fmt.Printf("arg[%d]=%s\n", i, flag.Arg(i))
    }
    
    // 輸出命令行參數(shù)
    fmt.Println("name=", *cliName)
    fmt.Println("age=", *cliAge)
    fmt.Println("gender=", *cliGender)
    fmt.Println("flagname=", cliFlag)
}

使用 flag 包前要通過(guò) import 命令導(dǎo)入該包：

import "flag"

定義一個(gè)整型的參數(shù) age，返回指針類(lèi)型的變量：

var cliAge = flag.Int("age", 28, "Input Your Age")

創(chuàng)建值類(lèi)型的參數(shù)變量，并在 Init() 函數(shù)中對(duì)其初始化(注意這里調(diào)用的是 flag.IntVar 方法)：

var cliFlag int
func Init() {
    flag.IntVar(&cliFlag, "flagname", 1234, "Just for demo")
}

通過(guò) flag.Parse() 函數(shù)接下命令行參數(shù)，解析函數(shù)將會(huì)在碰到第一個(gè)非 flag 命令行參數(shù)時(shí)停止：

flag.Parse()

命令行傳參的格式：

-isbool    (一個(gè) - 符號(hào)，布爾類(lèi)型該寫(xiě)法等同于 -isbool=true)
-age=x     (一個(gè) - 符號(hào)，使用等號(hào))
-age x     (一個(gè) - 符號(hào)，使用空格)
--age=x    (兩個(gè) - 符號(hào)，使用等號(hào))
--age x    (兩個(gè) - 符號(hào)，使用空格)

運(yùn)行 demo

在 flagdemo 目錄下執(zhí)行 go build 命令編譯 demo 生成可執(zhí)行文件 flagdemo。

不傳遞命令行參數(shù)

此時(shí)輸出的命令行參數(shù)都是定義的默認(rèn)值。

傳遞命令行參數(shù)

傳遞的命令行參數(shù)會(huì)覆蓋默認(rèn)值。

傳遞多余的命令行參數(shù)

可以通過(guò) flag.Args() 和 flag.NArg() 函數(shù)獲取未能解析的命令行參數(shù)。

傳遞錯(cuò)誤的命令行參

如果通過(guò) -xx 傳入未定義的命令行參數(shù)，則會(huì)直接報(bào)錯(cuò)退出，并輸出幫助信息。

查看幫助信息

通過(guò)命令行參數(shù) -h 或 --help 可以查看幫助信息：

解讀 flag 包源碼

flag 包支持的類(lèi)型有 Bool、Duration、Float64、Int、Int64、String、Uint、Uint64。這些類(lèi)型的參數(shù)被封裝到其對(duì)應(yīng)的后端類(lèi)型中，比如 Int 類(lèi)型的參數(shù)被封裝為 intValue，String 類(lèi)型的參數(shù)被封裝為 stringValue。這些后端的類(lèi)型都實(shí)現(xiàn)了 Value 接口，因此可以把一個(gè)命令行參數(shù)抽象為一個(gè) Flag 類(lèi)型的實(shí)例。下面是 Value 接口和 Flag 類(lèi)型的代碼：

// Value 接口
type Value interface {
    String() string
    Set(string) error
}

// Flag 類(lèi)型
type Flag struct {
    Name     string // name as it appears on command line
    Usage    string // help message
    Value    Value  // value as set 是個(gè) interface，因此可以是不同類(lèi)型的實(shí)例。
    DefValue string // default value (as text); for usage message
}

intValue 等類(lèi)型實(shí)現(xiàn)了 Value 接口，因此可以賦值給 Flag 類(lèi)型中的 Value 字段，下面是 intValue 類(lèi)型的定義：

// -- int Value
type intValue int

func newIntValue(val int, p *int) *intValue {
    *p = val
    return (*intValue)(p)
}

func (i *intValue) Set(s string) error {
    v, err := strconv.ParseInt(s, 0, strconv.IntSize)
    *i = intValue(v)
    return err
}

func (i *intValue) Get() interface{} { return int(*i) }
func (i *intValue) String() string { return strconv.Itoa(int(*i)) }

所有的參數(shù)被保存在 FlagSet 類(lèi)型的實(shí)例中，F(xiàn)lagSet 類(lèi)型的定義如下：

// A FlagSet represents a set of defined flags.
type FlagSet struct {
    Usage func()

    name          string
    parsed        bool
    actual         map[string]*Flag    // 中保存從命令行參數(shù)中解析到的參數(shù)實(shí)例
    formal        map[string]*Flag    // 中保存定義的命令行參數(shù)實(shí)例(實(shí)例中包含了默認(rèn)值)
    args          []string // arguments after flags
    errorHandling ErrorHandling
    output        io.Writer // nil means stderr; use out() accessor
}

Flag 包被導(dǎo)入時(shí)創(chuàng)建了 FlagSet 類(lèi)型的對(duì)象 CommandLine：

var CommandLine = NewFlagSet(os.Args[0], ExitOnError)

在程序中定義的所有命令行參數(shù)變量都會(huì)被加入到 CommandLine 的 formal 屬性中，其具體的調(diào)用過(guò)程如下：

var cliAge = flag.Int("age", 28, "Input Your Age")
func Int(name string, value int, usage string) *int {
    return CommandLine.Int(name, value, usage)
}
func (f *FlagSet) Int(name string, value int, usage string) *int {
    p := new(int)
    f.IntVar(p, name, value, usage)
    return p
}
func (f *FlagSet) IntVar(p *int, name string, value int, usage string) {
    f.Var(newIntValue(value, p), name, usage)
}
func (f *FlagSet) Var(value Value, name string, usage string) {
    // Remember the default value as a string; it won't change.
    flag := &Flag{name, usage, value, value.String()}
    _, alreadythere := f.formal[name]
    if alreadythere {
        var msg string
        if f.name == "" {
            msg = fmt.Sprintf("flag redefined: %s", name)
        } else {
            msg = fmt.Sprintf("%s flag redefined: %s", f.name, name)
        }
        fmt.Fprintln(f.Output(), msg)
        panic(msg) // Happens only if flags are declared with identical names
    }
    if f.formal == nil {
        f.formal = make(map[string]*Flag)
    }
    // 把命令行參數(shù)對(duì)應(yīng)的變量添加到 formal 中
    f.formal[name] = flag
}

命令行參數(shù)的解析過(guò)程則由 flag.Parse() 函數(shù)完成，其調(diào)用過(guò)程大致如下：

func Parse() {
    CommandLine.Parse(os.Args[1:])
}
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:
            os.Exit(2)
        case PanicOnError:
            panic(err)
        }
    }
    return nil
}

最終由 FlagSet 的 parseOne() 方法執(zhí)行解析任務(wù)：

func (f *FlagSet) parseOne() (bool, error) {
…
flag.Value.Set(value)
…
f.actual[name] = flag
…
}

總結(jié)

本文介紹了 Golang 標(biāo)準(zhǔn)庫(kù)中 flag 包的基本用法，并進(jìn)一步分析了其主要的代碼邏輯。其實(shí) flag 包還支持用戶自定義類(lèi)型的命令行參數(shù)，本文不再贅述，有興趣的朋友請(qǐng)參考官方 demo。

參考：
package flag
Go by Example: Command-Line Flags
USING COMMAND LINE FLAGS IN GO
Golang之使用Flag和Pflag
Go語(yǔ)言學(xué)習(xí)之flag包(The way to go)
Golang flag demo

作者：sparkdev

出處：http://www.cnblogs.com/sparkdev/

原文鏈接：https://www.cnblogs.com/sparkdev/p/10812422.html

日本免费高清视频-国产福利视频导航-黄色在线播放国产-天天操天天操天天操天天操|www.shdianci.com

網(wǎng)站首頁(yè) 編程語(yǔ)言正文

Golang?flag包的具體使用_Golang

目錄

入門(mén) demo

運(yùn)行 demo

解讀 flag 包源碼

總結(jié)

相關(guān)推薦

日本免费高清视频-国产福利视频导航-黄色在线播放国产-天天操天天操天天操天天操|www.shdianci.com

網(wǎng)站首頁(yè) 編程語(yǔ)言 正文

Golang?flag包的具體使用_Golang

目錄

入門(mén) demo

運(yùn)行 demo

解讀 flag 包源碼

總結(jié)

相關(guān)推薦

網(wǎng)站首頁(yè) 編程語(yǔ)言正文