Go text/template如何检测未解析的模板属性并返回错误

• 开发场景：使用Go标准库text/template包拼接生成字符串，模板内容不固定，通过传入map结构作为数据源解析模板中的变量占位符
• 需求：渲染时只要存在模板引用的变量未在数据源中定义的情况，需要立刻识别异常、返回对应错误
• 现有实现：通过正则匹配渲染结果中的<no value>标识判断是否有缺失变量，寻求更可靠的优化方案

原有实现代码如下：

package main

import (
    "bytes"
    "fmt"
    "regexp"
    "text/template"
)

func main() {
    data := "teststring/{{.someData}}/{{.notExist}}/{{.another}}"
    // 模板内容任意，无法提前枚举所有字段做硬编码判断

    t := template.Must(template.New("").Parse(data))
    var b bytes.Buffer

    fillers := map[string]interface{}{
        "someData": "123",
        "another":  true,
        // 未传入notExist字段，模板会输出<no value>占位
    }
    if err := t.Execute(&b, fillers); err != nil {
        panic(err)
    }

    fmt.Println(b.String())
    // 输出: teststring/123/<no value>/true
    // 正则匹配<no value>判断是否有缺失字段
    hasResolved := regexp.MustCompile(`<no value>`)
    fmt.Println(hasResolved.MatchString(b.String()))

    // 补全notExist字段
    fillers["notExist"] = "testdata"
    b.Reset()
    if err := t.Execute(&b, fillers); err != nil {
        panic(err)
    }
    fmt.Println(b.String())
    fmt.Println(hasResolved.MatchString(b.String()))

    // 输出:
    // teststring/123/<no value>/true
    // true
    // teststring/123/testdata/true
    // false
}

正则匹配输出内容的方案存在明显缺陷：如果业务本身需要渲染的合法内容中包含<no value>字符串，会触发误判。
text/template原生提供了缺失key的处理配置，不需要事后匹配结果，只需要在模板初始化后调用Option方法设置missingkey=error，执行渲染时一旦遇到数据源中不存在的key，会直接返回错误，从执行阶段就拦截异常，可靠性100%。

优化后的核心实现：

package main

import (
	"bytes"
	"fmt"
	"text/template"
)

func main() {
	data := "teststring/{{.someData}}/{{.notExist}}/{{.another}}"
	// 关键配置：遇到缺失key直接返回错误
	t := template.Must(template.New("").Option("missingkey=error").Parse(data))
	var b bytes.Buffer

	fillers := map[string]interface{}{
		"someData": "123",
		"another":  true,
	}
	// 第一次执行，缺失notExist字段，会直接返回错误
	err := t.Execute(&b, fillers)
	fmt.Println("第一次执行错误：", err) // 输出: template: :1:26: executing "" at <.notExist>: map has no entry for key "notExist"

	// 补全字段后执行正常
	fillers["notExist"] = "testdata"
	b.Reset()
	if err := t.Execute(&b, fillers); err != nil {
		panic(err)
	}
	fmt.Println("第二次执行结果：", b.String()) // 输出: teststring/123/testdata/true
}

方案说明 #

• 该配置对任意结构的模板、任意map类型数据源通用，不需要提前解析模板枚举字段，完全适配模板内容动态的场景
• 除error模式外，missingkey还支持两个可选配置：
  • missingkey=default：默认行为，缺失时输出<no value>
  • missingkey=zero：缺失时输出对应类型的零值，不返回错误

内容的提问来源于stack exchange，提问作者securisec