golang中goconfig包使用解析

最新推荐文章于 2024-08-20 15:39:20 发布
最新推荐文章于 2024-08-20 15:39:20 发布
阅读量6.8k 收藏 4
点赞数 2
分类专栏： go配置及开发 golang语言包用法 文章标签： go goconfig

注意事项

本博客隶属于 goconfig - 课时 1：goconfig 使用解析 请注意配套使用。

本博文为 goconfig - Go 语言 INI 解析器的配套博客，旨在通过文字结合代码示例对该库的使用方法和案例进行讲解，便于各位同学更好地使用和深入了解。

库简介

goconfig 是一个由 Go 语言开发的针对 Windows 下常见的 INI 格式的配置文件解析器。该解析器在涵盖了所有 INI 文件操作的基础上，又针对 Go 语言实际开发过程中遇到的一些需求进行了扩展。相对于其它 INI 文件解析器而言，该解析器最大的优势在于对注释的极佳支持；除此之外，支持多个配置文件覆盖加载也是非常特别但好用的功能。

下载安装

您可以通过以下两种方式下载安装 goconfig：

gopm get github.com/Unknwon/goconfig

或

go get github.com/Unknwon/goconfig

API 文档

请移步 Go Walker。

基本使用方法

示例代码

一般来说，INI 格式的文件均以 .ini 为后缀，但您可以使用任意后缀，这并不影响您使用该库进行解析。在本例中，我们使用 conf.ini 作为我们的配置文件。

加载配置文件

要操作某个配置文件，需要先将其加载到内存中，我们需要调用 LoadConfigFile 函数来完成该操作：

cfg, err := goconfig.LoadConfigFile("conf.ini")

配置文件的文件名可以写相对路径或绝对路径，该函数返回值分别为 ConfigFile 和 error 类型。如果加载操作发生错误，则变量 cfg 为 nil；否则 err 为 nil。加载完成之后，我们就可以通过操作变量 cfg 来对配置文件的数据进行操作。要注意的是，加载完成后所有数据均已存入内存，任何对文件的修改操作都不会影响到已经获取到的对象。也就是说，此时对文件的修改是不会影响到 cfg 这个对象里的数据的。

基本读写操作

通过 GetValue 方法可实现最基本的读取操作。在本例中，键 key_default 属于未命名的分区（section），则 goconfig 在解析器将它直接归于名为 DEFAULT 的分区。当我们想要获取它的值的时候，可以进行如下操作：

value, err := cfg.GetValue(goconfig.DEFAULT_SECTION, "key_default")

第一个返回值为 string 类型，即取到的值；第二个返回值为 error 类型，当发生错误时不为 nil。

除了读取之外，还可以进行设置值操作：

isInsert := cfg.SetValue(goconfig.DEFAULT_SECTION, "key_default", "这是新的值")

该方法返回值类型为 bool 类型，表示是否为插入操作。如果值为 true，表明该键之前未存在，现在插入成功；否则表示该键之前已经存在，它的值现在被重写了。

如果您觉得每次都调用 goconfig.DEFAULT_SECTION 来表示 DEFAULT 分区非常繁琐，您也可以直接使用空白字符串来代表 DEFAULT 分区：

value, err = cfg.GetValue("", "key_default")

以上代码也可以达到相同的效果。

除了使用等号作为键值之间的分隔符之外，冒号也是允许的：

key_super2 : 测试值

注释读写操作

虽然大多数情况下程序都只从 INI 文件进行数据的读取操作，但偶尔会需要实现写入到文件的操作。此时，其余所有的解析器都会将注释给过滤掉；当注释是配置文件各项说明的重要依据时，这种做法显然是不可取的。因此，完整地保存文件中的注释，并提供在程序中对注释进行操作的 API 不可谓不是 goconfig 的一大特色。

goconfig 允许您的配置文件以分号 ; 或井号 # 为开头在单独的一行作为注释：

; 以分号开头的均为注释行
# 以井号开头的也为注释行

但不可以在某一行的中间：

key_default = 默认节的一个键 # 注释必须单独占行，此处的注释无效

通过 goconfig 提供的 API，您可以操作某个分区或键的注释。

获取某个分区的注释：

comment := cfg.GetSectionComments("super")

获取某个键的注释：

comment = cfg.GetKeyComments("super", "key_super")

这两个方法均返回 string 类型的返回值。

设置某个键的注释：

v := cfg.SetKeyComments("super", "key_super", "# 这是新的键注释")

设置某个分区的注释：

v = cfg.SetSectionComments("super", "# 这是新的分区注释")

上面两个方法的返回值都是 bool 类型。若为 true 表示注释被插入或删除（当传入的参数为空字符串时）；为 false 表示注释已存在，现在被重写。

