配置文件

默认配置文件

默认读取的配置文件为config.toml，toml类型文件也是默认的、推荐的配置文件格式（语法参考 配置管理-TOML格式 章节），如果想要自定义文件格式，可以通过SetFileName方法修改默认读取的配置文件名称（如：default.yaml, default.json, default.xml, default.ini等等）。

例如，我们可以通过以下方式读取default.yaml配置文件中的数据库database配置项。

// 设置默认配置文件，默认读取的配置文件设置为 default.yaml
g.Cfg().SetFileName("default.yaml")

// 后续读取时将会读取到 default.yaml 配置文件内容，
g.Cfg().Get("database")

我们有两种方式进行配置文件的管理，使用全局的g.Cfg()获取单例对象（推荐），或者单独使用gcfg模块进行管理。

示例配置文件 config.toml：

# 模板引擎目录
viewpath = "/home/www/templates/"
# MySQL数据库配置
[database]
    [[database.default]]
        host     = "127.0.0.1"
        port     = "3306"
        user     = "root"
        pass     = "123456"
        name     = "test1"
        type     = "mysql"
        role     = "master"
        charset  = "utf8"
        priority = "1"
    [[database.default]]
        host     = "127.0.0.1"
        port     = "3306"
        user     = "root"
        pass     = "123456"
        name     = "test2"
        type     = "mysql"
        role     = "master"
        charset  = "utf8"
        priority = "1"
# Redis数据库配置
[redis]
    disk  = "127.0.0.1:6379,0"
    cache = "127.0.0.1:6379,1"

默认文件修改

我们可以通过多种方式修改默认文件名称：

1. 通过配置管理方法SetFileName修改。
2. 修改命令行启动参数 - gf.gcfg.file。
3. 修改指定的环境变量 - GF_GCFG_FILE。

假如我们的执行程序文件为main，那么可以通过以下方式修改配置管理器的配置文件目录(Linux下)：

1. 通过单例模式
   

    g.Cfg().SetFileName("config.prod.toml")

2. 通过命令行启动参数
   

    ./main --gf.gcfg.file=config.prod.toml

3. 通过环境变量（常用在容器中）
   • 启动时修改环境变量：
     

       GF_GCFG_FILE=config.prod.toml; ./main

   • 使用genv模块来修改环境变量：
     

       genv.Set("GF_GCFG_FILE", "config.prod.toml")

配置目录

目录配置方法

gcfg配置管理器支持非常灵活的多目录自动搜索功能，通过SetPath可以修改目录管理目录为唯一的目录地址，同时，我们推荐通过AddPath方法添加多个搜索目录，配置管理器底层将会按照添加目录的顺序作为优先级进行自动检索。直到检索到一个匹配的文件路径为止，如果在所有搜索目录下查找不到配置文件，那么会返回失败。

默认目录配置

gcfg配置管理对象初始化时，默认会自动添加以下配置文件搜索目录：

1. 当前工作目录及其下的config目录：例如当前的工作目录为/home/www时，将会添加/home/www及/home/www/config；
2. 当前可执行文件所在目录及其下的config目录：例如二进制文件所在目录为/tmp时，将会添加/tmp及/tmp/config；
3. 当前main源代码包所在目录及其下的config目录(仅对源码开发环境有效)：例如main包所在目录为/home/john/workspace/gf-app时，将会添加/home/john/workspace/gf-app及/home/john/workspace/gf-app/config；

默认目录修改

我们可以通过以下方式修改配置管理器的配置文件搜索目录，配置管理对象将会只在该指定目录执行配置文件检索：

1. 通过配置管理器的SetPath方法手动修改；
2. 修改命令行启动参数 - gf.gcfg.path；
3. 修改指定的环境变量 - GF_GCFG_PATH；

假如我们的执行程序文件为main，那么可以通过以下方式修改配置管理器的配置文件目录(Linux下)：

1. 通过单例模式
   

    g.Cfg().SetPath("/opt/config")

2. 通过命令行启动参数
   

    ./main --gf.gcfg.path=/opt/config/

3. 通过环境变量（常用在容器中）
   • 启动时修改环境变量：
     

       GF_GCFG_PATH=/opt/config/; ./main

   • 使用genv模块来修改环境变量：
     

       genv.Set("GF_GCFG_PATH", "/opt/config")

配置修改

我们可以通过Set方法动态修改配置对象中的配置数据，Set方法定义如下：

func (c *Config) Set(pattern string, value interface{}) error

使用方式同 万能编解码-gjson 模块。

注意事项

大家都知道，在Golang里面，map/slice类型其实是一个”引用类型”（也叫”指针类型”），因此当你对这种类型的变量 键值对/索引项 进行修改时，会同时修改到其对应的底层数据。

从效率上考虑，gcfg包某些获取方法返回的数据类型为map/slice时，没有对其做值拷贝，因此当你对返回的数据进行修改时，会同时修改gcfg对应的底层数据。

例如：

// For testing/example only.
content := `{"map":{"key":"value"}, "slice":[59,90]}`
gcfg.SetContent(content)
defer gcfg.RemoveContent()

m := g.Cfg().GetMap("map")
fmt.Println(m)

// Change the key-value pair.
m["key"] = "john"

// It changes the underlying key-value pair.
fmt.Println(g.Cfg().GetMap("map"))

s := g.Cfg().GetArray("slice")
fmt.Println(s)

// Change the value of specified index.
s[0] = 100

// It changes the underlying slice.
fmt.Println(g.Cfg().GetArray("slice"))

// output:
// map[key:value]
// map[key:john]
// [59 90]
// [100 90]

检测更新

配置管理器使用了缓存机制，当配置文件第一次被读取后会被缓存到内存中，下一次读取时将会直接从缓存中获取，以提高性能。同时，配置管理器提供了对配置文件的自动检测更新机制，当配置文件在外部被修改后，配置管理器能够即时地刷新配置文件的缓存内容。

gcfg包也支持直接内容配置，而不是读取配置文件，常用于程序内部动态修改配置内容。通过以下包配置方法实现全局的配置：

func SetContent(content string, file ...string)
func GetContent(file ...string) string
func RemoveContent(file ...string)
func ClearContent()

需要注意的是该配置是全局生效的，并且优先级会高于读取配置文件。因此，假如我们通过gcfg.SetContent("v = 1", "config.toml")配置了config.toml的配置内容，并且也同时存在config.toml配置文件，那么只会使用到SetContent的配置内容，而配置文件内容将会被忽略。