viper4android 系统io错误,golang配置信息库viper的使用

0. 前言

Viper(毒蛇)是一个方便Go语言应用程序处理配置信息的库。它可以处理多种格式的配置。它支持的特性：设置默认值

从JSON，TOML，YAML，HCL和Java属性配置文件中读取

实时观看和重新读取配置文件(可选)

从环境变量中读取

从远程配置系统(etcd或Consul)读取，并观察变化

从命令行标志读取

从缓冲区读取

设置显式值

Viper读取配置信息的优先级顺序，从高到低，如下：显式调用Set函数

命令行参数

环境变量

配置文件

key/value 存储系统

默认值

Viper 的配置项的key不区分大小写。

1. 安装使用

1.0 安装1go get -u github.com/spf13/viper

1.1 设置默认值

默认值不是必须的，如果配置文件、环境变量、远程配置系统、命令行参数、Set函数都没有指定时，默认值将起作用。1

2

3viper.SetDefault("ContentDir", "content")

viper.SetDefault("LayoutDir", "layouts")

viper.SetDefault("Taxonomies", map[string]string{"tag": "tags", "category": "categories"})

1.2 读取配置文件

Viper支持JSON、TOML、YAML、HCL和Java properties文件。

Viper可以搜索多个路径，但目前单个Viper实例仅支持单个配置文件。

Viper默认不搜索任何路径。

以下是如何使用Viper搜索和读取配置文件的示例。

路径不是必需的，但最好至少应提供一个路径，以便找到一个配置文件。1

2

3

4

5

6

7

8viper.SetConfigName("config") // 设置配置文件名 (不带后缀)

viper.AddConfigPath("/etc/appname/") // 第一个搜索路径

viper.AddConfigPath("$HOME/.appname") // 可以多次调用添加路径

viper.AddConfigPath(".") // 比如添加当前目录

err := viper.ReadInConfig() // 搜索路径，并读取配置数据

if err != nil {

panic(fmt.Errorf("Fatal error config file: %s \n", err))

}

1.3 监视配置文件，重新读取配置数据

Viper支持让您的应用程序在运行时拥有读取配置文件的能力。

需要重新启动服务器以使配置生效的日子已经一去不复返了，由viper驱动的应用程序可以在运行时读取已更新的配置文件，并且不会错过任何节拍。

只需要调用viper实例的WatchConfig函数，你也可以指定一个回调函数来获得变动的通知。1

2

3

4viper.WatchConfig()

viper.OnConfigChange(func(e fsnotify.Event) {

fmt.Println("Config file changed:", e.Name)

})

1.4 从 io.Reader 中读取配置

Viper预先定义了许多配置源，例如文件、环境变量、命令行参数和远程K / V存储系统，但您并未受其约束。

您也可以实现自己的配置源，并提供给viper。1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20viper.SetConfigType("yaml") // or viper.SetConfigType("YAML")

// any approach to require this configuration into your program.

var yamlExample = []byte(`

Hacker: true

name: steve

hobbies:

- skateboarding

- snowboarding

- go

clothing:

jacket: leather

trousers: denim

age: 35

eyes : brown

beard: true

`)

viper.ReadConfig(bytes.NewBuffer(yamlExample))

viper.Get("name") // 返回 "steve"

1.5 注册并使用别名1

2

3

4

5

6

7viper.RegisterAlias("loud", "Verbose")

viper.Set("verbose", true)

viper.Set("loud", true) // 这两句设置的都是同一个值

viper.GetBool("loud") // true

viper.GetBool("verbose") // true

1.6 从环境变量中读取

Viper 完全支持环境变量，这是的应用程序可以开箱即用。

有四个和环境变量有关的方法：AutomaticEnv()

BindEnv(string…) : error

SetEnvPrefix(string)

SetEnvKeyReplacer(string…) *strings.Replacer

注意，环境变量时区分大小写的。

Viper提供了一种机制来确保Env变量是唯一的。通过SetEnvPrefix，在从环境变量读取时会添加设置的前缀。BindEnv和AutomaticEnv都会使用到这个前缀。

BindEnv需要一个或两个参数。第一个参数是键名，第二个参数是环境变量的名称。环境变量的名称区分大小写。如果未提供ENV变量名称，则Viper会自动假定该键名称与ENV变量名称匹配，并且ENV变量为全部大写。当您显式提供ENV变量名称时，它不会自动添加前缀。

