m

moox2020

V1

2022/08/18阅读:11主题:橙心

超赞的 Go 语言 INI 文件操作

超赞的 Go 语言 INI 文件操作

超赞是有多赞? 地表 最强大、最方便 和 最流行 的 Go 语言 INI 文件操作库

灵活的数据源

不光光可以从文件读取配置,还支持 []byte 类型的纯数据读取和基于 io.ReadCloser 的流式读取。

多种格式兼容

各种文件种类的广泛支持,包括但不限于 my.cnf.gitconfig 甚至不可解析的分区。

自然类型增强

将值自动转换为指定的 Go 语言原生类型,让代码更加专注于逻辑处理而不是坑爹的类型转换。

结构体映射

映射配置文件到用户定义的 struct{} 结构体中,在完成操作后还能从结构体反向映射成对应的配置文件。

超神般的辅助

自动类型转换、候选值限制、快速切片生成以及即时数据验证,比想象的还要多的多!

高度自定义

多种配置加载策略、自定义数据验证规则、键名和键值映射器等等,还不快点搞起来?

功能特性

| ini 包提供了 Go 语言中读写 INI 文件的功能

  • 支持覆盖加载多个数据源(file, []byte, io.Reader and io.ReadCloser)
  • 支持递归读取键值
  • 支持读取父子分区
  • 支持读取自增键名
  • 支持读取多行的键值
  • 支持大量辅助方法
  • 支持在读取时直接转换为 Go 语言类型
  • 支持读取和 写入 分区和键的注释
  • 轻松操作分区、键值和注释
  • 在保存文件时分区和键值会保持原有的顺序

下载安装

最低要求安装 Go 语言版本为 1.6。

$ go get gopkg.in/ini.v1

如需更新请添加 -u 选项。

开始使用

我们将通过一个非常简单的例子来了解如何使用。

首先,我们需要在任意目录创建两个文件(my.ini 和 main.go),在这里我们选择 /tmp/ini 目录。

$ mkdir -p /tmp/ini
cd /tmp/ini
$ touch my.ini main.go
$ tree .
.
├── main.go
└── my.ini

0 directories, 2 files

现在,我们编辑 my.ini 文件并输入以下内容(_部分内容来自 Grafana_)。

# possible values : production, development
app_mode = development

[paths]
# Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
data = /home/git/grafana

[server]
# Protocol (http or https)
protocol = http

# The http port  to use
http_port = 9999

# Redirect to correct domain if host header does not match domain
# Prevents DNS rebinding attacks
enforce_domain = true

很好,接下来我们需要编写 main.go 文件来操作刚才创建的配置文件。

package main

import (
    "fmt"
    "os"

    "gopkg.in/ini.v1"
)

func main() {
    cfg, err := ini.Load("my.ini")
    if err != nil {
        fmt.Printf("Fail to read file: %v", err)
        os.Exit(1)
    }

    // 典型读取操作,默认分区可以使用空字符串表示
    fmt.Println("App Mode:", cfg.Section("").Key("app_mode").String())
    fmt.Println("Data Path:", cfg.Section("paths").Key("data").String())

    // 我们可以做一些候选值限制的操作
    fmt.Println("Server Protocol:",
        cfg.Section("server").Key("protocol").In("http", []string{"http""https"}))
    // 如果读取的值不在候选列表内,则会回退使用提供的默认值
    fmt.Println("Email Protocol:",
        cfg.Section("server").Key("protocol").In("smtp", []string{"imap""smtp"}))

    // 试一试自动类型转换
    fmt.Printf("Port Number: (%[1]T) %[1]d\n", cfg.Section("server").Key("http_port").MustInt(9999))
    fmt.Printf("Enforce Domain: (%[1]T) %[1]v\n", cfg.Section("server").Key("enforce_domain").MustBool(false))
    
    // 差不多了,修改某个值然后进行保存
    cfg.Section("").Key("app_mode").SetValue("production")
    cfg.SaveTo("my.ini.local")
}

运行程序,我们可以看下以下输出:

$ go run main.go
App Mode: development
Data Path: /home/git/grafana
Server Protocol: http
Email Protocol: smtp
Port Number: (int) 9999
Enforce Domain: (bool) true

$ cat my.ini.local
# possible values : production, development
app_mode = production

[paths]
# Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
data = /home/git/grafana
...

完美!这个例子很简单,展示的也只是极其小部分的功能,想要完全掌握还需要多读多看,毕竟学无止境嘛。

分类:

后端

标签:

Golang

作者介绍

m
moox2020
V1