前言

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

yaml.v3 包

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

go get gopkg.in/yaml.v3

讀取 yaml 文件

yaml 測(cè)試文件內(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}}

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

viper 包

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

go get github.com/spf13/viper

讀取 yaml 文件

yaml 測(cè)試文件內(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è)置配置文件的類(lèi)型
    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
}

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

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

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

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

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

小結(jié)

本文介紹了讀取 YAML 配置文件的兩種方式，第一種是通過(guò) yaml.v3 包，第二種是通過(guò) viper 包。如果是在項(xiàng)目里解析配置文件，推薦使用 viper 包，它支持解析多種格式的配置文件，監(jiān)聽(tīng)配置文件的更新，修改配置文件等。

到此這篇關(guān)于Go語(yǔ)言讀取YAML 配置文件的兩種方式分享的文章就介紹到這了,更多相關(guān)Go讀取YAML 配置文件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論