使用ENV变量时要注意，当关联后，每次访问时都会读取该ENV值。Viper在BindEnv调用时不读取ENV值。

AutomaticEnv与SetEnvPrefix结合将会特别有用。当AutomaticEnv被调用时，任何viper.Get请求都会去获取环境变量。环境变量名为SetEnvPrefix设置的前缀，加上对应名称的大写。

SetEnvKeyReplacer允许你使用一个strings.Replacer对象来将配置名重写为Env名。如果你想在Get()中使用包含-的配置名 ，但希望对应的环境变量名包含_分隔符，就可以使用该方法。使用它的一个例子可以在项目中viper_test.go文件里找到。

例子：1

2

3

4

5

6SetEnvPrefix("spf") // 将会自动转为大写

BindEnv("id")

os.Setenv("SPF_ID", "13") // 通常通过系统环境变量来设置

id := Get("id") // 13

1.7 绑定命令行参数

Viper支持绑定pflags参数。

和BindEnv一样，当绑定方法被调用时，该值没有被获取，而是在被访问时获取。这意味着应该尽早进行绑定，甚至是在init()函数中绑定。

利用BindPFlag()方法可以绑定单个flag。例子：1

2serverCmd.Flags().Int("port", 1138, "Port to run Application server on")

viper.BindPFlag("port", serverCmd.Flags().Lookup("port"))

你也可以绑定已存在的pflag集合 (pflag.FlagSet):1

2

3

4

5

6pflag.Int("flagname", 1234, "help message for flagname")

pflag.Parse()

viper.BindPFlags(pflag.CommandLine)

i := viper.GetInt("flagname") // 通过viper从pflag中获取值

使用pflag并不影响其他库使用标准库中的flag。通过导入，pflag可以接管通过标准库的flag定义的参数。这是通`过调用pflag包中的AddGoFlagSet()方法实现的。例子：1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20package main

import (

"flag"

"github.com/spf13/pflag"

)

func main() {

// using standard library "flag" package

flag.Int("flagname", 1234, "help message for flagname")

pflag.CommandLine.AddGoFlagSet(flag.CommandLine)

pflag.Parse()

viper.BindPFlags(pflag.CommandLine)

i := viper.GetInt("flagname") // retrieve value from viper

...

}

1.8 获取值

在Viper中，有一些根据值的类型获取值的方法。存在一下方法：Get(key string) : interface{}

GetBool(key string) : bool

GetFloat64(key string) : float64

GetInt(key string) : int

GetString(key string) : string

GetStringMap(key string) : map[string]interface{}

GetStringMapString(key string) : map[string]string

GetStringSlice(key string) : []string

GetTime(key string) : time.Time

GetDuration(key string) : time.Duration

IsSet(key string) : bool

如果Get函数未找到值，则返回对应类型的一个零值。可以通过 IsSet() 方法来检测一个健是否存在。例子:1

2

3

4viper.GetString("logfile") // Setting & Getting 不区分大小写

if viper.GetBool("verbose") {

fmt.Println("verbose enabled")

}

1.9 访问嵌套键

访问方法也接受嵌套的键。例如，如果加载了以下JSON文件：1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16{

"host": {

"address": "localhost",

"port": 5799

},

"datastore": {

"metric": {

"host": "127.0.0.1",

"port": 3099

},

"warehouse": {

"host": "198.0.0.1",

"port": 2112

}

}

}

Viper可以通过.分隔符来访问嵌套的字段：1GetString("datastore.metric.host") // (returns "127.0.0.1")

这遵守前面确立的优先规则; 会搜索路径中所有配置，直到找到为止。

例如，上面的文件，datastore.metric.host和 datastore.metric.port都已经定义(并且可能被覆盖)。如果另外 datastore.metric.protocol的默认值，Viper也会找到它。

但是，如果datastore.metric值被覆盖(通过标志，环境变量，Set方法，…)，则所有datastore.metric的子键将会未定义，它们被优先级更高的配置值所“遮蔽”。

最后，如果存在相匹配的嵌套键，则其值将被返回。例如：1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19{

"datastore.metric.host": "0.0.0.0",

"host": {

"address": "localhost",

"port": 5799

},

"datastore": {

"metric": {

"host": "127.0.0.1",

"port": 3099

},

"warehouse": {

"host": "198.0.0.1",

"port": 2112

}

}

}

GetString("datastore.metric.host") // returns "0.0.0.0"

3. 参考资料