如何在Go中处理配置

时间:2013-05-09 15:41:13

标签: go configuration-files

我是Go编程的新手,我想知道:处理Go程序的配置参数的首选方法是什么(可以使用属性文件或 ini 文件,在其他情况下)?

13 个答案:

答案 0 :(得分:231)

JSON格式对我很有用。该 标准库提供了写入数据结构缩进的方法,所以它是相当的 可读的。

另见this golang-nuts thread

JSON的好处是解析和人类可读/可编辑相当简单 同时为列表和映射提供语义(可以变得非常方便) 很多ini-type配置解析器都不是这种情况。

使用示例:

<强> 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]

答案 1 :(得分:87)

另一种选择是使用TOML,这是由Tom Preston-Werner创建的类似INI的格式。我是built a Go parser for it extensively tested。您可以像在此处提出的其他选项一样使用它。例如,如果您在something.toml

中有此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
}

答案 2 :(得分:45)

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

答案 3 :(得分:44)

我通常使用JSON来处理更复杂的数据结构。缺点是你很容易得到一堆代码来告诉用户错误的位置,各种边缘情况以及不存在的情况。

对于基本配置(api键,端口号,......)我对gcfg包非常好运。它基于git配置格式。

来自文档:

示例配置:

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

Go struct:

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

需要阅读代码:

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

它还支持切片值,因此您可以允许多次指定一个键以及其他很好的功能。

答案 4 :(得分:38)

只需将标准go flagsiniflags一起使用。

标准手旗具有以下好处:

  • 习语。
  • 易于使用。标志可以轻松添加并分散到项目使用的任意包中。
  • 标志具有默认值和描述的开箱即用支持。
  • 标志提供标准的帮助&#39;输出默认值和说明。

标准go标志的唯一缺点是 - 当您的应用中使用的标志数量变得过大时,会出现管理问题。

Iniflags优雅地解决了这个问题:只需修改主包中的两行,它就会神奇地获得从ini文件中读取标志值的支持。可以通过在命令行中传递新值来覆盖ini文件中的标志。

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

答案 5 :(得分:12)

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

这是我目前正在使用的加载代码,它具有默认设置并允许覆盖我的部分配置的命令行标志(未显示):

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
}

答案 6 :(得分:8)

查看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)

答案 7 :(得分:6)

像本文toml

一样使用Reading config files the Go way

答案 8 :(得分:6)

答案 9 :(得分:5)

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

https://github.com/c4pt0r/cfg

goroutine-safe,易于使用

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)
    }
}

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

最近我需要一个支持section的INI解析器,我写了一个简单的包:

github.com/c4pt0r/cfg

你可以解析INI就像使用&#34; flag&#34;包:

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)
}

答案 10 :(得分:4)

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

答案 11 :(得分:2)

我同意nemo并且我写了一个小工具来使它变得非常容易。

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

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

请参阅doc.go以获取示例

答案 12 :(得分:1)

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

https://github.com/chrisftw/ezconf

我对Go世界很陌生,所以它可能不是Go方式。但是它很有效,而且非常简单易用。

赞成

  • 超级简单
  • 少代码

缺点

  • 无阵列或地图类型
  • 非常扁平的文件格式
  • 非标准配置文件
  • 内置了一些小会议,我现在在Go社区一般不赞成。 (在config目录中查找配置文件)