教程集 > Golang编程 > golang教程 > 正文 Go中配置文件读取的几种方式

Go中配置文件读取的几种方式

发布时间：2022-01-01 编辑：jiaochengji.com

教程集为您提供Go中配置文件读取的几种方式等资源，欢迎您收藏本站，我们将为您提供最新的Go中配置文件读取的几种方式资源

日常开发中读取配置文件包含以下几种格式：

<ul><li>json 格式字符串</li><li>K=V 键值对</li><li>xml 文件</li><li>yml 格式文件</li><li>toml 格式文件</li></ul>

前面两种书写简单，解析过程也比较简单。xml形式书写比较累赘，yml是树形结构，为简化配置而生，toml是一种有着自己语法规则的配置文件格式，我们一一来看使用方式，各位看官自行比较哪种更加实用。

<h4>1.读取json格式的文件</h4> <pre><code class="lang-go hljs">package main import ( "encoding/json" "fmt" "io/ioutil" "log" "sync" ) type Configs map[string]json.RawMessage var configPath string = "c:/test.json" type MainConfig struct { Port string `json:"port"` Address string `json:"address"` } var conf *MainConfig var confs Configs var instanceOnce sync.Once //从配置文件中载入json字符串 func LoadConfig(path string) (Configs, *MainConfig) { buf, err := ioutil.ReadFile(path) if err != nil { log.Panicln("load config conf failed: ", err) } mainConfig := &MainConfig{} err = json.Unmarshal(buf, mainConfig) if err != nil { log.Panicln("decode config file failed:", string(buf), err) } allConfigs := make(Configs, 0) err = json.Unmarshal(buf, &allConfigs) if err != nil { log.Panicln("decode config file failed:", string(buf), err) } return allConfigs, mainConfig } //初始化可以运行多次 func SetConfig(path string) { allConfigs, mainConfig := LoadConfig(path) configPath = path conf = mainConfig confs = allConfigs } // 初始化，只能运行一次 func Init(path string) *MainConfig { if conf != nil && path != configPath { log.Printf("the config is already initialized, oldPath=%s, path=%s", configPath, path) } instanceOnce.Do(func() { allConfigs, mainConfig := LoadConfig(path) configPath = path conf = mainConfig confs = allConfigs }) return conf } //初始化配置文件为 struct 格式 func Instance() *MainConfig { if conf == nil { Init(configPath) } return conf } //初始化配置文件为 map格式 func AllConfig() Configs { if conf == nil { Init(configPath) } return confs } //获取配置文件路径 func ConfigPath() string { return configPath } //根据key获取对应的值，如果值为struct，则继续反序列化 func (cfg Configs) GetConfig(key string, config interface{}) error { c, ok := cfg[key] if ok { return json.Unmarshal(c, config) } else { return fmt.Errorf("fail to get cfg with key: %s", key) } } func main() { path := ConfigPath() fmt.Println("path: ",path) Init(path) value := confs["port"] fmt.Println(string(value)) } </code></pre>

json格式文件内容：

<pre><code class="lang-json hljs">{ "port": "7788", "address": "47.95.34.2" } </code></pre>

运行结果：

<pre><code>path: c:/test.json "7788" </code></pre> <h4>2. 读取key=value类型的配置文件</h4> <pre><code class="lang-go hljs">package main import ( "bufio" "io" "os" "strings" ) //读取key=value类型的配置文件 func InitConfig(path string) map[string]string { config := make(map[string]string) f, err := os.Open(path) defer f.Close() if err != nil { panic(err) } r := bufio.NewReader(f) for { b, _, err := r.ReadLine() if err != nil { if err == io.EOF { break } panic(err) } s := strings.TrimSpace(string(b)) index := strings.Index(s, "=") if index < 0 { continue } key := strings.TrimSpace(s[:index]) if len(key) == 0 { continue } value := strings.TrimSpace(s[index 1:]) if len(value) == 0 { continue } config[key] = value } return config } func main() { config := InitConfig("c:/1.txt") ip := config["ip"] port := config["port"] fmt.Println("ip=",string(ip)," port=",string(port)) } </code></pre>

配置文件类容：

运行结果：

<pre><code>ip=127.0.0.1 port=3344 </code></pre> <h4>3. 读取yml格式文件</h4>

Java中SpringBoot支持使用yml格式的配置文件作为替代properties文件的一种方式。跟properties文件相比，好处就是层级目录，相同的前缀都在该前缀下，前缀只用写一次即可。Go也支持yml文件解析，只是麻烦的程度真的是，，，不想写！

我们先定义一个yml文件：

<pre><code class="lang-yml hljs">port: 8080 ip: 127.0.0.1 host: www.baidu.com spring: redis: host: redis.dns.baidu.com port: 6379 dataBase: 0 timeout: 2000 </code></pre>

解析代码如下：

<pre><code class="lang-go hljs">package utils import ( "fmt" "gopkg.in/yaml.v2" "io/ioutil" ) //解析yml文件 type BaseInfo struct { Port string `yaml:"port"` Ip string `yaml:"ip"` Host string `yaml:"host"` Spring RedisEntity `yaml:"spring"` } type RedisEntity struct { Redis RedisData `yaml:"redis"` } type RedisData struct { Host string `yaml:"host"` Port string `yaml:"port"` DataBase string `yaml:"dataBase"` Timeout string `yaml:"timeout"` } func (c *BaseInfo) GetConf() *BaseInfo { yamlFile, err := ioutil.ReadFile("c:/1.yml") if err != nil { fmt.Println(err.Error()) } err = yaml.Unmarshal(yamlFile, c) if err != nil { fmt.Println(err.Error()) } return c } </code></pre>

解释一下：以上yml文件中是有三层目录结构，所以需要定义三个struct，每个struct分别包含每一层的字段。这样说你应该就能明白如何解析。

运行一下test方法来验证上面程序：

<pre><code class="lang-go hljs">package main import ( "fmt" "goProject/src/utils" "testing" ) func Test(t *testing.T) { info := utils.BaseInfo{} conf := info.GetConf() fmt.Println(conf.Host) } </code></pre>

可以看到将yml中的树形结构解析为<code>BaseInfo</code>对象。

<h4>4. 读取toml格式文件</h4>

仿佛我感觉这个比读取yml文件更为痛苦，因为在写toml文件的时候，还有一定的语法规则，仿佛在告诉你别停，继续学习。

TOML　的全称是Tom’s Obvious, Minimal Language，因为它的作者是 GitHub联合创始人Tom Preston-Werner 。 TOML 的目标是成为一个极简的配置文件格式。TOML 被设计成可以无歧义地被映射为哈希表的结构，从而可以被多种语言解析。

举个例子：

<pre><code class="lang-toml hljs">port=8080 [user] name="xiaoming" age=14 sex=1 [database] servers=["127.0.0.1","127.0.0.2","127.0.0.3"] connection_max=5000 enabled=true [servers] # 你可以依照你的意愿缩进。使用空格或Tab。TOML不会在意。 [servers.a] ip="34.23.1.4" port=6379 [servers.b] ip="34.23.1.6" port=9921 #嵌套 [nest] data=[["n1","n2"],[1,2]] # 在数组里换行没有关系。 names = [ "li", "wang" ] </code></pre>

下面来解释一下toml格式的书写规范。

首先：TOML 是大小写敏感的。

常见的语法规则：

注释

使用 # 表示注释。

</li><li>

字符串

</li></ol>

字符串以<code>""</code>包裹，里面的字符必须是　UTF-8 格式。引号、反斜杠和控制字符（U 0000 到 U 001F）需要转义。

常用的转义序列：

