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模块内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅析Go汇编语法和MatrixOne使用介绍

    浅析Go汇编语法和MatrixOne使用介绍

    MatrixOne由Go语言所开发是一个新一代超融合异构数据库,致力于打造单一架构处理TP、AP、流计算等多种负载的极简大数据引擎,今天通过本文给大家介绍Go汇编语法和MatrixOne使用,感兴趣的朋友一起看看吧
    2022-04-04
  • 用Go+WebSocket快速实现一个chat服务

    用Go+WebSocket快速实现一个chat服务

    这篇文章主要介绍了用Go+WebSocket快速实现一个chat服务,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • Golang使用第三方包viper读取yaml配置信息操作

    Golang使用第三方包viper读取yaml配置信息操作

    这篇文章主要介绍了Golang使用第三方包viper读取yaml配置信息操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • go语言变量定义用法实例

    go语言变量定义用法实例

    这篇文章主要介绍了go语言变量定义用法,实例分析了go语言变量的定义及使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-02-02
  • golang中go race使用

    golang中go race使用

    本文介绍了Go语言中处理多线程/协程安全问题的方法,重点讲解了-race参数的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-12-12
  • Go语言io pipe源码分析详情

    Go语言io pipe源码分析详情

    这篇文章主要介绍了Go语言io pipe源码分析详情,pipe是一个适配器,用于连接Reader和Writer,pipe的方法不多,新的写法却不少,并且结构体分两块,读写信道和结束标识,下面进入文章了解具体的内容吧
    2022-02-02
  • Go连接并操作SQLite数据库基本步骤

    Go连接并操作SQLite数据库基本步骤

    在这篇文章中,我们将详细描述如何在 Go 语言中使用 SQLite 数据库,我们将会从如何在 Go 中安装和使用 SQLite 驱动包开始讲起,然后逐步介绍如何创建数据库连接,执行 SQL 查询,处理返回的数据以及关闭数据库连接
    2024-01-01
  • GO语言获取系统环境变量的方法

    GO语言获取系统环境变量的方法

    这篇文章主要介绍了GO语言获取系统环境变量的方法,实例分析了Getenv方法操作环境变量的技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-02-02
  • golang 防缓存击穿singleflight的实现

    golang 防缓存击穿singleflight的实现

    本文主要介绍了golang 防缓存击穿singleflight的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • 一文带你了解Go语言中的单元测试

    一文带你了解Go语言中的单元测试

    写过单元测试的开发人员应该理解,单元测试最核心的价值是为了证明:为什么我写的代码是正确的?也就是从逻辑角度帮你检查你的代码。本文就来和大家详细聊聊Go语言中的单元测试,需要的可以参考一下
    2022-07-07

最新评论