Question

使用Unmarshal尝试将hcl viper个配置文件添加到结构中，会返回此错误：1 error(s) decoding:\n\n* 'NATS' expected a map, got 'slice'。缺少什么？

代码：

func lab() {
    var c conf

    // config file
    viper.SetConfigName("draft")
    viper.AddConfigPath(".")
    viper.SetConfigType("hcl")
    if err := viper.ReadInConfig(); err != nil {
        log.Error(err)
        return
    }

    log.Info(viper.Get("NATS")) // gives [map[port:10041 username:cl1 password:__Psw__4433__ http_port:10044]]

    if err := viper.Unmarshal(&c); err != nil {
        log.Error(err)
        return
    }

    log.Infow("got conf", "conf", c)
}

type conf struct {
    NATS struct {
        HTTPPort int
        Port     int
        Username string
        Password string
    }
}

配置文件（当前目录中的draft.hcl）：

NATS {
    HTTPPort = 10044
    Port     = 10041
    Username = "cl1"
    Password = "__Psw__4433__"
}

修改

使用hcl包检查了这个结构，它正确地被编组/解组。这也适用于yaml和viper。

这两者之间存在差异，其中log.Info(viper.Get("NATS"))被调用。虽然hcl版本会返回一张地图，但yaml版本会返回一张地图：map[password:__psw__4433__ httpport:10044 port:10041 username:cl1]。

Answer 1

您的conf结构与HCL不匹配。当转换为json时，HCL看起来如下

{
"NATS": [
    {
      "HTTPPort": 10044,
      "Password": "__Psw__4433__",
      "Port": 10041,
      "Username": "cl1"
    }
  ]
}

所以Conf Struct应该看起来像这样

type Conf struct {
    NATS []struct{
        HTTPPort int
        Port     int
        Username string
        Password string
    }
}

修改后的代码

package main
import (
  "log"
  "github.com/spf13/viper"
  "fmt"
)

type Conf struct {
    NATS []struct{
        HTTPPort int
        Port     int
        Username string
        Password string
    }
}

func main() {
    var c Conf
    // config file
    viper.SetConfigName("draft")
    viper.AddConfigPath(".")
    viper.SetConfigType("hcl")
    if err := viper.ReadInConfig(); err != nil {
        log.Fatal(err)
    }
    fmt.Println(viper.Get("NATS")) // gives [map[port:10041 username:cl1 password:__Psw__4433__ http_port:10044]]

    if err := viper.Unmarshal(&c); err != nil {
        log.Fatal(err)
    }
    fmt.Println(c.NATS[0].Username)
}

Answer 2

我知道这个问题已经有两年多了，但是最近我遇到了同样的问题。

我正在使用viper来将不同的配置文件加载到Go结构中，从而允许以JSON，YAML，TOML，HCL进行配置，只需选择您喜欢的：）

HCL文件格式确实将地图包装成切片，因为它允许重新定义以下部分：

section = {
  key1 = "value"
}

section = {
  key2 = "value"
}

这是其他格式不支持的内容。

这是我的解决方法：

我的解决方案意味着每个新块都将覆盖同一键的任何先前定义，并保留所有其他定义。您可以合并一些魔术，但是我不需要。

您需要创建一个钩子才能将地图切片转换为地图：

// sliceOfMapsToMapHookFunc merges a slice of maps to a map
func sliceOfMapsToMapHookFunc() mapstructure.DecodeHookFunc {
    return func(from reflect.Type, to reflect.Type, data interface{}) (interface{}, error) {
        if from.Kind() == reflect.Slice && from.Elem().Kind() == reflect.Map && (to.Kind() == reflect.Struct || to.Kind() == reflect.Map) {
            source, ok := data.([]map[string]interface{})
            if !ok {
                return data, nil
            }
            if len(source) == 0 {
                return data, nil
            }
            if len(source) == 1 {
                return source[0], nil
            }
            // flatten the slice into one map
            convert := make(map[string]interface{})
            for _, mapItem := range source {
                for key, value := range mapItem {
                    convert[key] = value
                }
            }
            return convert, nil
        }
        return data, nil
    }
}

然后您需要创建一个DecodeHook：

configOption := viper.DecodeHook(mapstructure.ComposeDecodeHookFunc(
        sliceOfMapsToMapHookFunc(),
        mapstructure.StringToTimeDurationHookFunc(),
        mapstructure.StringToSliceHookFunc(","),
    ))

另外两个钩子是默认的钩子，因此您可能希望保留它们

然后将选项传递给Unmarshal方法

viper.Unmarshal(&c, configOption)

使用此方法，您无需在结构或地图周围切片。也使其与其他配置文件格式兼容

使用viper解组hcl到struct

2 个答案: