Go語言讀取YAML 配置文件的兩種方式分享

更新時(shí)間：2022年12月18日 09:51:48 作者：陳明勇

在日常開發(fā)中，YAML 格式的文件基本上被默認(rèn)為是配置文件，其內(nèi)容因?yàn)榭s進(jìn)帶來的層級感看起來非常直觀和整潔。本文分享了讀取YAML 配置文件的兩種方式，需要的可以參考一下

前言

在日常開發(fā)中，YAML 格式的文件基本上被默認(rèn)為是配置文件，其內(nèi)容因?yàn)榭s進(jìn)帶來的層級感看起來非常直觀和整潔。本文將會對 YAML 內(nèi)容的讀取進(jìn)行介紹。

yaml.v3 包

yaml.v3 的包，可以讓我們在 Go 里面輕松地操作 yaml 格式的數(shù)據(jù)（如將 yaml 格式轉(zhuǎn)成結(jié)構(gòu)體等）。在使用 yaml.v3 包之前，我們需要先安裝它：

go get gopkg.in/yaml.v3

讀取 yaml 文件

yaml 測試文件內(nèi)容：

mysql:
  url: 127.0.0.1
  port: 3306

redis:
  host: 127.0.0.1
  port: 6379

將 yaml 文件的數(shù)據(jù)轉(zhuǎn)成自定義的結(jié)構(gòu)體或 Map

import (
	"fmt"
	"gopkg.in/yaml.v3"
	"os"
)

type Config struct {
	Mysql Mysql `json:"mysql"`
	Redis Redis `json:"redis"`
}

type Mysql struct {
	Url  string
	Port int
}

type Redis struct {
	Host string
	Port int
}

func main() {
	dataBytes, err := os.ReadFile("test.yaml")
	if err != nil {
		fmt.Println("讀取文件失?。?, err)
		return
	}
	fmt.Println("yaml 文件的內(nèi)容: \n", string(dataBytes))
	config := Config{}
	err = yaml.Unmarshal(dataBytes, &config)
	if err != nil {
		fmt.Println("解析 yaml 文件失?。?, err)
		return
	}
	fmt.Printf("config → %+v\n", config) // config → {Mysql:{Url:127.0.0.1 Port:3306} Redis:{Host:127.0.0.1 Port:6379}}

	mp := make(map[string]any, 2)
	err = yaml.Unmarshal(dataBytes, mp)
	if err != nil {
		fmt.Println("解析 yaml 文件失?。?, err)
		return
	}
	fmt.Printf("map → %+v", config) // config → {Mysql:{Url:127.0.0.1 Port:3306} Redis:{Host:127.0.0.1 Port:6379}}

}

執(zhí)行結(jié)果：

yaml 文件的內(nèi)容:
mysql:
url: 127.0.0.1
port: 3306

redis:
host: 127.0.0.1
port: 6379
config → {Mysql:{Url:127.0.0.1 Port:3306} Redis:{Host:127.0.0.1 Port:6379}}
map → {Mysql:{Url:127.0.0.1 Port:3306} Redis:{Host:127.0.0.1 Port:6379}}

首先通過 os 包里的 ReadFile 函數(shù)讀取文件的內(nèi)容，獲取 []byte 類型的數(shù)據(jù)；
通過 yaml 包的 Unmarshal(in []byte, out interface{}) 函數(shù)將字節(jié)數(shù)組類型的數(shù)據(jù)解析到 Config 結(jié)構(gòu)體變量里，Unmarshal 函數(shù)需要傳遞兩個(gè)參數(shù)，第一個(gè)是字節(jié)數(shù)組類型的數(shù)據(jù)，第二個(gè)是一個(gè)任意類型的數(shù)據(jù)，實(shí)際上要傳入一個(gè)指針變量，或者某個(gè)變量的地址值；
通過打印結(jié)果可以看到 yaml 文件的內(nèi)容已經(jīng)成功解析到結(jié)構(gòu)體 config 和 mp 變量里了，后續(xù)可以通過操作結(jié)構(gòu)體和 map 獲取對應(yīng)數(shù)據(jù)。

viper 包

viper 包可以幫助我們做很多東西，比如讀取 json、yaml、properties 等配置文件，讀取環(huán)境變量、讀取命令行參數(shù)等。在使用 viper 包之前，我們需要先安裝它：

go get github.com/spf13/viper

讀取 yaml 文件

yaml 測試文件內(nèi)容：

mysql:
  url: 127.0.0.1
  port: 3306

redis:
  host: 127.0.0.1
  port: 6379

代碼示例：

import (
    "fmt"
    "github.com/spf13/viper"
)

func main() {
    // 設(shè)置配置文件的名字
    viper.SetConfigName("test")
    // 設(shè)置配置文件的類型
    viper.SetConfigType("yaml")
    // 添加配置文件的路徑，指定 config 目錄下尋找
    viper.AddConfigPath("./config")
    // 尋找配置文件并讀取
    err := viper.ReadInConfig()
    if err != nil {
            panic(fmt.Errorf("fatal error config file: %w", err))
    }
    fmt.Println(viper.Get("mysql"))     // map[port:3306 url:127.0.0.1]
    fmt.Println(viper.Get("mysql.url")) // 127.0.0.1
}

通過 SetConfigName 函數(shù)，指定配置文件的名稱；

通過 SetConfigType 函數(shù)，指定配置文件的類型；

通過 AddConfigPath 函數(shù)，指定配置文件所在目錄，可以多次調(diào)用此函數(shù)，指定多個(gè)目錄；

通過 ReadInConfig 函數(shù)，尋找配置文件并讀取，操作的過程中可能會發(fā)生錯(cuò)誤，如配置文件沒找到，配置文件的內(nèi)容格式不正確等；

讀取文件成功之后，可以通過 Get 函數(shù)，通過指定 key 獲取對應(yīng)的 value。