在go中使用json作为主要的配置格式

原创 2014年04月13日 11:54:43

最近在用go重构,在先前的代码中,我们使用的ini文件进行配置,但是因为很多历史遗留问题,导致配置混乱,维护困难,自然也需要考虑重构了。

通用配置格式

通用的配置格式有很多,常用的就有ini,json,yaml,xml等,当然为了通用我们不考虑自定义的配置格式。那如何选择呢?

首先,xml我们就不用考虑了,到现在为止我都没觉得用这玩意配置起来有多方便,反而很臃肿,可能java系的童鞋会比较青睐。

再来考虑ini,ini文件对于简单应用的配置可以说是非常方便的,如果配置没有太多的层次结构,使用ini就能完全满足我们的需要,即使有,我们也能够通过加入特定前缀来解决。譬如,我们可能有如下redis配置:

[ModuleA]

persistent_redis_addr = 127.0.0.1:6379
persistent_redis_password = admin

cache_redis_addr = 127.0.0.1:6380
cache_redis_password = admin

然后,需求变化了,我们需要另一个持久化redis服务来做相关事情,于是配置就可能变成了下面这样:

[ModuleA]

persistent_redis_addr = 127.0.0.1:6379
persistent_redis_password = admin

persistent2_redis_addr = 127.0.0.1:6379
persistent2_redis_password = admin

cache_redis_addr = 127.0.0.1:6380
cache_redis_password = admin

虽然通过前缀命名能解决层级问题,但总觉得是对程序员不怎么友好的。

why json

剩下的就是json和yaml,可以这么说,这两个都算是比较好的轻量级配置格式,而且对程序员非常友好,而且go里面都可以通过定义struct,将层级结构的配置映射到相应的struct里面。

但是我还是决定选择json作为我们go代码的默认配置格式,最主要的原因在于go的json包有一个杀手级别的RawMessage实现。而这个在我能找到的yaml包中没有。

RawMessage主要是用来告诉go延迟解析用的。当我们定义了某一个字段为RawMessage之后,go就不会解析这段json,这样我们就可以将其推后到各自的子模块单独解析。

假设有一个功能,后台存储可能是redis或者mysql,但是只会使用一个,可能我们会按照如下方式写配置:

redis_store : {
    addr : 127.0.0.1
    db : 0
},

mysql_store : {
    addr : 127.0.0.1
    db : test
    password : admin
    user : root
}

store : redis

对应的class为

type Config struct {
    RedisStore struct {
        Addr string
        DB int
    }

    MysqlStore Struct {
        Addr string
        DB string
        Password string
        User string
    }

    Store string
}

如果这时候我们在增加了一种新的store,我们需要在Config文件里面在增加一个新的field,但是实际我们只会使用一种store,并不需要写这么多的配置。

我们可以使用RawMessage来处理:

type Config struct {
    Store string
    StoreConfig json.RawMessage
}

如果使用redis,对应的配置文件为

store: redis
store_config: {
    addr : 127.0.0.1
    db : 0
}

如果使用mysql,对应的配置文件为

store: mysql
store_config: {
    addr : 127.0.0.1
    db : test
    password : admin
    user : root
}

go读取配置文件之后,并不会处理RawMessage对应的东西,而是由我们代码自己对应的store模块去处理。这样无论配置文件怎么变动,store模块做了什么变动,都不会影响Config类。

而在各个模块中,我们只需要自己定义相关config,然后可以将RawMessage直接解析映射到该config上面,譬如,对于redis,我们在模块中有如下定义

type RedisConfig config {
    Addr string `json:"addr"`
    DB int `json:"db"`
}

func NewConfig(m json.RawMessage) *RedisConfig {
    c := new(RedisConfig)

    json.Unmarshal(m, c)

    return c
}

json的不足

使用json也还有很多蛋疼的地方,最大的问题就在于注释,在json中,可不能这样写:

{
    //this is a comment
    /*this is a comment*/ 
}

但是,我们又不可能不写一点注释来说明配置项是干啥的,所以,通常采用的是引入一个comment字段的方式,譬如:

{
    "_comment" : "this is a comment",
    "key" : "value"
}

另外,json还需要注意的就是写的时候最后一项不能加上逗号,这样的json会因为格式错误无法解析的。

{
    "key" : "value",
}

最后那个逗号可是不能要的,但是实际写配置的时候我们可是经常性的随手加上了。

但是,总的来说,json对于go的项目还是很友好的,我不光在项目中推行了,在自己的开源项目中,也大量的采用了json作为主要的配置文件。

Go实战--go语言中使用YAML配置文件(与json、xml、ini对比)

生命不止,继续 go go go !!!golang中如何使用json在前面介绍过了: 《Go语言学习之encoding/json包(The way to go)》golang中如何使用xml在前面...
  • wangshubo1989
  • wangshubo1989
  • 2017-06-27 12:55:43
  • 11577

GO语言: 读取配置文件的方式toml

最近go语言项目中用到读取配置文件,如下:使用这个"github.com/BurntSushi/toml" 配置文件如下:conf.toml# id ID = 1 # name N...
  • lsyyff23
  • lsyyff23
  • 2017-02-14 15:40:56
  • 4037

golang 读取配置文件

unix 风格的配置文件
  • u014798316
  • u014798316
  • 2014-07-14 23:38:58
  • 2563

在Go语言中使用JSON

有这么一个结构体: type Proto struct { Id int `json:""` }
  • tiaotiaoyly
  • tiaotiaoyly
  • 2014-08-30 15:10:40
  • 60468

golang 读取JSON文件(读书笔记)

JSON(JavaScript Object Notation)是一种比XML更轻量级的数据交换格式,在易于人们阅读和编写的同时,也易于程序解析和生成。尽管JSON是JavaScript的一个子集,但...
  • lxy15329
  • lxy15329
  • 2013-04-03 18:24:07
  • 10726

Golang 中使用 JSON 的一些小技巧

Golang 中 JSON使用的一些小技巧
  • impressionw
  • impressionw
  • 2017-07-07 16:02:07
  • 2686

golang中json的使用

golang中使用json,经常会使用到两个函数 func Unmarshal(data []byte, v interface{}) error 1 将json反序列化成struct对象  2将...
  • skh2015java
  • skh2015java
  • 2016-12-30 15:20:23
  • 1954

Go学习笔记:json处理

Encode 将一个对象编码成JSON数据,接受一个interface{}对象,返回[]byte和error: func Marshal(v interface{}) ([]byte,...
  • qdx411324962
  • qdx411324962
  • 2015-09-05 00:04:14
  • 3244

go语言json操作指南

package mainimport ( "encoding/json" "fmt" "os" )type ConfigStruct struct { Host ...
  • guoer9973
  • guoer9973
  • 2016-07-27 17:01:42
  • 823

Go操作JSON

简介 JavaScript Object Notation(JSON)是一个数据交换标准,因其简单、可读性强广泛使用。Go的标准包encoding/json对JSON的编解码提供了完整的支持。 编...
  • u011304970
  • u011304970
  • 2017-04-26 12:56:33
  • 3045
收藏助手
不良信息举报
您举报文章:在go中使用json作为主要的配置格式
举报原因:
原因补充:

(最多只允许输入30个字)