1.  
  2. 主页
  3.  / 
  4. Go 每日一库
  5.  / 
  6. Go 每日一库之 go-ini 使用详解

Go 每日一库之 go-ini 使用详解

简介

go-ini是 Go 语言中用于操作 ini 文件的第三方库。

本文介绍go-ini库的使用。

快速使用

go-ini 是第三方库,使用前需要安装:

也可以使用 GitHub 上的仓库:

首先,创建一个my.ini配置文件:

使用 go-ini 库读取:

在 ini 文件中,每个键值对占用一行,中间使用=隔开。以#开头的内容为注释。ini 文件是以分区(section)组织的。

分区以[name]开始,在下一个分区前结束。所有分区前的内容属于默认分区,如my.ini文件中的app_namelog_level

使用go-ini读取配置文件的步骤如下:

  • 首先调用ini.Load加载文件,得到配置对象cfg
  • 然后以分区名调用配置对象的Section方法得到对应的分区对象section,默认分区的名字为"",也可以使用ini.DefaultSection
  • 以键名调用分区对象的Key方法得到对应的配置项key对象;
  • 由于文件中读取出来的都是字符串,key对象需根据类型调用对应的方法返回具体类型的值使用,如上面的StringMustInt方法。

运行以下程序,得到输出:

配置文件中存储的都是字符串,所以类型为字符串的配置项不会出现类型转换失败的,故String()方法只返回一个值。 但如果类型为Int/Uint/Float64这些时,转换可能失败。所以Int()/Uint()/Float64()返回一个值和一个错误。

要留意这种不一致!如果我们将配置中 redis 端口改成非法的数字 x6381,那么运行程序将报错:

Must*便捷方法

如果每次取值都需要进行错误判断,那么代码写起来会非常繁琐。为此,go-ini也提供对应的MustType(Type 为Init/Uint/Float64等)方法,这个方法只返回一个值。 同时它接受可变参数,如果类型无法转换,取参数中第一个值返回,并且该参数设置为这个配置的值,下次调用返回这个值:

配置文件还是 redis 端口为非数字 x6381 时的状态,运行程序:

我们看到第一次调用Int返回错误,以 6381 为参数调用MustInt之后,再次调用Int,成功返回 6381。MustInt源码也比较简单:

分区操作

获取信息

在加载配置之后,可以通过Sections方法获取所有分区,SectionStrings()方法获取所有分区名。

运行输出 3 个分区:

调用Section(name)获取名为name的分区,如果该分区不存在,则自动创建一个分区返回:

创建之后调用SectionStrings方法,新分区也会返回:

也可以手动创建一个新分区,如果分区已存在,则返回错误:

父子分区

在配置文件中,可以使用占位符%(name)s表示用之前已定义的键name的值来替换,这里的s表示值为字符串类型:

上面在默认分区中设置IMPORT_PATH的值时,使用了前面定义的NAMEVERSION。 在package分区中设置CLONE_URL的值时,使用了默认分区中定义的IMPORT_PATH

我们还可以在分区名中使用.表示两个或多个分区之间的父子关系,例如package.sub的父分区为packagepackage的父分区为默认分区。 如果某个键在子分区中不存在,则会在它的父分区中再次查找,直到没有父分区为止:

运行程序输出:

子分区中package.sub中没有键CLONE_URL,返回了父分区package中的值。

保存配置

有时候,我们需要将生成的配置写到文件中。例如在写工具的时候。保存有两种类型的接口,一种直接保存到文件,另一种写入到io.Writer中:

下面我们通过程序生成前面使用的配置文件my.ini并保存:

运行程序,生成两个文件my.inimy-pretty.ini,同时控制台输出文件内容。

my.ini

my-pretty.ini

*Indent方法会对子分区下的键增加缩进,看起来美观一点。

分区与结构体字段映射

定义结构变量,加载完配置文件后,调用MapTo将配置项赋值到结构变量的对应字段中。

MapTo内部使用了反射,所以结构体字段必须都是导出的。如果键名与字段名不相同,那么需要在结构标签中指定对应的键名。 这一点与 Go 标准库encoding/jsonencoding/xml不同。标准库json/xml解析时可以将键名app_name对应到字段名AppName。 或许这是go-ini库可以优化的点?

先加载,再映射有点繁琐,直接使用ini.MapTo将两步合并:

也可以只映射一个分区:

还可以通过结构体生成配置:

总结

本文介绍了go-ini库的基本用法和一些有趣的特性。示例代码已上传GitHub。 其实go-ini还有很多高级特性。官方文档非常详细,推荐去看,而且有中文哟~ 作者无闻,相信做 Go 开发的都不陌生。

参考

  1. go-ini GitHub 仓库
  2. go-ini 官方文档
这篇文章对您有用吗?

我们要如何帮助您?

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注