解析各种 toml 配置文件：使用 go-toml/v2 模块的 golang 实现

从现在开始，努力学习吧！本文《解析各种 toml 配置文件：使用 go-toml/v2 模块的 golang 实现》主要讲解了等等相关知识点，我会在golang学习网中持续更新相关的系列文章，欢迎大家关注并积极留言建议。下面就先一起来看一下本篇正文内容吧，希望能帮到你！

如何使用 go-toml/v2 解组具有各种分段名称的 toml 配置文件？

我有一个 toml 配置文件，例如：

url     = "https://grafana.home/api/annotations"
api_key = "glsa_secret_2b3226ac"
cluster = "Sandbox"

[spikes]
dashboard = "84357279284502"
panel     = 23

[logs]
dashboard = "84357279284503"
panel     = 24

[cpu]
dashboard = "84357279284504"
panel     = 25

使用 url、api_key 和 cluster 的部分很容易使用结构进行解组。 具有spikes、logs和cpu的部分也很容易通过结构进行解组，但是每个部分的[name]在不同的环境中可以不同。

正确答案

您的 toml 文档对应于以下 json 结构：

{
  "url": "https://grafana.home/api/annotations",
  "api_key": "glsa_secret_2b3226ac",
  "cluster": "sandbox",
  "spikes": {
    "dashboard": "84357279284502",
    "panel": 23
  },
  "logs": {
    "dashboard": "84357279284503",
    "panel": 24
  },
  "cpu": {
    "dashboard": "84357279284504",
    "panel": 25
  }
}

解析 go 结构很棘手，因为顶层包含已知和未知的键，并将键映射到不同的数据类型（一种情况是字符串，另一种情况是映射）。

如果您可以控制该文件的格式，最好将动态键移到特定属性下。

如果您无法控制文件格式，则需要将数据解组到 map[string]接口{}，然后检查键名称或值类型在运行时确定要做什么。

这是一个例子：

package main

import (
  "fmt"
  "os"

  toml "github.com/pelletier/go-toml/v2"
  "k8s.io/utils/strings/slices"
)

func main() {
  data := make(map[string]interface{})

  content, err := os.readfile("data.toml")
  if err != nil {
    panic(err)
  }

  if err := toml.unmarshal(content, &data); err != nil {
    panic(err)
  }

  for k, v := range data {
    if slices.contains([]string{"url", "api_key", "cluster"}, k) {
      // it's a known string value
      fmt.printf("got %s = %s\n", k, v)
    } else {
      // it's an unknown key so value is a map
      fmt.printf("got dashboard %s:\n", k)
      x := v.(map[string]interface{})
      for kk, vv := range x {
        fmt.printf("  %s: %v\n", kk, vv)
      }

      // we can also ask for specific items if we know the keys
      fmt.printf("dashboard id is %s\n", v.(map[string]interface{})["dashboard"])
      fmt.printf("panel id is %d\n", v.(map[string]interface{})["panel"])
    }
  }
}

产生输出：

got url = https://grafana.home/api/annotations
got api_key = glsa_secret_2b3226ac
got cluster = sandbox
got dashboard spikes:
  dashboard: 84357279284502
  panel: 23
dashboard id is 84357279284502
panel id is 23
got dashboard logs:
  dashboard: 84357279284503
  panel: 24
dashboard id is 84357279284503
panel id is 24
got dashboard cpu:
  dashboard: 84357279284504
  panel: 25
dashboard id is 84357279284504
panel id is 25

如果我们不是特别担心性能，我们可以偷偷摸摸地将未知键的值解组回 toml，然后放入结构中：

package main

import (
  "fmt"
  "os"

  toml "github.com/pelletier/go-toml/v2"
  "k8s.io/utils/strings/slices"
)

type (
  dashboard struct {
    dashboard string
    panel     int
  }
)

func main() {
  data := make(map[string]interface{})

  content, err := os.readfile("data.toml")
  if err != nil {
    panic(err)
  }

  if err := toml.unmarshal(content, &data); err != nil {
    panic(err)
  }

  for k, v := range data {
    if slices.contains([]string{"url", "api_key", "cluster"}, k) {
      // it's a known string value
      fmt.printf("got %s = %s\n", k, v)
    } else {
      // it's an unknown key so value is a map
      dashboard := dashboard{}
      tomlstr, err := toml.marshal(v)
      if err != nil {
        panic(err)
      }
      if err := toml.unmarshal(tomlstr, &dashboard); err != nil {
        panic(err)
      }

      fmt.printf("got dashboard %s: %+v\n", k, dashboard)
    }
  }
}

这会产生：

Got dashboard spikes: {Dashboard:84357279284502 Panel:23}
Got dashboard logs: {Dashboard:84357279284503 Panel:24}
Got dashboard cpu: {Dashboard:84357279284504 Panel:25}
Got url = https://grafana.home/api/annotations
Got api_key = glsa_secret_2b3226ac
Got cluster = Sandbox

好了，本文到此结束，带大家了解了《解析各种 toml 配置文件：使用 go-toml/v2 模块的 golang 实现》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多Golang知识！