Terraform中map[string]interface{}类型ResourceData转结构体方案

问题复现 #

开发自定义Terraform Provider时，尝试将schema.TypeList类型的嵌套配置块转换为自定义Go结构体，相关定义如下：

1. Schema字段定义

"template": {
    Type:     schema.TypeList,
    Required: true,
    ForceNew: false,
    Elem: &schema.Resource{
        Schema: map[string]*schema.Schema{
            "lists_test": {
                Type:     schema.TypeSet,
                Required: true,
                ForceNew: false,
                Elem: &schema.Schema{
                    Type: schema.TypeString,
                },
            },
            "name_test": {
                Type:     schema.TypeString,
                Required: true,
                ForceNew: false,
            },
        },
    },
},

2. 目标映射结构体

type TestStruct struct {
    NameTest   string   `json:"name_test"`
    ListsTests []string `json:"lists_test"`
}

尝试直接通过JSON序列化/反序列化转换时，抛出错误json: unsupported type: SchemaSetFunc；尝试gohcl.DecodeBody方案不适配*schema.ResourceData处理场景，无法使用。

报错原因 #

之前的推测有误，不是序列化时拿到了schema.Schema类型：d.Get()返回的TypeSet字段值是Terraform SDK内部的*schema.Set结构体实例，这个结构内部存储了用于Set去重的哈希计算函数SchemaSetFunc等函数类型字段，JSON序列化不支持函数类型，因此直接对整个嵌套map做Marshal操作必然报错。

可行解决方案 #

方案1：手动类型断言转换（无依赖，最稳定） #

不做全量序列化，逐个字段做类型断言提取值，遇到TypeSet字段先转成*schema.Set，调用其自带的List()方法拿到原生切片后再逐个转成目标类型，示例代码：

// 提取TypeList内容，单嵌套块场景取第一个元素即可
templateList := d.Get("template").([]interface{})
if len(templateList) == 0 {
	// 按需处理空块逻辑
	return fmt.Errorf("template block can not be empty")
}
templateMap := templateList[0].(map[string]interface{})

converted := &TestStruct{}
// 提取普通字符串字段
if name, ok := templateMap["name_test"].(string); ok {
	converted.NameTest = name
}
// 处理TypeSet字段
if rawSet, ok := templateMap["lists_test"].(*schema.Set); ok {
	setItems := rawSet.List()
	converted.ListsTests = make([]string, 0, len(setItems))
	for _, item := range setItems {
		if strItem, ok := item.(string); ok {
			converted.ListsTests = append(converted.ListsTests, strItem)
		}
	}
}

// 后续直接使用converted结构体即可

如果你的TypeList允许配置多个块，直接遍历templateList循环转换即可。

方案2：mapstructure自动转换（适合字段多的复杂嵌套场景） #

如果嵌套层级深、字段数量多，不想逐字段写断言，可以用mapstructure库，添加自定义解码钩子自动处理*schema.Set类型转换，示例代码：

import (
	"reflect"
	"github.com/hashicorp/terraform/helper/schema"
	"github.com/mitchellh/mapstructure"
)

// ...
templateList := d.Get("template").([]interface{})
templateMap := templateList[0].(map[string]interface{})
converted := &TestStruct{}

// 初始化解码器
decoder, err := mapstructure.NewDecoder(&mapstructure.DecoderConfig{
	Result:  converted,
	TagName: "json", // 匹配结构体上的json tag
	DecodeHook: func(f reflect.Type, t reflect.Type, data interface{}) (interface{}, error) {
		// 自动将*schema.Set转为原生切片
		if f == reflect.TypeOf(&schema.Set{}) {
			return data.(*schema.Set).List(), nil
		}
		return data, nil
	},
})
if err != nil {
	return err
}
// 执行转换
if err := decoder.Decode(templateMap); err != nil {
	return err
}

避坑提示 #

• 永远不要直接对d.Get()取出的嵌套结构直接做JSON序列化：Terraform SDK的Set、部分嵌套List结构会携带内部函数、元数据字段，不是纯原生Go基础类型集合，序列化必然失败。
• gohcl.DecodeBody的设计场景是直接解析原始HCL文件的语法树，不适合处理已经加载到*schema.ResourceData中的配置值，不用在这个方向尝试。

内容的提问来源于stack exchange，提问作者Jay-r Bangit