类型转换读取

goconfig 提供以类型命名的一些方法，例如 Int、Int64 和 Bool 等等，这些方法会返回非 string 类型的值以及一个 error 类型的返回值表示是否发生错误：

vInt, err := cfg.Int("must", "int")

第一个返回值为 int 类型，第二个返回值为 error 类型。

Must 系列方法

Must 系列方法是用于避免检查 error 类型所造成的代码臃肿，简化数据获取流程。这些方法均已 Must 字符开头，如 MustInt、MustInt64 和 MustBool 等等。这些方法一定会返回指定类型的值，若发生错误，则返回零值，不会发生错误：

vBool := cfg.MustBool("must", "bool")

该方法返回值为 bool 类型。

删除指定键值

当您想要抛弃某个键时，可以通过 DeleteKey 方法来删除某个键：

ok := cfg.DeleteKey("must", "string")

该方法返回值为 bool 类型，用于表示删除操作是否成功（若键不存在则会表示为不成功）。

保存配置文件

当完成操作需要将数据写回硬盘时，可以使用 SaveConfigFile 函数来将 ConfigFile 对象以字符串的形式保存到文件系统中：

err = goconfig.SaveConfigFile(cfg, "conf_save.ini")

您需要指定要保存的对象和文件名，该方法返回一个 error 类型的值。

高级使用技巧

示例代码

上一小结展示了如果使用 goconfig 完成常见的 INI 文件操作，本小节则将着重介绍 goconfig 库为大家带来的一些扩展功能。

多文件覆盖加载

函数 LoadConfigFile 其实可以接受多个 string 类型的参数来表示要加载的多个配置文件名，并根据次序进行覆盖式地加载：

cfg, err := goconfig.LoadConfigFile("conf.ini", "conf2.ini")

在本例中，如果 conf.ini 和 conf2.ini 中同时出现相同分区和键名时，则只会获取到 conf2.ini 文件中的值。

如果在程序运行途中发现需要增加配置文件，则可通过方法 AppendFiles 实现追加操作：

err = cfg.AppendFiles("conf3.ini")

配置文件重载

若外部文件发生修改，可通过调用方法进行快速重载：

err = cfg.Reload()

该方法返回一个 error 类型的值表示操作是否成功。

为 Must 系列方法设置缺省值

借助 Go 语言变参的功能，当 Must 系列方法拥有三个参数时，则第三个参数即为获取失败时的默认值：

vBool := cfg.MustBool("must", "bool404", true)

本例中键名为 bool404 根本不存在，则会采用 true 作为返回值。

递归读取键值

在文件 conf3.ini 中，默认分区有两个键如下：

google=www.google.com
search=http://%(google)s

当您使用 %(<key>)s 包含某个键名来作为值的时候，goconfig 会去寻找相应的键的值进行替换；如果被替换的键的值还有这样的嵌套，则会递归执行替换。该操作最多允许 200 层的嵌套。此时，键 search 真正的值为 http://www.google.com。要注意的是，被包含的键可以是位于 DEFAULT 分区或同一分区的，出现顺序任意。

子孙分区覆盖读取

在文件 conf3.ini 中，有如下配置：

[parent]
name=john
relation=father
sex=male
age=32

[parent.child]
age=3

当我们获取 parent.child 分区中的键 age 时，我们会得到 3；但当我们想要获取 sex 时，正常情况下应该为获取失败，不过，goconfig 会发现 parent.child 还有父分区 parent，因为 parent.child 使用了半角符号 . 来实现分级。这时候，获取 sex 会得到 male。

自增键名获取

在文件 conf3.ini 中，有如下配置：

[auto increment]
-=hello
-=go
-=config

由于使用 - 作为键名，则 goconfig 在解析时，会将它翻译成自增数字，从 1 开始。在本例中，上面的键在对象中会被保存为：

#1: hello
#2: go
#3: config

要注意的是，计数只在同个分区内有效，新的分区又会从 1 开始重新计数。

获取整个分区

如果您想要直接操作某个分区，可通过方法 GetSection 来返回一个类型为 map[string]string 的值，其包含了相应分区的所有键值对：

sec, err := cfg.GetSection("auto increment")

总结

goconfig 包的 API 提供非常全面，用法非常简单，但核心代码并不多，各位同学有兴趣的可以阅读其源代码。

使用案例


注：本文转自无闻大神的博客，原文链接：http://studygolang.com/wr?u=http%3a%2f%2fwuwen.org%2farticle%2f17%2f01-goconfig-class1.html

