用Go实现yaml文件节点动态解析

1.摘要

在大多数Go语言项目中, 配置文件通常为yaml文件格式, 在文件中可以设置项目中可灵活配置的各类参数, 通常这类参数都是比较固定的, 可以将其映射为对应的结构体在项目中进行使用, 如果需要调整参数时, 只需要增减结构体参数字段内容即可。

但同时还存在另外一种情况, 例如: 在ubuntu系统中, netplan网卡配置文件同样也是yaml格式文件(配置文件在/etc/netplan目录下), 但该配置文件的节点内容可能是动态变化的, 例如:当dhcp开启或关闭时, 其节点展示的内容差异会很大, 要动态读取和写入对应的节点内容使用结构体已无法满足实际需求。本章节主要分享一种动态解析yaml格式文件节点内容的相关知识。

2.静态解析方法

首先还是回顾一下静态解析的方法, 假如我们的yaml配置文件内容如下:

database:
  mysql:
    db_host: 192.168.201.200
    db_user: root
    db_port: 3306
    db_name: datas

以上是一个关于数据库连接方式的节点定义, 在Go代码中, 我们定义一个综合结构体:

type (
  Config struct {
    Database DatabaseConfig
  }
​
  DatabaseConfig struct {
    Mysql MysqlConfig
  }
​
  MysqlConfig struct {
    DbHost     string `mapstructure:"db_host"`
    DbUser     string `mapstructure:"db_user"`
    DbPassword string
    DbPort     string `mapstructure:"db_port"`
    DbName     string `mapstructure:"db_name"`
  }
)

在以上配置中, database是根节点, 子节点是mysql, 在子节点下有四个叶子节点db_host、db_user、db_port和db_name。在结构体中, MysqlConfig是代表叶子节点结构, 使用mapstructure关联了yaml配置文件中的字段名, 然后使用DatabaseConfig包含MysqlConfig, 使用Config包含DatabaseConfig, 与yaml文件中的节点层级一一对应。

在应用过程中也比较简单, 只需要以下代码即可将yaml配置文件中的内容解析到结构体:

var cfg Config
if err := unmarshal(&cfg); err != nil {