快捷導(dǎo)航

Golang解析yaml文件操作指南

更新時(shí)間：2022年09月07日 11:33:49 作者：itsgopher

之前一直從事java開發(fā),習(xí)慣了使用yaml文件的格式,尤其是清晰的層次結(jié)構(gòu)、注釋,下面這篇文章主要給大家介紹了關(guān)于Golang解析yaml文件的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

yaml 文件是研發(fā)人員最常用的配置文件，yaml 文件的樹形結(jié)構(gòu)一直很受大家的歡迎。有過 SpringBoot 開發(fā)經(jīng)驗(yàn)的同學(xué)對 yaml 非常熟悉，SpringBoot 整個(gè)項(xiàng)目的運(yùn)行就需要一個(gè) application.yaml 文件的支持，那么 Golang 項(xiàng)目中的 yaml 文件是如何解析的呢？Let`s dive in!

PS：根據(jù) godocs 的說法，Golang 有三個(gè)強(qiáng)大的工具包支持 yaml 文件的解析，分別是：go-gypsy go-yaml goccy-yaml。本文中我們將討論其中 go-yaml 的用法。

對 yaml 解析源碼感興趣的同學(xué)請進(jìn)入：go-yaml源碼鏈接

Simple Demo

第一步，我們創(chuàng)建好項(xiàng)目后導(dǎo)入 go-yaml 依賴：

?  go-yaml go get gopkg.in/yaml.v3
go: added gopkg.in/yaml.v3 v3.0.1

第二步，創(chuàng)建 main 文件并在內(nèi)部編寫一個(gè)簡單的結(jié)構(gòu)體：

type ConfDemo struct {
  // 后面的 yaml 注解是在 yaml 文件中的屬性名
	A int      `yaml:"a"`
	B string   `yaml:"b"`
	C bool     `yaml:"c"`
	D []string `yaml:"d"`
	E struct {
		EA string `yaml:"ea"`
		EB string `yaml:"eb"`
	} `yaml:"e"`
}

第三步，在主目錄下創(chuàng)建 conf 目錄，并在 conf 目錄下創(chuàng)建 conf_demo.yaml 文件去編寫我們的配置：

a: 1
b: "I am B"
c: true
d:
  - "I"
  - "am"
  - "D"
e:
  ea: "I am EA"
  eb: "I am EB"

第四步，編寫 main 函數(shù)：

func main() {
  // 讀取文件所有內(nèi)容裝到 []byte 中
	bytes, err := ioutil.ReadFile("config/conf_demo.yaml")
	if err != nil {
		log.Fatalln(err)
	}
  // 創(chuàng)建配置文件的結(jié)構(gòu)體
	var confDemo ConfDemo
  // 調(diào)用 Unmarshall 去解碼文件內(nèi)容
  // 注意要穿配置結(jié)構(gòu)體的指針進(jìn)去
	err = yaml.Unmarshal(bytes, &confDemo)
	if err != nil {
		log.Fatalln(err)
	}
  // 調(diào)用 Unmarshall 對解碼出來的 confDemo 進(jìn)行編碼
  // 返回的 yml 是 []byte 類型的
  yml, err := yaml.Marshal(confDemo)
	if err != nil {
		log.Fatalln(err)
	}
  // 輸出結(jié)果
	fmt.Printf("%#v\n", confDemo)
  fmt.Printf("%s\n", yml)
}

第五步，運(yùn)行并查看結(jié)果：

?  go-yaml go run main.go
main.ConfDemo{A:1, B:"I am B", C:true, D:[]string{"I", "am", "D"}, E:struct { EA string "yaml:\"ea\""; EB string "yaml:\"eb\"" }{EA:"I am EA", EB:"I am EB"}}
a: 1
b: I am B
c: true
d:
    - I
    - am
    - D
e:
    ea: I am EA
    eb: I am EB

go-yaml 其他解析方法

第一種解析方法即 simple Demo 中展現(xiàn)的 Marshall 和 Unmarshall 方法，他們會(huì)直接在結(jié)構(gòu)體和字節(jié)流上進(jìn)行操作。但有時(shí)我們?yōu)榱藞D方便想把讀取字節(jié)流這一步也交給組件去執(zhí)行，這時(shí)候我們可以利用 yaml.Encoder 和 yaml.Decoder。

yaml.Encoder 和 yaml.Decoder 在 io.Writer 和 io.Reader 上進(jìn)行操作讀取其字節(jié)流并執(zhí)行編碼和解碼的動(dòng)作。我們將上面的例子以這種方法再次實(shí)現(xiàn)一遍：

func main() {
  // 利用 os.Open 獲取 File 對象，該對象實(shí)現(xiàn)了 io.Reader 和 io.Writer
	file, err := os.Open("config/conf_demo.yaml")
	if err != nil {
		log.Fatalln(err)
	}
  // 構(gòu)造新的 Decoder，并傳入 file
	decoder := yaml.NewDecoder(file)
  // 配置文件結(jié)構(gòu)體
	var confDemo ConfDemo
  // 解碼操作，注意要傳入地址
	err = decoder.Decode(&confDemo)
  // 輸出解碼結(jié)果
	fmt.Printf("%#v\n", confDemo)
	if err != nil {
		log.Fatalln(err)
	}
  // 構(gòu)造新的 Encoder，這里直接傳入了 os.Stdout，代表結(jié)果直接輸出到控制臺
	encoder := yaml.NewEncoder(os.Stdout)
  // 編碼并輸出
	err = encoder.Encode(confDemo)
	if err != nil {
		log.Fatalln(err)
	}
}

運(yùn)行結(jié)果：

?  go-yaml go run main.go
main.ConfDemo{A:1, B:"I am B", C:true, D:[]string{"I", "am", "D"}, E:struct { EA string "yaml:\"ea\""; EB string "yaml:\"eb\"" }{EA:"I am EA", EB:"I am EB"}}
a: 1
b: I am B
c: true
d:
    - I
    - am
    - D
e:
    ea: I am EA
    eb: I am EB