Go语言中html/template模块详细功能介绍与示例代码

 更新时间:2025年03月29日 10:39:00   作者:demonlg0112  
这篇文章主要介绍了Go语言中html/template模块详细功能介绍与示例代码,这里说的是go 语言中自带的包html/template里的一些基本操作,文中通过代码介绍的非常详细,需要的朋友可以参考下

Go语言的 html/template 模块是专门用于生成安全 HTML 输出的模板引擎,支持自动转义以防止 XSS 攻击。以下是该模块的核心方法及用法示例:

1. 基础模板解析与渲染

template.Parse 和 template.Execute

解析模板字符串并渲染数据。

package main

import (
    "html/template"
    "os"
)

func main() {
    // 定义模板字符串
    tmplStr := `<h1>{{.Title}}</h1><p>{{.Content}}</p>`

    // 解析模板
    tmpl, err := template.New("page").Parse(tmplStr)
    if err != nil {
        panic(err)
    }

    // 定义数据
    data := struct {
        Title   string
        Content string
    }{
        Title:   "欢迎页面",
        Content: "这是安全渲染的内容!",
    }

    // 渲染并输出到标准输出
    err = tmpl.Execute(os.Stdout, data)
    if err != nil {
        panic(err)
    }
}

输出结果

<h1>欢迎页面</h1><p>这是安全渲染的内容!</p>

2. 从文件加载模板

template.ParseFiles

从多个文件加载模板,支持模板继承和嵌套。

// 文件: templates/header.html
{{ define "header" }}<header>{{.SiteName}}</header>{{ end }}

// 文件: templates/page.html
{{ define "page" }}
<!DOCTYPE html>
<html>
  {{ template "header" . }}
  <body>
    <h1>{{.Title}}</h1>
  </body>
</html>
{{ end }}
func main() {
    // 解析多个模板文件
    tmpl, err := template.ParseFiles(
        "templates/header.html",
        "templates/page.html",
    )
    if err != nil {
        panic(err)
    }

    // 渲染数据
    data := struct {
        SiteName string
        Title    string
    }{
        SiteName: "我的网站",
        Title:    "主页",
    }

    // 指定使用 "page" 模板渲染
    err = tmpl.ExecuteTemplate(os.Stdout, "page", data)
}

输出结果

<!DOCTYPE html>
<html>
  <header>我的网站</header>
  <body>
    <h1>主页</h1>
  </body>
</html>

3. 自动转义与安全内容

自动转义 XSS 内容

默认情况下,所有变量内容会被转义。

data := struct {
    UserInput string
}{
    UserInput: "<script>alert('xss')</script>",
}

tmplStr := `<div>{{.UserInput}}</div>`
tmpl, _ := template.New("test").Parse(tmplStr)
tmpl.Execute(os.Stdout, data)

输出结果

