Golang使用ini库读取配置详情

目录

• go-ini的分区
• go-ini的安装
• ini文件的格式
• 读取ini文件的配置项
• 直接加在ini文件，通过方法读取
• 定义结构体来存放配置项，将配置项映射到结构体中
• 父子分区
• 两份关键代码

go-ini的分区

go-ini的多个配置项通过分区(section)来划分。有默认(空)分区和命名的分区，没有给分区命名就是默认分区，默认分区必须写在任何一个命名分区的上边。每个配置项通过换行来区分。

go-ini的安装

go-ini/ini是GitHub上的一个代码库，和其他golang库一样，通过golang命令行下载即可，如果下载速度慢可尝试切换代理:go env -w GOPROXY=https://goproxy.cn

下载命令：

go get github.com/go-ini/ini

ini文件的格式

ini文件以分区来划分多块配置，

默认分区必须写在任何一个命名分区的上边，多个配置项用换行符号分割。

读取ini文件的配置项

直接加在ini文件，通过方法读取

• 使用ini.load(ini文件路径)即可。返回一个配置文件结构体指针和错误信息

cfgs, err := ini.Load("./conf/go-conf.ini")
if err != nil {
    fmt.Println(err)
}
// cfgs是配置文件的结构体指针

读取命名分区数据：

sp := cfgs.Section()选择一个分区，返回分区的结构体指针

Key()是分区结构体的一个方法，读取分区的配置项,返回一个键的结构体指针

val := cfgs.Section("kafka").Key("address").Value()
fmt.Print(val)
​
// 打印 ： 127.0.0.1:9092

• 读取默认分区数据

  默认分区只需要键分区明为空即可：val := cfgs.Section().key().Value()

val := cfgs.Section("").Key("a").Value()
fmt.Print(val)
// 打印：  122

• 关于读取到的键结构体指针。可以键值转为多种类型，包括单不限于go的基本数据类型，有两个返回值

  Value()则直接不做换回直接返回，只有一个返回值

// 直接返回值
val := cfgs.Section("").Key("a").Value()
fmt.Print(val)
// 打印：  122
// 返回一个int类型的key值
val,err := cfgs.Section("").Key("a").Int()
if err != nil {
        fmt.Print(err)
}
fmt.Print(val)
// 打印：  122

定义结构体来存放配置项，将配置项映射到结构体中

定义与ini配置项匹配的结构体，通过ini.MapTo()将配置映射到结构体中。

结构体中成员属性必须加上tag，ini库通过tap映射对应的配置项，

type KafkaConfig struct {
    // ini用于给ini库做标识
    Address string `ini:"address"`
}
type TailConfig struct {
    Path     string `ini:"path"`
    Filename string `ini:"fileName"`
    // 如果是结构体，则指明分区名。其他指明配置项即可
    Children `ini:"tailfile.children"`
}
type Children struct {
    Name string `ini:"name"`
}
type Config struct {
    KafkaConfig `ini:"kafka"`
    TailConfig  `ini:"tailfile"`
}
​

func main() {
    // 先实例化结构体，将指针传入MapTo方法中
    var cfg = new(Config)
    err := ini.MapTo(cfg, "./conf/go-conf.ini")
    if err != nil {
        fmt.Print(err)
    }
// 取最深的配置项
fmt.Println(cfg.TailConfig.Children.Name)
}    
// 运行结果： pp_mode

父子分区

go-ini有父子分区，但是层级不是很分明。不管是在结构体中还是直接文件操作，操作起来和平级一样的。

您可以在分区名称中使用 . 来表示两个或多个分区之间的父子关系。如果某个键在子分区中不存在，则会去它的父分区中再次寻找，直到没有父分区为止。

就如上个例子中，映射cfg.TailConfig.Children, tag上标明的是tailfile.children,这和平级完全是一样的，层级还是通过结构体体现出来的

两份关键代码

• main.go

package main
​
import (
    "fmt"
​
    "github.com/go-ini/ini"
)
​
type KafkaConfig struct {
    Address string `ini:"address"`
}
type TailConfig struct {
    Path     string `ini:"path"`
    Filename string `ini:"fileName"`
    // 如果是结构体，则指明分区名
    Children `ini:"tailfile.children"`
}
type Config struct {
    KafkaConfig `ini:"kafka"`
    TailConfig  `ini:"tailfile"`
}
type Children struct {
    Name string `ini:"name"`
}
​
func main() {
​
    // var cfg = new(Config)
    // err := ini.MapTo(cfg, "./conf/go-conf.ini")
    // if err != nil {
    //  fmt.Print(err)
    // }
    // fmt.Println(cfg.TailConfig.Children.Name)
​
    cfgs, err := ini.Load("./conf/go-conf.ini")
    if err != nil {
        fmt.Println(err)
    }
    // val,_ := cfgs.Section("").Key("a").Int()
​
    fmt.Print(val)
​
​
}
​

• go-conf.ini

a=122
​
[kafka]
address = 127.0.0.1:9092
​
[tailfile]
path     = f:/runtime/tmp
fileName = 4.log
​
[tailfile.children]
name = pp_mode
​
​