如何使用 Go 语言保留配置文件中的注释信息？

使用 go 语言读取带注释配置文件库

对于需要从配置文件中读取数据并保留注释的 go 语言开发者来说，这是一个常见问题。viper 库虽然易于使用，但它会删除配置中的注释，因此并不适合此场景。

对此，推荐使用 go-yaml 库。该库提供了 yaml.node 结构，它允许您在反序列化到该结构时保留注释信息。以下示例代码展示了如何使用它：

import (
    "log"
    "strings"

    yaml "gopkg.in/yaml.v3"
)

func main() {
    var node yaml.node

    data := []byte(strings.trimspace(`
block1:
    # the comment
    map:
        key1: a
        key2: b
    
block2:
    hi: there

`))

    log.printf("input:
 %s", data)

    if err := yaml.unmarshal(data, &node); err != nil {
        log.fatalf("unmarshalling failed %s", err)
    }

    results, err := yaml.marshal(node.content[0])
    if err != nil {
        log.fatalf("marshalling failed %s", err)
    }

    log.printf("result:
 %s", results)
}

上面的代码将输入的 yaml 配置以 yaml.node 结构反序列化。此结构保留了注释和其他元数据信息。然后，再将结果序列化为原始 yaml 表示，其中保留了注释。

输出如下：

2009/11/10 23:00:00 INPUT:
block1:
    # the comment
    map:
        key1: a
        key2: b

block2:
    hi: there
2009/11/10 23:00:00 RESULT:
block1:
    # the comment
    map:
        key1: a
        key2: b
block2:
    hi: there

通过使用 go-yaml 库，您可以方便地从 go 语言配置文件中读取数据并保留重要的注释信息。

以上就是如何使用 Go 语言保留配置文件中的注释信息？的详细内容，更多请关注硕下网其它相关文章！