如何在Gin Gonic的HTTP响应处理器中实现模板嵌套？

背景 #

Go标准库的template.Template提供了Execute方法，支持通过引用其他模板实现嵌套，示例代码：

template.Template.Execute("base", data)

问题 #

Gin中常规的HTML响应写法如下，看起来无法直接像标准库那样引用其他模板实现嵌套：

func about(c *gin.Context) {
    c.HTML(http.StatusOK, "about.tmpl", gin.H{})
}

实现方法 #

Gin底层基于Go标准库的模板系统，只需正确加载模板并定义模板结构，就能实现嵌套功能，具体步骤如下：

1. 定义模板文件结构 #

创建基础模板base.tmpl，预留子模板的嵌入位置：

<!DOCTYPE html>
<html>
<head>
    <title>{{.Title}}</title>
</head>
<body>
    {{template "content" .}}
</body>
</html>

创建子模板about.tmpl，通过define声明模板块：

{{define "content"}}
    <h1>关于页面</h1>
    <p>这是嵌套在基础模板里的内容</p>
{{end}}

2. 加载所有模板文件 #

在Gin初始化阶段，加载基础模板和所有关联的子模板：

func main() {
    r := gin.Default()
    // 加载templates目录下所有tmpl文件（包含base和子模板）
    r.LoadHTMLGlob("templates/*.tmpl")
    // 也可指定具体文件：r.LoadHTMLFiles("templates/base.tmpl", "templates/about.tmpl")
    
    r.GET("/about", about)
    r.Run()
}

3. 在处理器中渲染基础模板 #

修改处理器逻辑，渲染基础模板base.tmpl，子模板的内容会自动嵌入到对应位置：

func about(c *gin.Context) {
    c.HTML(http.StatusOK, "base.tmpl", gin.H{
        "Title": "关于我们",
    })
}

补充：子模板独立传参 #

如果需要给子模板单独传递数据，可以在引用时指定参数：

{{template "content" .SubData}}

对应处理器中传入嵌套数据：

c.HTML(http.StatusOK, "base.tmpl", gin.H{
    "Title": "关于我们",
    "SubData": gin.H{
        "Content": "自定义子模板内容",
    },
})

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