go語言Pflag Viper Cobra 核心功能使用介紹

Posted on by

1.如何構建應用框架

一般來說構建應用框架包含3個部分：

  • 命令行參數解析
  • 配置文件解析
  • 應用的命令行框架：需要具備 Help 功能、需要能夠解析命令行參數和配置文件、命令需要能夠初始化業務代碼，並最終啟動業務進程 上3個需求便涉及Pflag、Viper、Cobra的使用，並且這三個包也是相互聯系滴

2.命令行參數解析工具：Pflag

雖然 Go 源碼中提供瞭一個標準庫 Flag 包，用來對命令行參數進行解析，但在大型項目中應用更廣泛的是另外一個包：Pflag

2.1 Pflag 包 Flag 定義

Pflag 可以對命令行參數進行處理，一個命令行參數在 Pflag 包中會解析為一個 Flag 類型的變量

type Flag struct {
    Name                string // flag長選項的名稱
    Shorthand           string // flag短選項的名稱，一個縮寫的字符
    Usage               string // flag的使用文本
    Value               Value  // flag的值
    DefValue            string // flag的默認值
    Changed             bool // 記錄flag的值是否有被設置過
    NoOptDefVal         string // 當flag出現在命令行，但是沒有指定選項值時的默認值
    Deprecated          string // 記錄該flag是否被放棄
    Hidden              bool // 如果值為true，則從help/usage輸出信息中隱藏該flag
    ShorthandDeprecated string // 如果flag的短選項被廢棄，當使用flag的短選項時打印該信息
    Annotations         map[string][]string // 給flag設置註解
}

Flag 的值是一個 Value 類型的接口，Value 定義如下

type Value interface {
    String() string // 將flag類型的值轉換為string類型的值，並返回string的內容
    Set(string) error // 將string類型的值轉換為flag類型的值，轉換失敗報錯
    Type() string // 返回flag的類型，例如：string、int、ip等
}

2.2 Pflag 包 FlagSet 定義

Pflag 除瞭支持單個的 Flag 之外，還支持 FlagSet。FlagSet 是一些預先定義好的 Flag 的集合

  • 調用 NewFlagSet 創建一個 FlagSet
  • 使用 Pflag 包定義的全局 FlagSet：CommandLine
var version bool
flagSet := pflag.NewFlagSet("test", pflag.ContinueOnError)
flagSet.BoolVar(&version, "version", true, "Print version information and quit.")
=================================
import (
    "github.com/spf13/pflag"
)
pflag.BoolVarP(&version, "version", "v", true, "Print version information and quit.")
func BoolVarP(p *bool, name, shorthand string, value bool, usage string) {
    flag := CommandLine.VarPF(newBoolValue(value, p), name, shorthand, usage)
    flag.NoOptDefVal = "true"
}

2.3 Pflag 使用方法

  • 支持多種命令行參數定義方式
// 支持長選項、默認值和使用文本，並將標志的值存儲在指針中。
var name = pflag.String("name", "colin", "Input Your Name")
// 支持長選項、短選項、默認值和使用文本，並將標志的值存儲在指針中
var name = pflag.StringP("name", "n", "colin", "Input Your Name")
// 支持長選項、默認值和使用文本，並將標志的值綁定到變量。
var name string
pflag.StringVar(&name, "name", "colin", "Input Your Name")
// 支持長選項、短選項、默認值和使用文本，並將標志的值綁定到變量。
var name string
pflag.StringVarP(&name, "name", "n","colin", "Input Your Name")
// 函數名帶Var說明是將標志的值綁定到變量，否則是將標志的值存儲在指針中
// 函數名帶P說明支持短選項，否則不支持短選項。
  • 使用Get獲取參數的值。
i, err := flagset.GetInt("flagname")
  • 獲取非選項參數。
package main
import (
    "fmt"
    "github.com/spf13/pflag"
)
var (
    flagvar = pflag.Int("flagname", 1234, "help message for flagname")
)
// 在定義完標志之後，可以調用pflag.Parse()來解析定義的標志。解析後，可通過pflag.Args()返回所有的非選項參數，通過pflag.Arg(i)返回第 i 個非選項參數。參數下標 0 到 pflag.NArg() - 1。
func main() {
    pflag.Parse()
    fmt.Printf("argument number is: %v\n", pflag.NArg())
    fmt.Printf("argument list is: %v\n", pflag.Args())
    fmt.Printf("the first argument is: %v\n", pflag.Arg(0))
}
  • 指定瞭選項但是沒有指定選項值時的默認值。
