如何在Go中处理配置

我是Go编程的新手，我想知道：处理Go程序的配置参数的首选方法是什么（在其他情况下，这种东西可能会使用属性文件或ini文件）？

该JSON格式为我工作得很好。标准库提供了编写缩进数据结构的方法，因此可读性很强。

另请参阅此golang-nuts线程。

JSON的好处在于，它提供了列表和映射的语义（可以变得非常方便），因此解析起来非常容易并且易于人类阅读/编辑（这对于很多ini类型的配置解析器而言并非如此）。

用法示例：

conf.json：

{
    "Users": ["UserA","UserB"],
    "Groups": ["GroupA"]
}

程序读取配置

import (
    "encoding/json"
    "os"
    "fmt"
)

type Configuration struct {
    Users    []string
    Groups   []string
}

file, _ := os.Open("conf.json")
defer file.Close()
decoder := json.NewDecoder(file)
configuration := Configuration{}
err := decoder.Decode(&configuration)
if err != nil {
  fmt.Println("error:", err)
}
fmt.Println(configuration.Users) // output: [UserA, UserB]

另一种选择是使用TOML，它是Tom Preston-Werner创建的一种类似INI的格式。我专为一搏解析器被广泛的测试。您可以像在此建议的其他选项一样使用它。例如，如果您有此TOML数据something.toml

Age = 198
Cats = [ "Cauchy", "Plato" ]
Pi = 3.14
Perfection = [ 6, 28, 496, 8128 ]
DOB = 1987-07-05T05:45:00Z

然后，您可以使用类似以下内容将其加载到Go程序中：

type Config struct {
    Age int
    Cats []string
    Pi float64
    Perfection []int
    DOB time.Time
}

var conf Config
if _, err := toml.DecodeFile("something.toml", &conf); err != nil {
    // handle error
}

Viper是可与JSON，YAML和TOML一起使用的golang配置管理系统。看起来很有趣。

我通常将JSON用于更复杂的数据结构。不利的一面是，您很容易以一堆代码来告诉用户错误出在哪里，各种极端情况以及什么都不是。

对于基本配置（api键，端口号等），我对gcfg软件包非常满意。它基于git config格式。

从文档中：

样本配置：

; Comment line
[section]
name = value # Another comment
flag # implicit value for bool is true

转到struct：

type Config struct {
    Section struct {
            Name string
            Flag bool
    }
}

和读取它所需的代码：

var cfg Config
err := gcfg.ReadFileInto(&cfg, "myconfig.gcfg")

它还支持切片值，因此您可以允许多次指定键以及类似的其他好功能。

只需将标准go标志与iniflags 一起使用即可。

标准go标志具有以下优点：

• 惯用的。
• 易于使用。可以轻松添加标志并将其分散在项目使用的任意包中。
• 标志具有默认值和说明的现成支持。
• 标志提供带有默认值和描述的标准“帮助”输出。

标准go标志的唯一缺点是-当应用中使用的标志数量太大时，就会出现管理问题。

Iniflags很好地解决了这个问题：只需在主程序包中修改两行，即可神奇地获得从ini文件读取标志值的支持。可以通过在命令行中传递新值来覆盖ini文件中的标志。

有关详细信息，另请参见https://groups.google.com/forum/#!topic/golang-nuts/TByzyPgoAQE。

我已经开始使用使用类似 Ini的文件的Gcfg。很简单-如果您想要简单的东西，这是一个不错的选择。

这是我当前正在使用的加载代码，它具有默认设置，并允许覆盖某些配置的命令行标志（未显示）：

package util

import (
    "code.google.com/p/gcfg"
)

type Config struct {
    Port int
    Verbose bool
    AccessLog string
    ErrorLog string
    DbDriver string
    DbConnection string
    DbTblPrefix string
}

type configFile struct {
    Server Config
}

