Go 每日一庫之 viper

簡介

上一篇文章介紹 cobra 的時候提到了 viper，今天我們就來介紹一下這個庫。
viper 是一個配置解決方案，擁有豐富的特性：

• 支持 JSON/TOML/YAML/HCL/envfile/Java properties 等多種格式的配置文件；
• 可以設置監聽配置文件的修改，修改時自動加載新的配置；
• 從環境變量、命令行選項和io.Reader中讀取配置；
• 從遠程配置系統中讀取和監聽修改，如 etcd/Consul；
• 代碼邏輯中顯示設置鍵值。

快速使用

安裝：

$ go get github.com/spf13/viper

使用：

package main

import (
  "fmt"
  "log"

  "github.com/spf13/viper"
)

func main() {
  viper.SetConfigName("config")
  viper.SetConfigType("toml")
  viper.AddConfigPath(".")
  viper.SetDefault("redis.port", 6381)
  err := viper.ReadInConfig()
  if err != nil {
    log.Fatal("read config failed: %v", err)
  }

  fmt.Println(viper.Get("app_name"))
  fmt.Println(viper.Get("log_level"))

  fmt.Println("mysql ip: ", viper.Get("mysql.ip"))
  fmt.Println("mysql port: ", viper.Get("mysql.port"))
  fmt.Println("mysql user: ", viper.Get("mysql.user"))
  fmt.Println("mysql password: ", viper.Get("mysql.password"))
  fmt.Println("mysql database: ", viper.Get("mysql.database"))

  fmt.Println("redis ip: ", viper.Get("redis.ip"))
  fmt.Println("redis port: ", viper.Get("redis.port"))
}

我們使用之前Go 每日一庫之 go-ini一文中使用的配置，不過改為 toml 格式。
toml 的語法很簡單，快速入門請看learn X in Y minutes。

app_name = "awesome web"

# possible values: DEBUG, INFO, WARNING, ERROR, FATAL
log_level = "DEBUG"

[mysql]
ip = "127.0.0.1"
port = 3306
user = "dj"
password = 123456
database = "awesome"

[redis]
ip = "127.0.0.1"
port = 7381

viper 的使用非常簡單，它需要很少的設置。設置文件名（SetConfigName）、配置類型（SetConfigType）和搜索路徑（AddConfigPath），然后調用ReadInConfig。
viper會自動根據類型來讀取配置。使用時調用viper.Get方法獲取鍵值。

編譯、運行程序：

awesome web
DEBUG
mysql ip:  127.0.0.1
mysql port:  3306
mysql user:  dj
mysql password:  123456
mysql database:  awesome
redis ip:  127.0.0.1
redis port:  7381

有幾點需要注意：

• 設置文件名時不要帶后綴；
• 搜索路徑可以設置多個，viper 會根據設置順序依次查找；
• viper 獲取值時使用section.key的形式，即傳入嵌套的鍵名；
• 默認值可以調用viper.SetDefault設置。

讀取鍵

viper 提供了多種形式的讀取方法。在上面的例子中，我們看到了Get方法的用法。Get方法返回一個interface{}的值，使用有所不便。

GetType系列方法可以返回指定類型的值。
其中，Type 可以為Bool/Float64/Int/String/Time/Duration/IntSlice/StringSlice。
但是請注意，如果指定的鍵不存在或類型不正確，GetType方法返回對應類型的零值。

如果要判斷某個鍵是否存在，使用IsSet方法。
另外，GetStringMap和GetStringMapString直接以 map 返回某個鍵下面所有的鍵值對，前者返回map[string]interface{}，后者返回map[string]string。
AllSettings以map[string]interface{}返回所有設置。

// 省略包名和 import 部分

func main() {
  viper.SetConfigName("config")
  viper.SetConfigType("toml")
  viper.AddConfigPath(".")
  err := viper.ReadInConfig()
  if err != nil {
    log.Fatal("read config failed: %v", err)
  }

  fmt.Println("protocols: ", viper.GetStringSlice("server.protocols"))
  fmt.Println("ports: ", viper.GetIntSlice("server.ports"))
  fmt.Println("timeout: ", viper.GetDuration("server.timeout"))

  fmt.Println("mysql ip: ", viper.GetString("mysql.ip"))
  fmt.Println("mysql port: ", viper.GetInt("mysql.port"))

  if viper.IsSet("redis.port") {
    fmt.Println("redis.port is set")
  } else {
    fmt.Println("redis.port is not set")
  }

  fmt.Println("mysql settings: ", viper.GetStringMap("mysql"))
  fmt.Println("redis settings: ", viper.GetStringMap("redis"))
  fmt.Println("all settings: ", viper.AllSettings())
}

我們在配置文件 config.toml 中添加protocols和ports配置：

[server]
protocols = ["http", "https", "port"]
ports = [10000, 10001, 10002]
timeout = 3s