<pre><code>\b - backspace (U 0008) \t - tab (U 0009) \n - linefeed (U 000A) \f - form feed (U 000C) \r - carriage return (U 000D) \" - quote (U 0022) \/ - slash (U 002F) \\ - backslash (U 005C) \uXXXX - unicode (U XXXX) </code></pre> <ol start="3"><li>

布尔值

true

false

</li><li>

日期

使用ISO8601格式日期：

数组

数组使用方括号包裹。空格会被忽略。元素使用逗号分隔。注意，不允许混用数据类型。

<pre><code>[ 1, 2, 3 ] [ "red", "yellow", "green" ] [ [ 1, 2 ], [3, 4, 5] ] [ [ 1, 2 ], ["a", "b", "c"] ] # 这是可以的。 [ 1, 2.0 ] # 注意：这是不行的。 </code></pre> </li><li>

数值类型

数值类型严格区分整数和浮点数。这两个不是一种类型。

</li><li>

字典对象

多个kv集合在一起组成字典对象。字典对象的名字用<code>[]</code>包含起来，单独作为一行。

解释一下这种格式对应的json格式：

<pre><code>[servers.a] ip="34.23.1.4" port=6379 { "servers": { "a": { "ip": "34.23.1.4","port":6379}}} </code></pre>

我们写一个小程序来解析上面的toml文件：

<pre><code class="lang-go hljs">package utils import ( "fmt" "github.com/BurntSushi/toml" "io/ioutil" "os" ) type BaseData struct { Db DataBase `toml:"dataBase"` Se Servers `toml:"servers"` } type DataBase struct { Servers []string `toml:"servers"` ConnectionMax int `toml:"connection_max"` Enabled bool `toml:"enabled"` } type Servers struct { A ServerEn `toml:"a"` B ServerEn `toml:"b"` } type ServerEn struct { IP string `toml:"ip"` Port int `toml:"port"` } func ReadConf(fname string) (p *BaseData, err error) { var ( fp *os.File fcontent []byte ) p = new(BaseData) if fp, err = os.Open(fname); err != nil { fmt.Println("open error ", err) return } if fcontent, err = ioutil.ReadAll(fp); err != nil { fmt.Println("ReadAll error ", err) return } if err = toml.Unmarshal(fcontent, p); err != nil { fmt.Println("toml.Unmarshal error ", err) return } return } </code></pre>

注意看我定义的对象，也是逐层解析。

测试类：

<pre><code class="lang-go hljs">package main import ( "fmt" "goProject/src/utils" "testing" ) func Test(t *testing.T) { p, _ := utils.ReadConf("c:/1.toml") fmt.Println(p) } </code></pre> </li></ol>

<blockquote class="layui-elem-quote" style="width: 100%;overflow:hidden"> 作者： a953713428
链接： https://blog.csdn.net/a953713428/article/details/90285939
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
</blockquote>

到此这篇关于“Go中配置文件读取的几种方式”的文章就介绍到这了,更多文章或继续浏览下面的相关文章，希望大家以后多多支持JQ教程网！

您可能感兴趣的文章：
golang基础学习-动态获取配置文件(viper）
如何读取yaml,json,ini等配置文件【Golang 入门系列九】
Go之开发小功能集合（viper获取配置信息，test编写测试单元，用户目录获取，JWT安全校验，字符串去重，Swag...
Go语言从入门到精通 -【web项目实战篇】- 读取配置文件
 dubbo-go 的开发、设计与功能介绍
 golang读取配置文件
 golang开源配置管理组件-go-archaius介绍
 Go语言爱好者周刊：第 78 期 — 这道关于 goroutine 的题
 go语言快速读取配置文件并声明环境变量
 golang几种常用配置文件使用方法总结（yaml、toml、json、xml、ini）

上一篇：Golang 常见面试考点汇总及原理解析(2) - map, slice 考点下一篇：Go语言的“ ”和“—”运算符

[关闭]

Go中配置文件读取的几种方式

最近更新

浏览排行