<div>&lt;script&gt;alert(&#39;xss&#39;)&lt;/script&gt;</div>

信任原始 HTML

使用 template.HTML 类型标记安全内容。

data := struct {
    SafeContent template.HTML
}{
    SafeContent: template.HTML("<b>加粗文本</b>"),
}

tmplStr := `<div>{{.SafeContent}}</div>`
tmpl, _ := template.New("test").Parse(tmplStr)
tmpl.Execute(os.Stdout, data)

输出结果

<div><b>加粗文本</b></div>

4. 自定义模板函数

Funcs 与 template.FuncMap

注册自定义函数到模板中。

func main() {
    // 定义自定义函数
    funcMap := template.FuncMap{
        "safeHTML": func(s string) template.HTML {
            return template.HTML(s)
        },
    }

    // 创建模板并注册函数
    tmplStr := `<div>{{. | safeHTML}}</div>`
    tmpl := template.New("test").Funcs(funcMap)
    tmpl, _ = tmpl.Parse(tmplStr)

    // 渲染数据
    tmpl.Execute(os.Stdout, "<em>斜体文本</em>")
}

输出结果

<div><em>斜体文本</em></div>

5. 条件判断与循环

if 和 range 语法

在模板中实现逻辑控制。

data := struct {
    ShowHeader bool
    Items      []string
}{
    ShowHeader: true,
    Items:      []string{"Go", "Python", "Java"},
}

tmplStr := `
{{ if .ShowHeader }}<h1>列表</h1>{{ end }}
<ul>
{{ range .Items }}
  <li>{{ . }}</li>
{{ end }}
</ul>
`

tmpl, _ := template.New("list").Parse(tmplStr)
tmpl.Execute(os.Stdout, data)

输出结果

<h1>列表</h1>
<ul>
  <li>Go</li>
  <li>Python</li>
  <li>Java</li>
</ul>

6. 嵌套模板与块定义

define 和 template 指令

复用模板片段。

// 定义基础模板
tmplStr := `
{{ define "layout" }}
<!DOCTYPE html>
<html>
  <head>{{ template "title" }}</head>
  <body>{{ template "content" . }}</body>
</html>
{{ end }}

{{ define "title" }}<title>默认标题</title>{{ end }}

{{ define "content" }}<p>默认内容</p>{{ end }}
`

// 覆盖部分块
customTmplStr := `
{{ define "content" }}<h1>{{.Message}}</h1>{{ end }}
`

// 解析模板
tmpl, _ := template.New("base").Parse(tmplStr)
tmpl, _ = tmpl.Parse(customTmplStr)

// 渲染数据
data := struct{ Message string }{Message: "自定义内容"}
tmpl.ExecuteTemplate(os.Stdout, "layout", data)

输出结果

<!DOCTYPE html>
<html>
  <head><title>默认标题</title></head>
  <body><h1>自定义内容</h1></body>
</html>

总结

  • 安全性:自动转义 HTML 特殊字符,防止 XSS 攻击。
  • 核心方法ParseParseFilesExecuteFuncs
  • 高级功能
    • 嵌套模板(define 和 template)。
    • 条件与循环(ifrange)。
    • 自定义函数(Funcs)。
  • 适用场景:动态生成安全 HTML 页面,如 Web 应用的后端渲染。

到此这篇关于Go语言中html/template模块详细功能介绍与示例代码的文章就介绍到这了,更多相关Go语言html/template模块内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • golang-gin-mgo高并发服务器搭建教程

    golang-gin-mgo高并发服务器搭建教程

    这篇文章主要介绍了golang-gin-mgo高并发服务器搭建教程,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • Golang算法之田忌赛马问题实现方法分析

    Golang算法之田忌赛马问题实现方法分析

    这篇文章主要介绍了Golang算法之田忌赛马问题实现方法,结合具体实例形式分析了基于Go语言的田忌赛马问题原理与算法实现技巧,需要的朋友可以参考下
    2017-02-02
  • Go语言struct类型介绍

    Go语言struct类型介绍

    这篇文章主要介绍了Go语言struct类型介绍,本文讲解了struct的2种声明方式,struct的匿名字段等内容,需要的朋友可以参考下
    2015-01-01
  • Go语言学习之将mp4通过rtmp推送流媒体服务的实现方法

    Go语言学习之将mp4通过rtmp推送流媒体服务的实现方法

    对音视频一直是小白,决定沉下心来,好好研究一下音视频知识,下面这篇文章主要给大家介绍了关于Go语言学习之将mp4通过rtmp推送流媒体服务的实现方法,需要的朋友可以参考下
    2022-12-12
  • Go语言实现权重抽奖系统的项目实践

    Go语言实现权重抽奖系统的项目实践

    本文主要介绍了Go语言实现权重抽奖系统的项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-04-04
  • 浅析Go中fasthttp与net/http的性能对比及应用

    浅析Go中fasthttp与net/http的性能对比及应用

    这篇文章主要为大家详细介绍了Golang中fasthttp的底层实现以及与net/http的区别,下面就跟随小编一起来看看fasthttp到底是如何做到性能如此之快的吧
    2024-03-03
  • 基于golang的简单分布式延时队列服务的实现

    基于golang的简单分布式延时队列服务的实现

    这篇文章主要介绍了基于golang的简单分布式延时队列服务的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-02-02
  • Go语言单链表实现方法

    Go语言单链表实现方法

    这篇文章主要介绍了Go语言单链表实现方法,实例分析了基于Go语言的单链表实现原理与使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-03-03
  • 基于golang如何实现error工具包详解

    基于golang如何实现error工具包详解

    Go 语言使用 error 类型来返回函数执行过程中遇到的错误,下面这篇文章主要给大家介绍了关于如何基于golang实现error工具包的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2018-09-09
  • Golang实现Java虚拟机之解析class文件详解

    Golang实现Java虚拟机之解析class文件详解

    这篇文章主要为大家详细介绍了Golang实现Java虚拟机之解析class文件的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-01-01

最新评论