go-ini的使用记录 | 青训营

69 阅读2分钟

简介

官方文档地址:ini.unknwon.io/

号称是地表 最强大最方便 和 最流行 的 Go 语言 INI 文件操作库

配置文件形式为[section] 的段构成, 内部使用 name=value键值对 。go-ini是 Go 语言中用于操作 ini 文件的第三方库。本文介绍go-ini库的使用。

go-ini

安装

命令行输入 go get gopkg.in/ini.v1 即可

开始使用

在项目根目录创建 .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 = true

在项目根目录中创建 main.go文件,对上述ini文件进行操作:

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-ini的作用主要是方便把配置信息从原本的程序中抽离出来,这样做的目的有两个:1. 避免在程序中进行配置而对后续更改造成麻烦;2.避免在程序中进行配置而造成相应的信息泄露。

在简易抖音项目中,使用go-ini对MySQL数据库的配置进行了抽离,保存到ini文件中,方便后续配置的修改和程序的迁移。