var ip = pflag.IntP("flagname", "f", 1234, "help message")
pflag.Lookup("flagname").NoOptDefVal = "4321"
--flagname=1357 ==> 1357
--flagname ==> 4321
[nothing] ==> 1234
  • 棄用標志或者標志的簡寫
// deprecate a flag by specifying its name and a usage message
pflag.CommandLine.MarkDeprecated("logmode", "please use --log-mode instead")
  • 保留名為 port 的標志，但是棄用它的簡寫形式
pflag.IntVarP(&port, "port", "P", 3306, "MySQL service host port.")
// deprecate a flag shorthand by specifying its flag name and a usage message
pflag.CommandLine.MarkShorthandDeprecated("port", "please use --port only")
  • 隱藏標志。
// 可以將 Flag 標記為隱藏的，這意味著它仍將正常運行，但不會顯示在 usage/help 文本中。
// hide a flag by specifying its name
pflag.CommandLine.MarkHidden("secretFlag")

3.配置解析神器：Viper

幾乎所有的後端服務，都需要一些配置項來配置我們的服務;Viper 是 Go 應用程序現代化的、完整的解決方案，能夠處理不同格式的配置文件 Viper 可以從不同的位置讀取配置，不同位置的配置具有不同的優先級:

  • 通過 viper.Set 函數顯示設置的配置
  • 命令行參數
  • 環境變量
  • 配置文件
  • Key/Value 存儲
  • 默認值

3.1讀入配置

讀入配置，就是將配置讀入到 Viper 中，有如下讀入方式：

  • 設置默認值。
// 當沒有通過配置文件、環境變量、遠程配置或命令行標志設置 key 時，設置默認值通常是很有用的
viper.SetDefault("ContentDir", "content")
viper.SetDefault("LayoutDir", "layouts")
viper.SetDefault("Taxonomies", map[string]string{"tag": "tags", "category": "categories"})
  • 讀取配置文件
package main
import (
  "fmt"
  "github.com/spf13/pflag"
  "github.com/spf13/viper"
)
var (
  cfg  = pflag.StringP("config", "c", "", "Configuration file.")
  help = pflag.BoolP("help", "h", false, "Show this help message.")
)
func main() {
  pflag.Parse()
  if *help {
    pflag.Usage()
    return
  }
  // 從配置文件中讀取配置
  if *cfg != "" {
    viper.SetConfigFile(*cfg)   // 指定配置文件名
    viper.SetConfigType("yaml") // 如果配置文件名中沒有文件擴展名，則需要指定配置文件的格式，告訴viper以何種格式解析文件
  } else {
    viper.AddConfigPath(".")          // 把當前目錄加入到配置文件的搜索路徑中
    viper.AddConfigPath("$HOME/.iam") // 配置文件搜索路徑，可以設置多個配置文件搜索路徑
    viper.SetConfigName("config")     // 配置文件名稱（沒有文件擴展名）
  }
  if err := viper.ReadInConfig(); err != nil { // 讀取配置文件。如果指定瞭配置文件名，則使用指定的配置文件，否則在註冊的搜索路徑中搜索
    panic(fmt.Errorf("Fatal error config file: %s \n", err))
  }
  fmt.Printf("Used configuration file is: %s\n", viper.ConfigFileUsed())
}
  • 監聽和重新讀取配置文件。 Viper 支持在運行時讓應用程序實時讀取配置文件，也就是熱加載配置
viper.WatchConfig()
viper.OnConfigChange(func(e fsnotify.Event) {
   // 配置文件發生變更之後會調用的回調函數
  fmt.Println("Config file changed:", e.Name)
})
//不建議在實際開發中使用熱加載功能，因為即使配置熱加載瞭，程序中的代碼也不一定會熱加載。例如：修改瞭服務監聽端口，但是服務沒有重啟，這時候服務還是監聽在老的端口上，會造成不一致
  • 設置配置值
// 可以通過 viper.Set() 函數來顯式設置配置：
viper.Set("user.username", "colin")
  • 使用環境變量
