Go语言中如何在template模板内输出符合Go语法的map格式内容

下面是三种可直接落地的实现方式： #

方法1：直接提前格式化字符串（最简单） #

不需要修改模板函数配置，直接在Go代码侧提前生成符合要求的字符串，传给模板渲染即可：

• Go代码侧逻辑：

package main

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

func main() {
    x := map[string]bool{"1":true,"2":true}
    // 提前格式化好目标字符串
    xStr := fmt.Sprintf("x := %#v", x)
    // 准备传给模板的数据
    data := map[string]interface{}{
        "XStr": xStr,
    }
    // 解析模板
    tpl, err := template.ParseFiles("go.tmpl")
    if err != nil {
        panic(err)
    }
    // 渲染输出
    err = tpl.Execute(os.Stdout, data)
    if err != nil {
        panic(err)
    }
}

• 模板go.tmpl写法：

{{.XStr}}

方法2：自定义模板函数（适配固定类型场景） #

如果需要在多个模板里复用格式化逻辑，可以注册自定义模板函数：

• Go代码侧逻辑：

package main

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

// 自定义格式化map的函数
func fmtMap(m map[string]bool) string {
    return fmt.Sprintf("x := %#v", m)
}

func main() {
    x := map[string]bool{"1":true,"2":true}
    // 注册自定义函数到模板
    tpl, err := template.New("go.tmpl").Funcs(template.FuncMap{
        "fmtMap": fmtMap,
    }).ParseFiles("go.tmpl")
    if err != nil {
        panic(err)
    }
    // 渲染输出
    err = tpl.Execute(os.Stdout, map[string]interface{}{
        "X": x,
    })
    if err != nil {
        panic(err)
    }
}

• 模板go.tmpl写法：

{{fmtMap .X}}

方法3：通用类型格式化函数（适配任意Go变量） #

如果需要支持struct、slice等任意类型的变量格式化，可以结合go/format包实现通用方案，输出的代码还会自动做规范格式化：

• Go代码侧逻辑：

package main

import (
    "text/template"
    "fmt"
    "os"
    "go/format"
)

// 通用格式化任意Go变量为变量定义语法
func fmtGoVar(varName string, v interface{}) (string, error) {
    rawStmt := fmt.Sprintf("%s := %#v", varName, v)
    // 用go/format做规范格式化，保证符合Go语法规范
    formattedStmt, err := format.Source([]byte(rawStmt))
    if err != nil {
        return "", err
    }
    return string(formattedStmt), nil
}

func main() {
    x := map[string]bool{"1":true,"2":true}
    // 注册自定义函数
    tpl, err := template.New("go.tmpl").Funcs(template.FuncMap{
        "fmtGoVar": fmtGoVar,
    }).ParseFiles("go.tmpl")
    if err != nil {
        panic(err)
    }
    // 渲染输出
    err = tpl.Execute(os.Stdout, map[string]interface{}{
        "X": x,
    })
    if err != nil {
        panic(err)
    }
}

• 模板go.tmpl写法：

{{fmtGoVar "x" .X}}

注意事项 #

如果使用的是html/template包，它会默认转义双引号等特殊字符，生成代码请优先使用text/template包，避免转义问题。

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