編譯、運行程序，輸出：

protocols:  [http https port]
ports:  [10000 10001 10002]
timeout:  3s
mysql ip:  127.0.0.1
mysql port:  3306
redis.port is set
mysql settings:  map[database:awesome ip:127.0.0.1 password:123456 port:3306 user:dj]
redis settings:  map[ip:127.0.0.1 port:7381]
all settings:  map[app_name:awesome web log_level:DEBUG mysql:map[database:awesome ip:127.0.0.1 password:123456 port:3306 user:dj] redis:map[ip:127.0.0.1 port:7381] server:map[ports:[10000 10001 10002] protocols:[http https port]]]

如果將配置中的redis.port注釋掉，將輸出redis.port is not set。

上面的示例中還演示了如何使用time.Duration類型，只要是time.ParseDuration接受的格式都可以，例如3s、2min、1min30s等。

設置鍵值

viper 支持在多個地方設置，使用下面的順序依次讀取：

• 調用Set顯示設置的；
• 命令行選項；
• 環境變量；
• 配置文件；
• 默認值。

viper.Set

如果某個鍵通過viper.Set設置了值，那么這個值的優先級最高。

viper.Set("redis.port", 5381)

如果將上面這行代碼放到程序中，運行程序，輸出的redis.port將是 5381。

命令行選項

如果一個鍵沒有通過viper.Set顯示設置值，那么獲取時將嘗試從命令行選項中讀取。
如果有，優先使用。viper 使用 pflag 庫來解析選項。
我們首先在init方法中定義選項，並且調用viper.BindPFlags綁定選項到配置中：

func init() {
  pflag.Int("redis.port", 8381, "Redis port to connect")

  // 綁定命令行
  viper.BindPFlags(pflag.CommandLine)
}

然后，在main方法開頭處調用pflag.Parse解析選項。

編譯、運行程序：

$ ./main.exe --redis.port 9381
awesome web
DEBUG
mysql ip:  127.0.0.1
mysql port:  3306
mysql user:  dj
mysql password:  123456
mysql database:  awesome
redis ip:  127.0.0.1
redis port:  9381

如何不傳入選項：

$ ./main.exe
awesome web
DEBUG
mysql ip:  127.0.0.1
mysql port:  3306
mysql user:  dj
mysql password:  123456
mysql database:  awesome
redis ip:  127.0.0.1
redis port:  7381

注意，這里並不會使用選項redis.port的默認值。

但是，如果通過下面的方法都無法獲得鍵值，那么返回選項默認值（如果有）。試試注釋掉配置文件中redis.port看看效果。

環境變量

如果前面都沒有獲取到鍵值，將嘗試從環境變量中讀取。我們既可以一個個綁定，也可以自動全部綁定。

在init方法中調用AutomaticEnv方法綁定全部環境變量：

func init() {
  // 綁定環境變量
  viper.AutomaticEnv()
}

為了驗證是否綁定成功，我們在main方法中將環境變量 GOPATH 打印出來：

func main() {
  // 省略部分代碼

  fmt.Println("GOPATH: ", viper.Get("GOPATH"))
}

通過 系統 -> 高級設置 -> 新建 創建一個名為redis.port的環境變量，值為 10381。
運行程序，輸出的redis.port值為 10381，並且輸出中有 GOPATH 信息。

也可以單獨綁定環境變量：

func init() {
  // 綁定環境變量
  viper.BindEnv("redis.port")
  viper.BindEnv("go.path", "GOPATH")
}

func main() {
  // 省略部分代碼
  fmt.Println("go path: ", viper.Get("go.path"))
}

調用BindEnv方法，如果只傳入一個參數，則這個參數既表示鍵名，又表示環境變量名。
如果傳入兩個參數，則第一個參數表示鍵名，第二個參數表示環境變量名。

還可以通過viper.SetEnvPrefix方法設置環境變量前綴，這樣一來，通過AutomaticEnv和一個參數的BindEnv綁定的環境變量，
在使用Get的時候，viper 會自動加上這個前綴再從環境變量中查找。

如果對應的環境變量不存在，viper 會自動將鍵名全部轉為大寫再查找一次。所以，使用鍵名gopath也能讀取環境變量GOPATH的值。

配置文件

如果經過前面的途徑都沒能找到該鍵，viper 接下來會嘗試從配置文件中查找。
為了避免環境變量的影響，需要刪除redis.port這個環境變量。

看快速使用中的示例。

默認值

在上面的快速使用一節，我們已經看到了如何設置默認值，這里就不贅述了。

讀取配置

從io.Reader中讀取

viper 支持從io.Reader中讀取配置。這種形式很靈活，來源可以是文件，也可以是程序中生成的字符串，甚至可以從網絡連接中讀取的字節流。

package main

import (
  "bytes"
  "fmt"
  "log"

  "github.com/spf13/viper"
)