// 使用環境變量
os.Setenv("VIPER_USER_SECRET_ID", "QLdywI2MrmDVjSSv6e95weNRvmteRjfKAuNV")
os.Setenv("VIPER_USER_SECRET_KEY", "bVix2WBv0VPfrDrvlLWrhEdzjLpPCNYb")
viper.AutomaticEnv()                                             // 讀取環境變量
viper.SetEnvPrefix("VIPER")                                      // 設置環境變量前綴：VIPER_，如果是viper，將自動轉變為大寫。
viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_", "-", "_")) // 將viper.Get(key) key字符串中'.'和'-'替換為'_'
viper.BindEnv("user.secret-key")
viper.BindEnv("user.secret-id", "USER_SECRET_ID") // 綁定環境變量名到key
  • 使用標志 Viper 支持 Pflag 包，能夠綁定 key 到 Flag。與 BindEnv 類似，在調用綁定方法時，不會設置該值，但在訪問它時會設置。
viper.BindPFlag("token", pflag.Lookup("token")) // 綁定單個標志
viper.BindPFlags(pflag.CommandLine)             //綁定標志集

3.2 讀取配置

  • 訪問嵌套的鍵。
{
    "host": {
        "address": "localhost",
        "port": 5799
    },
    "datastore": {
        "metric": {
            "host": "127.0.0.1",
            "port": 3099
        },
        "warehouse": {
            "host": "198.0.0.1",
            "port": 2112
        }
    }
}
viper.GetString("datastore.metric.host") // (返回 "127.0.0.1")
  • 反序列化 Viper 可以支持將所有或特定的值解析到結構體、map 等。可以通過兩個函數來實現：
type config struct {
  Port int
  Name string
  PathMap string `mapstructure:"path_map"`
}
var C config
err := viper.Unmarshal(&C)
if err != nil {
  t.Fatalf("unable to decode into struct, %v", err)
}

Viper 在後臺使用github.com/mitchellh/mapstructure來解析值，其默認情況下使用mapstructure tags。當我們需要將 Viper 讀取的配置反序列到我們定義的結構體變量中時，一定要使用 mapstructure tags

  • 序列化成字符串
import (
    yaml "gopkg.in/yaml.v2"
    // ...
)
func yamlStringSettings() string {
    c := viper.AllSettings()
    bs, err := yaml.Marshal(c)
    if err != nil {
        log.Fatalf("unable to marshal config to YAML: %v", err)
    }
    return string(bs)
}

4.現代化的命令行框架：Cobra

Cobra 既是一個可以創建強大的現代 CLI 應用程序的庫，也是一個可以生成應用和命令文件的程序 應用程序通常遵循如下模式：APPNAME VERB NOUN –ADJECTIVE或者APPNAME COMMAND ARG –FLAG VERB 代表動詞，NOUN 代表名詞，ADJECTIVE 代表形容詞

4.1 使用 Cobra 庫創建命令

  • 創建 rootCmd
