Golang解析yaml文件操作指南

前言

yaml 文件是研发人员最常用的配置文件，yaml 文件的树形结构一直很受大家的欢迎。有过 springboot 开发经验的同学对 yaml 非常熟悉，springboot 整个项目的运行就需要一个 application.yaml 文件的支持，那么 golang 项目中的 yaml 文件是如何解析的呢？let`s dive in!

ps：根据 godocs 的说法，golang 有三个强大的工具包支持 yaml 文件的解析，分别是：go-gypsy go-yaml goccy-yaml。本文中我们将讨论其中 go-yaml 的用法。

对 yaml 解析源码感兴趣的同学请进入：go-yaml源码链接

simple demo

第一步，我们创建好项目后导入 go-yaml 依赖：

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

第二步，创建 main 文件并在内部编写一个简单的结构体：

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"`
}

第三步，在主目录下创建 conf 目录，并在 conf 目录下创建 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 函数：

func main() {
  // 读取文件所有内容装到 []byte 中
	bytes, err := ioutil.readfile("config/conf_demo.yaml")
	if err != nil {
		log.fatalln(err)
	}
  // 创建配置文件的结构体
	var confdemo confdemo
  // 调用 unmarshall 去解码文件内容
  // 注意要穿配置结构体的指针进去
	err = yaml.unmarshal(bytes, &confdemo)
	if err != nil {
		log.fatalln(err)
	}
  // 调用 unmarshall 对解码出来的 confdemo 进行编码
  // 返回的 yml 是 []byte 类型的
  yml, err := yaml.marshal(confdemo)
	if err != nil {
		log.fatalln(err)
	}
  // 输出结果
	fmt.printf("%#v\n", confdemo)
  fmt.printf("%s\n", yml)
}

第五步，运行并查看结果：

➜  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 中展现的 marshall 和 unmarshall 方法，他们会直接在结构体和字节流上进行操作。但有时我们为了图方便想把读取字节流这一步也交给组件去执行，这时候我们可以利用 yaml.encoder 和 yaml.decoder。

yaml.encoder 和 yaml.decoder 在 io.writer 和 io.reader 上进行操作读取其字节流并执行编码和解码的动作。我们将上面的例子以这种方法再次实现一遍：

func main() {
  // 利用 os.open 获取 file 对象，该对象实现了 io.reader 和 io.writer
	file, err := os.open("config/conf_demo.yaml")
	if err != nil {
		log.fatalln(err)
	}
  // 构造新的 decoder，并传入 file
	decoder := yaml.newdecoder(file)
  // 配置文件结构体
	var confdemo confdemo
  // 解码操作，注意要传入地址
	err = decoder.decode(&confdemo)
  // 输出解码结果
	fmt.printf("%#v\n", confdemo)
	if err != nil {
		log.fatalln(err)
	}
  // 构造新的 encoder，这里直接传入了 os.stdout，代表结果直接输出到控制台
	encoder := yaml.newencoder(os.stdout)
  // 编码并输出
	err = encoder.encode(confdemo)
	if err != nil {
		log.fatalln(err)
	}
}

运行结果：

➜  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

总结

到此这篇关于golang解析yaml文件操作的文章就介绍到这了,更多相关golang解析yaml文件内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！