func main() {
  viper.SetConfigType("toml")
  tomlConfig := []byte(`
app_name = "awesome web"

# possible values: DEBUG, INFO, WARNING, ERROR, FATAL
log_level = "DEBUG"

[mysql]
ip = "127.0.0.1"
port = 3306
user = "dj"
password = 123456
database = "awesome"

[redis]
ip = "127.0.0.1"
port = 7381
`)
  err := viper.ReadConfig(bytes.NewBuffer(tomlConfig))
  if err != nil {
    log.Fatal("read config failed: %v", err)
  }

  fmt.Println("redis port: ", viper.GetInt("redis.port"))
}

Unmarshal

viper 支持將配置Unmarshal到一個結構體中，為結構體中的對應字段賦值。

package main

import (
  "fmt"
  "log"

  "github.com/spf13/viper"
)

type Config struct {
  AppName  string
  LogLevel string

  MySQL    MySQLConfig
  Redis    RedisConfig
}

type MySQLConfig struct {
  IP       string
  Port     int
  User     string
  Password string
  Database string
}

type RedisConfig struct {
  IP   string
  Port int
}

func main() {
  viper.SetConfigName("config")
  viper.SetConfigType("toml")
  viper.AddConfigPath(".")
  err := viper.ReadInConfig()
  if err != nil {
    log.Fatal("read config failed: %v", err)
  }

  var c Config
  viper.Unmarshal(&c)

  fmt.Println(c.MySQL)
}

編譯，運行程序，輸出：

{127.0.0.1 3306 dj 123456 awesome}

保存配置

有時候，我們想要將程序中生成的配置，或者所做的修改保存下來。viper 提供了接口！

• WriteConfig：將當前的 viper 配置寫到預定義路徑，如果沒有預定義路徑，返回錯誤。將會覆蓋當前配置；
• SafeWriteConfig：與上面功能一樣，但是如果配置文件存在，則不覆蓋；
• WriteConfigAs：保存配置到指定路徑，如果文件存在，則覆蓋；
• SafeWriteConfig：與上面功能一樣，但是入股配置文件存在，則不覆蓋。

下面我們通過程序生成一個config.toml配置：

package main

import (
  "log"

  "github.com/spf13/viper"
)

func main() {
  viper.SetConfigName("config")
  viper.SetConfigType("toml")
  viper.AddConfigPath(".")

  viper.Set("app_name", "awesome web")
  viper.Set("log_level", "DEBUG")
  viper.Set("mysql.ip", "127.0.0.1")
  viper.Set("mysql.port", 3306)
  viper.Set("mysql.user", "root")
  viper.Set("mysql.password", "123456")
  viper.Set("mysql.database", "awesome")

  viper.Set("redis.ip", "127.0.0.1")
  viper.Set("redis.port", 6381)

  err := viper.SafeWriteConfig()
  if err != nil {
    log.Fatal("write config failed: ", err)
  }
}

編譯、運行程序，生成的文件如下：

app_name = "awesome web"
log_level = "DEBUG"

[mysql]
  database = "awesome"
  ip = "127.0.0.1"
  password = "123456"
  port = 3306
  user = "root"

[redis]
  ip = "127.0.0.1"
  port = 6381

監聽文件修改

viper 可以監聽文件修改，熱加載配置。因此不需要重啟服務器，就能讓配置生效。

package main

import (
  "fmt"
  "log"
  "time"

  "github.com/spf13/viper"
)

func main() {
  viper.SetConfigName("config")
  viper.SetConfigType("toml")
  viper.AddConfigPath(".")
  err := viper.ReadInConfig()
  if err != nil {
    log.Fatal("read config failed: %v", err)
  }

  viper.WatchConfig()

  fmt.Println("redis port before sleep: ", viper.Get("redis.port"))
  time.Sleep(time.Second * 10)
  fmt.Println("redis port after sleep: ", viper.Get("redis.port"))
}

只需要調用viper.WatchConfig，viper 會自動監聽配置修改。如果有修改，重新加載的配置。

上面程序中，我們先打印redis.port的值，然后Sleep 10s。在這期間修改配置中redis.port的值，Sleep結束后再次打印。
發現打印出修改后的值：

redis port before sleep:  7381
redis port after sleep:  73810

另外，還可以為配置修改增加一個回調：

viper.OnConfigChange(func(e fsnotify.Event) {
  fmt.Printf("Config file:%s Op:%s\n", e.Name, e.Op)
})

這樣文件修改時會執行這個回調。

viper 使用fsnotify這個庫來實現監聽文件修改的功能。

完整示例代碼見 GitHub。

參考

1. viper GitHub 倉庫

我

我的博客

歡迎關注我的微信公眾號【GoUpUp】，共同學習，一起進步~

本文由博客一文多發平台 OpenWrite 發布！