$ mkdir -p newApp2 && cd newApp2
// 通常情況下，我們會將 rootCmd 放在文件 cmd/root.go 中。
var rootCmd = &cobra.Command{
  Use:   "hugo",
  Short: "Hugo is a very fast static site generator",
  Long: `A Fast and Flexible Static Site Generator built with
                love by spf13 and friends in Go.
                Complete documentation is available at http://hugo.spf13.com`,
  Run: func(cmd *cobra.Command, args []string) {
    // Do Stuff Here
  },
}
func Execute() {
  if err := rootCmd.Execute(); err != nil {
    fmt.Println(err)
    os.Exit(1)
  }
}
// 還可以在 init() 函數中定義標志和處理配置
import (
  "fmt"
  "os"
  homedir "github.com/mitchellh/go-homedir"
  "github.com/spf13/cobra"
  "github.com/spf13/viper"
)
var (
    cfgFile     string
    projectBase string
    userLicense string
)
func init() {
  cobra.OnInitialize(initConfig)
  rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.cobra.yaml)")
  rootCmd.PersistentFlags().StringVarP(&projectBase, "projectbase", "b", "", "base project directory eg. github.com/spf13/")
  rootCmd.PersistentFlags().StringP("author", "a", "YOUR NAME", "Author name for copyright attribution")
  rootCmd.PersistentFlags().StringVarP(&userLicense, "license", "l", "", "Name of license for the project (can provide `licensetext` in config)")
  rootCmd.PersistentFlags().Bool("viper", true, "Use Viper for configuration")
  viper.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author"))
  viper.BindPFlag("projectbase", rootCmd.PersistentFlags().Lookup("projectbase"))
  viper.BindPFlag("useViper", rootCmd.PersistentFlags().Lookup("viper"))
  viper.SetDefault("author", "NAME HERE <EMAIL ADDRESS>")
  viper.SetDefault("license", "apache")
}
func initConfig() {
  // Don't forget to read config either from cfgFile or from home directory!
  if cfgFile != "" {
    // Use config file from the flag.
    viper.SetConfigFile(cfgFile)
  } else {
    // Find home directory.
    home, err := homedir.Dir()
    if err != nil {
      fmt.Println(err)
      os.Exit(1)
    }
    // Search config in home directory with name ".cobra" (without extension).
    viper.AddConfigPath(home)
    viper.SetConfigName(".cobra")
  }
  if err := viper.ReadInConfig(); err != nil {
    fmt.Println("Can't read config:", err)
    os.Exit(1)
  }
}
  • 創建 main.go 我們還需要一個 main 函數來調用 rootCmd，通常我們會創建一個 main.go 文件，在 main.go 中調用 rootCmd.Execute() 來執行命令
package main
import (
  "{pathToYourApp}/cmd"
)
func main() {
  cmd.Execute()
}
  • 添加命令 通常情況下，我們會把其他命令的源碼文件放在 cmd/ 目錄下，例如，我們添加一個 version 命令，可以創建 cmd/version.go 文件
package cmd
import (
  "fmt"
  "github.com/spf13/cobra"
)
func init() {
  rootCmd.AddCommand(versionCmd)
}
var versionCmd = &cobra.Command{
  Use:   "version",
  Short: "Print the version number of Hugo",
  Long:  `All software has versions. This is Hugo's`,
  Run: func(cmd *cobra.Command, args []string) {
    fmt.Println("Hugo Static Site Generator v0.9 -- HEAD")
  },
}
  • 編譯並運行
$ go mod init github.com/marmotedu/gopractise-demo/cobra/newApp2
$ go build -v .
$ ./newApp2 -h
A Fast and Flexible Static Site Generator built with
love by spf13 and friends in Go.
Complete documentation is available at http://hugo.spf13.com
Usage:
hugo [flags]
hugo [command]
Available Commands:
help Help about any command
version Print the version number of Hugo
Flags:
-a, --author string Author name for copyright attribution (default "YOUR NAME")
--config string config file (default is $HOME/.cobra.yaml)
-h, --help help for hugo
-l, --license licensetext Name of license for the project (can provide licensetext in config)
-b, --projectbase string base project directory eg. github.com/spf13/
--viper Use Viper for configuration (default true)
 Use "hugo [command] --help" for more information about a command.

4.2使用標志

Cobra 可以跟 Pflag 結合使用，實現強大的標志功能

// 使用持久化的標志
rootCmd.PersistentFlags().BoolVarP(&Verbose, "verbose", "v", false, "verbose output")
// 分配一個本地標志，本地標志隻能在它所綁定的命令上使用
rootCmd.Flags().StringVarP(&Source, "source", "s", "", "Source directory to read from")
// 將標志綁定到 Viper
var author string
func init() {
 rootCmd.PersistentFlags().StringVar(&author, "author", "YOUR NAME", "Author name for copyright attribution")
 viper.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author"))
}
// 設置標志為必選
rootCmd.Flags().StringVarP(&Region, "region", "r", "", "AWS region (required)")
rootCmd.MarkFlagRequired("region")

5.總結

在開發 Go 項目時，我們可以通過 Pflag 來解析命令行參數，通過 Viper 來解析配置文件，用 Cobra 來實現命令行框架。

你可以通過 pflag.String()、 pflag.StringP()、pflag.StringVar()、pflag.StringVarP() 方法來設置命令行參數，並使用 Get 來獲取參數的值

以上就是go語言Pflag Viper Cobra 核心功能使用介紹的詳細內容，更多關於Go語言Pflag Viper Cobra功能的資料請關註WalkonNet其它相關文章！

推薦閱讀：