name: config 模块

sort: 7

配置文件解析

这是一个用来解析文件的库，它的设计思路来自于 database/sql，目前支持解析的文件格式有 ini、json、xml、yaml，可以通过如下方式进行安装：

  1. go get github.com/beego/beego/v2/core/config

如果你使用xml 或者 yaml 驱动就需要手工安装引入包

  1. go get -u github.com/beego/beego/v2/core/config/xml

而且需要在使用的地方引入包

  1. import _ "github.com/beego/beego/v2/core/config/xml"

远程配置

目前我们提供了对远程配置中心etcd的支持。使用它就如同使用一般的基于文件的配置那样。

如何使用

直接使用包

为了简化代码，我们在config初始化的时候，默认创建了一个名为globalInstance的实例。

该实例在没有显式初始化的情况下，默认是采用ini作为实现，它将会加载文件conf/app.conf。

在加载失败的时候，会输出一个警告信息。

于是我们可以直接使用config包。

  1. val, err := config.String("mykey")

当然，用户也可以主动初始化。例如，当我们想用toml作为默认实现的时候，我们可以：

  1. _ import "github.com/beego/beego/v2/core/config/toml"
  2. err := InitGlobalInstance("toml", "some config")
  3. // ...
  4. val, err := config.String("mykey")
  5. // ...

永远别忘了引入具体实现的包。

手动创建实例

首先初始化一个解析器对象

  1. iniconf, err := NewConfig("ini", "testini.conf")
  2. if err != nil {
  3.     t.Fatal(err)
  4. }

然后通过对象获取数据

  1. iniconf.String("appname")

解析器对象支持的函数有如下：

  1. // Configer defines how to get and set value from configuration raw data.
  2. type Configer interface {
  3.     // support section::key type in given key when using ini type.
  4.     Set(key, val string) error
  6.     // support section::key type in key string when using ini and json type; Int,Int64,Bool,Float,DIY are same.
  7.     String(key string) (string, error)
  8.     // get string slice
  9.     Strings(key string) ([]string, error)
  10.     Int(key string) (int, error)
  11.     Int64(key string) (int64, error)
  12.     Bool(key string) (bool, error)
  13.     Float(key string) (float64, error)
  14.     // support section::key type in key string when using ini and json type; Int,Int64,Bool,Float,DIY are same.
  15.     DefaultString(key string, defaultVal string) string
  16.     // get string slice
  17.     DefaultStrings(key string, defaultVal []string) []string
  18.     DefaultInt(key string, defaultVal int) int
  19.     DefaultInt64(key string, defaultVal int64) int64
  20.     DefaultBool(key string, defaultVal bool) bool
  21.     DefaultFloat(key string, defaultVal float64) float64
  23.     // DIY return the original value
  24.     DIY(key string) (interface{}, error)
  26.     GetSection(section string) (map[string]string, error)
  28.     Unmarshaler(prefix string, obj interface{}, opt ...DecodeOption) error
  29.     Sub(key string) (Configer, error)
  30.     OnChange(key string, fn func(value string))
  31.     SaveConfigFile(filename string) error
  32. }

这里有一些使用的注意事项：

  1. 所有的Default*方法，在key不存在，或者查找的过程中，出现error，都会返回默认值；
  2. DIY直接返回对应的值，而没有做任何类型的转换。当你使用这个方法的时候，你应该自己确认值的类型。只有在极少数的情况下你才应该考虑使用这个方法；
  3. GetSection会返回section所对应的部分配置。section如何被解释，取决于具体的实现；
  4. Unmarshaler会尝试用当且配置的值来初始化obj。需要注意的是，prefix的概念类似于section；
  5. Sub类似与GetSection，都是尝试返回配置的一部分。所不同的是，GetSection将结果组织成map，而Sub将结果组织成Config实例；
  6. OnChange主要用于监听配置的变化。对于大部分依赖于文件系统的实现来说，都不支持。具体而言，我们设计这个主要是为了考虑支持远程配置；
  7. SaveConfigFile尝试将配置导出成为一个文件；
  8. 某些实现支持分段式的key。比如说a.b.c这种，但是，并不是所有的实现都支持，也不是所有的实现都采用.作为分隔符。这是一个历史遗留问题，为了保留兼容性，我们无法在这方面保持一致。

这里额外提及一下ini文件，因为这是早期v1.x里面默认的配置实现：

ini 配置文件支持 section 操作，key通过 section::key 的方式获取

例如下面这样的配置文件

  1.    [demo]
  2.    key1 = "asta"
  3.    key2 = "xie"

那么可以通过 iniconf.String("demo::key2") 获取值.

如何获取环境变量

config 模块支持环境变量配置，对应配置项 Key 格式为 ${环境变量名} ，则 Value = os.Getenv(‘环境变量名’)。 同时可配置默认值，当环境变量无此配置或者环境变量值为空时，则优先使用默认值。包含默认值的 Key 格式为 ${GOPATH||/home/workspace/go/} ，使用||分割环境变量和默认值。

注意 获取环境变量值仅仅是在配置文件解析时处理，而不会在调用函数获取配置项时实时处理。