msn217
关注
专栏目录
golang 操作ini、conf、yaml方法总结
energysober的博客
10-20 4520
golang 操作ini、yaml、toml 在使用开发过程中，会经常需要对配置文件做操作，目前主流的配置文件有 .ini、.yaml(yml)、.toml格式，本文收集一些用得较多的包做一个总汇记录。 一、操作ini文件 方法一 使用https://github.com/go-ini/ini 包来操作ini文件 安装 go get gopkg.in/ini.v1 接口简单介绍 //加载文件...
Golang库集合
秋天的博客
10-23 1438
Golang库集合   golang用于创建和发送电子邮件的库 douceur - HTML 邮件中的内联 CSS email - 一个健壮的、灵活的 email 库 Go-dkim - DKIM 库，用于对 email 进行签名和验证 Go-imap - IMAP 库，用于客户端和服务器 Go-message - 用于触雷互联网消息格式和邮件的库 Gomail - Gomail 是一个非常...
goconfig:golang配置
06-04
配置文件 这个包实现了一个基本的配置文件解析器语言，它提供了一个类似于你在 Microsoft Windows INI 文件中找到的结构。 配置文件由部分组成，以“ [section] ”标题开头，后跟“ name: value ”条目； “ name=value ”也被接受。 请注意，从值中删除了前导空格。 可选值可以包含引用同一部分中其他值的格式字符串，或特殊DEFAULT部分中的值。 可以在初始化和检索时提供其他默认值。 注释用“;”表示或者 ”＃”; 注释可以在一行的任何位置开始，包括在参数或节声明之后的同一行。 例如： [My Section] foodir: %(dir)s/whatever dir=foo 就解决了“％（DIR）的”为“目录”（在这种情况下，FOO）的值。 所有参考扩展都是按需完成的。 功能和工作流程松散地基于 Python 标准库的configpa
golang goconfig包 使用解析
weixin_33860553的博客
02-06 308
博客原文出处：http://wuwen.org/article/17/01-goconfig-class1.html注意事项本博客隶属于 goconfig - 课时 1：goconfig 使用解析 请注意配套使用。本博文为 goconfig - Go 语言 INI 解析器的配套博客，旨在通过文字结合代码示例对该库的使用方法和案例进行讲解，便于各位同学更好地使用和深入了解。库简...
golang读取yaml配置文件
最新发布
weixin_49132888的博客
08-20 347
Viper是适用于Go应用程序的完整配置解决方案。它被设计用于在应用程序中工作，并且可以处理所有类型的配置需求和格式。
golang开发:类库篇(四)配置文件解析器goconfig的使用
飞翔码农的博客
07-20 735
为什么要使用goconfig解析配置文件 目前各语言框架对配置文件书写基本都差不多，基本都是首先配置一些基础变量，基本变量里面有环境的配置，然后通过环境变量去获取该环境下的变量。例如，生产环境跟测试环境使用同一份配置，但是相应的环境下的变量的值是不一样的，通过环境获其取对应的的key value。没明白没关系，举例子的时候就明白了。 PHP的框架yaf。golang的框架beego。对配置的书写和...
GoLang 使用goconfig读取配置文件（.ini、.json、.yaml）
✍Snoring cat
10-21 1949
一、goconfig读取.ini类型配置文件 1、配置文件（config.ini）如下： [RabbitMQ] MQUrl = amqp://trkj:trkj@192.168.5.62:5672/test Exchange = EX.WALLDATA ExchangeType = fanout RoutingKey = RK.WALLDATA [Base] messageFrequency = 5 2、解析配置文件： package main import (
配置文件存int类型_golang开发:类库篇(四)配置文件解析器goconfig的使用
weixin_39737224的博客
12-06 142
### 为什么要使用goconfig解析配置文件目前各语言框架对配置文件书写基本都差不多，基本都是首先配置一些基础变量，基本变量里面有环境的配置，然后通过环境变量去获取该环境下的变量。例如，生产环境跟测试环境使用同一份配置，但是相应的环境下的变量的值是不一样的，通过环境获其取对应的的key value。没明白没关系，举例子的时候就明白了。PHP的框架yaf。golang的框架beego。对配置的书...
Go-Go的配置文件解析扩展包GoConfig
08-13
`GoConfig`同样支持TOML，允许开发者使用其简洁的语法来定义配置，并在Go程序中进行解析。 对于不推荐使用的INI文件，这种格式通常用于较简单的配置，由节（sections）、键（keys）和值（values）组成。尽管`...
Go实战全家桶之一：goconfig 实现springboot配置功能
leijmdas的专栏
04-03 404
* 环境根文件： /config/app-env.yml。** 环境文件： /config/app-dev.yml。** 配置文件根目录：自动匹配 /config找到根目录。** 扩展配置项解析 ReadIchubStruct。加密 enc.exe enc xxxx。解密 enc.exe dec xxxx。配置环境变量：BasePath。** 支持不同配置文件。** 常用固定配置项。
golang goconfig包 使用解析
weixin_34390996的博客
11-16 205
注意事项 本博客隶属于goconfig - 课时 1：goconfig 使用解析请注意配套使用。 本博文为goconfig- Go 语言 INI 解析器的配套博客，旨在通过文字结合代码示例对该库的使用方法和案例进行讲解，便于各位同学更好地使用和深入了解。 库简介 goconfig 是一个由 Go 语言开发的针对 Windows 下常见的 INI...
Go-go-config-基于golang的配置文件同步工具
08-13
客户端，服务端采用websocket链接，避免poll 支持使用git作为配置版本管理 支持git branch，tag, commitId作为获取配置条件 支持仓库路由 支持动态仓库配置，参见"仓库模型"
go-config:一个简单的go配置库
05-26
去配置 轻松，有状态的go配置。 一个简单的go配置库，支持标志，环境变量，toml，yaml和JSON配置格式。 go-config还支持同时使用多个配置格式选项。 例如，您可以提供标志和环境变量。 因为创建配置文件很繁琐，所以go-config可以为您生成配置文件。 这有助于消除配置文件中的人为错误，并使配置文件更易于维护，因为您只需要在单个位置进行更改即可。 入门 获取库： > go get -u github.com/pcelvng/go-config 一般使用： // myapp.go package main import ( "fmt" "os" "time" "github.com/pcelvng/go-config" ) func main () { appCfg := options { RunDuration : time . Secon
Go获取解析本地Config配置文件
有问题 ! 请留言 !
05-06 3892
Go获取解析本地Config配置文件 学习了Go语言后,打算利用最近比较空一点,写一个前端部署工具,不需要每次都复制粘贴的麻烦,我们希望再工具打包后,还可以在外面配置参数,所以我们在本地放一个config.txt文件用于配置 直接看代码(注释清晰) //创建了一个结构体,里面分别是本地服务器/测试服/正式服的一些部署需要的信息 //这里字段必须是大写开头,因为接下来需要用反射给属性赋值,大写才...
golang读取conf文件的两种方式（ini和Viper）
qq_51898139的博客
08-23 4052
Go中配置文件管理中间件的使用
Go开发之Beego+Conf文件配置解析
lkr_lkr的博客
01-20 583
Beego Git 地址 下载安装 进入工作空间目录，运行如下两条命令： go get -u github.com/astaxie/beego go get -u github.com/beego/bee
golang config(yaml)
灰猫
10-13 829
package main import ( "fmt" "io/ioutil" "log" "gopkg.in/yaml.v2" ) type conf struct { Enabled bool `yaml:"enabled"` Port int32 `yaml:"port"` ServerName string `yaml:"server_name"` Timeout int64 `yaml:"timeout"` } func (c *conf) getC.
golang 开源项目: 配置解析模块--config
翔云
07-21 1202
在golang中，配置文件经常使用json格式。json格式的语法，有些繁琐，尤其是出现嵌套的时候，每一块都需要大括号包裹，看起来很臃肿。 本着简单易用的原则，个人开发了一个配置解析库kitty，已在github开源。 下面介绍配置解析库kitty的语法和使用方法。 基本语法 基本字符定义如下： # 注释 = key=value, 赋值 [] 区域，可以表示一个结构体 [[]] 区域...
go 解析配置文件
yuanmeifang的博客
08-01 449
go 解析配置文件
golang使用embed包解析toml配置文件
11-24
使用Go 1.16版本中新增的embed包可以方便地将配置文件嵌入到Go二进制文件中，避免了在部署时需要将配置文件和二进制文件分开部署的麻烦。下面是一个使用embed包解析toml配置文件的例子： ```go package main import ( "embed" "fmt" "github.com/BurntSushi/toml" ) // 定义一个结构体来存储配置文件中的数据 type Config struct { Title string DB struct { Server string Port int Timeout int } } //go:embed config.toml var configData embed.FS func main() { // 读取嵌入在二进制文件中的配置文件 data, err := configData.ReadFile("config.toml") if err != nil { panic(err) } // 解析配置文件 var config Config if _, err := toml.Decode(string(data), &config); err != nil { panic(err) } // 输出配置文件中的数据 fmt.Printf("Title: %s\n", config.Title) fmt.Printf("DB Server: %s\n", config.DB.Server) fmt.Printf("DB Port: %d\n", config.DB.Port) fmt.Printf("DB Timeout: %d\n", config.DB.Timeout) } ``` 在上面的例子中，我们使用了Go 1.16版本中新增的embed包将配置文件嵌入到了二进制文件中。然后使用embed包提供的ReadFile函数读取配置文件的内容，并使用BurntSushi/toml包解析配置文件。最后输出配置文件中的数据。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值