Go配置文件绑定到结构体实战演示

Posted 2022-10-27

说明

在实际的开发过程中，我们必然会用到mysql、Redis等这样的服务。为了实现系统的配置化，我们会把一些配置信息单独放在一些文件中，使用到的地方直接读取配置文件即可。常见的文件配置方式有很多中，例如json、tomal、yml或者文本格式。下面就针对几种方式进行一一演示。

演示代码

JSON配置

首先我们创建一个JSON的文件，里面配置我们需要的参数格式，示例：

  "host": "127.0.0.1",
  "user": "root",
  "password": "123456",
  "port": "3306",
  "db": "demo"

我们要读取配文件，就需要用到Golang中自带的json包。 具体的读取过程： 读取json文件内容->使用json包进行反序列化->利用变量存反序列的数据。

// 利用struct来定义json格式，与存储。
type DbJson struct 
	Host     string `json:"host"`
	User     string `json:"user"`
	Password string `json:"password"`
	Port     string `json:"port"`
	Db       string `json:"db"`


// 解析
func GetJsonConfig() 
	// 1. 读取json文件内容
	file, err := ioutil.ReadFile("./config/json.json")
	if err != nil 
		fmt.Println("err1", err)
		return
	

	db := new(DbJson)
	// 2. 将读取到的json文件内容，进行反序列化；将得到一个[]byte类型的切片
	err = json.Unmarshal(file, db)
	if err != nil 
		fmt.Println("err2", err)
		return
	
	// 2.1 将读取到的json文件内容，进行反序列化，复制给map[string][]byte(和2中的效果是一样的)
	allConfig := make(map[string]json.RawMessage, 0)
	err = json.Unmarshal(file, &allConfig)
	if err != nil 
		fmt.Println("err3", err)
		return
	

	// 3. 循环map内容
	for k, v := range allConfig 
		fmt.Println(k, string(v)) // 值为[]byte类型，将其转为string
	

最终输入结果：

host "127.0.0.1"
user "root"
password "123456"
port "3306"
db "demo"

在2和2.1其实都是不同的实现方式。

yml配置

yml格式也是我们常见的文件配置格式，在Golang中，我们读取该配置，主要用到了gopkg.in/yaml.v2包。 同样的，我们需要读取配置文件->解析文件内容。我们创建一个yml.yml文件，写入下面的示例配置：

host: 127.0.0.1
user: root
password: 123456
port: 3306
db: demo

// 定义一个struct来定义格式
type DbYml struct 
	Host     string `yaml:"host"`
	User     string `yaml:"user"`
	Password string `yaml:"password"`
	Port     string `yaml:"port"`
	Db       string `yaml:"db"`


func GetYmlConfig() 
	// 1. 读取配置文件内容，将返回一个[]byte的内容
	file, err := ioutil.ReadFile("./config/yml.yml")
	if err != nil 
		return
	
	db := new(DbYml)

	// 2. 使用yaml包进行反序列化
	err = yaml.Unmarshal(file, db)
	if err != nil 
		return
	
	fmt.Println(db.Host, db.User, db.Password, db.Port, db.Db)

最终输入结果：

127.0.0.1 root 123456 3306 demo

文本格式

读取文件格式的内容，就是按行读取，然后针对每行的内容进行解析。因为我们文本中的格式一般都是循序key=value的格式，因此我们只要读取到改行的内容，然后根据=进行分割即可。

首先我们创建一个文件.txt的文件内容，大致内容如下：

host=127.0.0.1
user=root
password=123456
port=3306
db=demo

具体读取配置代码：

func GetKeyValue() 
	allConfig := make(map[string]string)

	// 1. 读取文件，得到文件句柄
	open, err := os.Open("./config/key.txt")
	if err != nil 
		fmt.Println("err1", err)
		return
	

	// 2. 读取文件内容
	content := bufio.NewReader(open)
	for 
		// 3. 按行读取文件内容
		line, _, err := content.ReadLine()
		if err != nil 
			if err == io.EOF  // 去读到结尾，就跳出循环读取
				break
			
			return
		
		// 4. 处理每一行读取到的文件内容
		s := strings2.TrimSpace(string(line)) // 去掉左右空格
		index := strings2.Index(s, "=")       // 因为配置是=，找到=的索引位置
		if index < 0 
			continue
		

		key := strings2.TrimSpace(s[:index]) // 截取=左侧的值为key
		if len(key) == 0 
			continue
		

		value := strings2.TrimSpace(s[index+1:]) // 截取=右侧的为value
		if len(value) == 0 
			continue
		

		allConfig[key] = value // 添加到map中，key为map的key，value为map的value
	

	for k, v := range allConfig 
		fmt.Println(k, string(v))
	

	defer open.Close() // 关闭关文件

输出的内容大致如下：

host 127.0.0.1
user root
password 123456
port 3306
db demo

tomal

使用toml格式的配置文件，主要用到了toml包进行解析出来。同样的，首先我们是加载文件，将文件的路径传入到toml包中即可。 首先我们创建一个toml文件的，定义如下内容：

[database]
host="127.0.0.1"
user="root"
password="123456"
port=[3306, 3307]
db="demo"

下面是具体的解析代码：

import (
	"github.com/BurntSushi/toml"
	"path/filepath"
)

type DbToml struct 
	Db Database `toml:"database"`


type Database struct 
	Host     string
	User     string
	Password string
	Port     []int32
	Db       string


func GetToml() 
	// 1. 定义结构体变量来接收解析的数据
	var config DbToml

	// 2. 获取文件绝对路径
	fileName, err := filepath.Abs("./config/toml.toml")
	if err != nil 
		fmt.Println("err1", err)
		return
	

	// 3. 根据toml包的规则传入文件路径
	_, err1 := toml.DecodeFile(fileName, &config)
	if err1 != nil 
		fmt.Println("err2", err1)
		return
	

	fmt.Println(config.Db.Host, config.Db.User, config.Db.Password, config.Db.Port[0], config.Db.Db)

输出结果如下：

127.0.0.1 root 123456 3306 demo