go-ini
阅读提示
- 适用版本:Go 1.21+(示例在 Go 1.22 下验证)· 前置知识:标准库-strings · 阅读时长:约 10 分钟
仓库:go-ini/ini: Package ini provides INI file read and write functionality in Go (github.com)
文档:go-ini/ini: 超赞的 Go 语言 INI 文件操作 (unknwon.cn)
简介
使用Go语言编写的ini文件的解析库,支持序列化和反序列,支持结构体映射,支持注释操作。
安装
go get gopkg.in/ini.v1快速开始
ini文件如下
ini
# 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 = truego文件
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
...完整示例
下面的程序可以直接运行:复制到文件后执行 go run main.go,或粘贴到 Go Playground 运行。
go
package main
import (
"fmt"
"strings"
)
func main() {
content := "[server]\nport = 8080\nhost = localhost\n"
values := map[string]string{}
for _, line := range strings.Split(content, "\n") {
line = strings.TrimSpace(line)
if line == "" || strings.HasPrefix(line, "[") {
continue
}
if k, v, ok := strings.Cut(line, "="); ok {
values[strings.TrimSpace(k)] = strings.TrimSpace(v)
}
}
fmt.Println(values["host"], values["port"])
}预期输出:
text
localhost 8080常见错误与踩坑
- INI 没有统一标准。 各实现对待引号、转义、多行值的方式不同;真实文件请使用库解析。
- 注意节(section)名。 同名键可能出现在多个节里,要么展平要么在查找时带上节名。
- 空白处理要一致。
key = value与key=value都常见,统一 Trim。 - 编码由你负责。 库返回字符串,数字与布尔值要显式解析。
- 不要把 INI 当 schema。 嵌套配置应优先 YAML/TOML/JSON。
更新记录
- 2026-10-14:新增"阅读提示"、完整可运行示例(含预期输出)、常见错误与踩坑清单,以及本更新记录。