const defaultConfig = `
    [server]
    port = 8000
    verbose = false
    accessLog = -
    errorLog  = -
    dbDriver     = mysql
    dbConnection = testuser:TestPasswd9@/test
    dbTblPrefix  =
`

func LoadConfiguration(cfgFile string, port int, verbose bool) Config {
    var err error
    var cfg configFile

    if cfgFile != "" {
        err = gcfg.ReadFileInto(&cfg, cfgFile)
    } else {
        err = gcfg.ReadStringInto(&cfg, defaultConfig)
    }

    PanicOnError(err)

    if port != 0 {
        cfg.Server.Port = port
    }
    if verbose {
        cfg.Server.Verbose = true
    }

    return cfg.Server
}

看看gonfig

// load
config, _ := gonfig.FromJson(myJsonFile)
// read with defaults
host, _ := config.GetString("service/host", "localhost")
port, _ := config.GetInt("service/port", 80)
test, _ := config.GetBool("service/testing", false)
rate, _ := config.GetFloat("service/rate", 0.0)
// parse section into target structure
config.GetAs("service/template", &template)

https://github.com/spf13/viper和https://github.com/zpatrick/go-config是用于配置文件的相当不错的库。

像本文一样使用toml 以Go方式读取配置文件

我在golang中编写了一个简单的ini配置库。

https://github.com/c4pt0r/cfg

Goroutine安全，易于使用

package cfg
import (
    "testing"
)

func TestCfg(t *testing.T) {
    c := NewCfg("test.ini")
    if err := c.Load() ; err != nil {
        t.Error(err)
    }
    c.WriteInt("hello", 42)
    c.WriteString("hello1", "World")

    v, err := c.ReadInt("hello", 0)
    if err != nil || v != 42 {
        t.Error(err)
    }

    v1, err := c.ReadString("hello1", "")
    if err != nil || v1 != "World" {
        t.Error(err)
    }

    if err := c.Save(); err != nil {
        t.Error(err)
    }
}

==================更新=======================

最近，我需要具有部分支持的INI解析器，并且编写了一个简单的程序包：

github.com/c4pt0r/cfg

您可以像使用“标志”包那样解析INI：

package main

import (
    "log"
    "github.com/c4pt0r/ini"
)

var conf = ini.NewConf("test.ini")

var (
    v1 = conf.String("section1", "field1", "v1")
    v2 = conf.Int("section1", "field2", 0)
)

func main() {
    conf.Parse()

    log.Println(*v1, *v2)
}

您可能也对go-libucl感兴趣，go-libucl是UCL（通用配置语言）的一组Go绑定。UCL有点像JSON，但对人类的支持更好：它支持注释和人类可读的结构，如SI乘法器（10k，40M等），并且样板要少一些（例如，键周围的引号）。如果您已经很熟悉，它实际上与nginx配置文件格式非常接近。

我同意nemo，并写了一个小工具来使一切变得简单。

bitbucket.org/gotamer/cfg是json配置包

• 您可以在应用程序中将配置项定义为结构。
• 您的结构中的json配置文件模板会在第一次运行时保存
• 您可以将运行时修改保存到配置中

有关示例，请参见doc.go

我尝试了JSON。有效。但是我讨厌必须创建可能要设置的确切字段和类型的结构。对我来说，这很痛苦。我注意到这是我可以找到的所有配置选项所使用的方法。也许我的动态语言背景使我对这种冗长的好处视而不见。我制作了一种新的简单配置文件格式，以及一个更具动态性的lib来读取它。

https://github.com/chrisftw/ezconf

我对围棋世界还很陌生，因此可能不是围棋方式。但是它可以工作，非常快捷，而且使用起来超级简单。

优点

• 超级简单
• 更少的代码

缺点

• 没有数组或地图类型
• 非常平面的文件格式
• 非标准配置文件
• 确实有一些内置的约定，如果现在在Go社区中普遍不赞成，那么我现在不赞成这样做。（在config目录中查找配置文件）