golang 的 template 库分为 text/template 和 html/template,前者用于通用文本模板,后者专为 html 设计并具备安全防护机制。1. 使用 text/template 时,通过定义模板、准备数据结构、解析并执行填充来生成文本输出,适用于配置文件、日志格式等场景;2. html/template 会自动进行 html 转义,防止 xss 攻击,并根据上下文选择合适的转义方式,适合网页内容渲染;3. 两者 api 类似,但适用场景不同:text/template 常用于生成配置文件、命令行输出等非 html 文本,html/template 则用于 web 页面、邮件 html 内容等涉及浏览器展示的场景;4. 使用过程中需注意字段必须首字母大写才可被访问,支持嵌套结构和控制语句,但建议避免复杂逻辑,并可通过 define 和 block 实现模板继承与组合。

Golang 的 template 库是标准库中非常实用的一个工具,可以用来生成文本输出,比如 HTML 页面、配置文件、邮件内容等。它分为两个包:text/template 和 html/template,前者用于通用文本模板,后者专为 HTML 设计,做了安全防护。

如果你只是想做简单的文本替换,或者动态生成配置文件之类的内容,用 text/template 就足够了;而如果是在网页开发中渲染 HTML 页面,则推荐使用 html/template,因为它能自动处理 HTML 转义,防止 XSS 攻击。

1. 如何使用 text/template 实现文本模板
text/template 是 Go 中最基础的模板引擎,适用于各种文本格式的生成,比如日志格式、配置文件、命令行输出等。
立即学习“go语言免费学习笔记(深入)”;
基本步骤如下:

- 定义模板字符串或从文件加载
- 准备数据结构(struct 或 map)
- 解析模板并执行填充
举个例子,假设你想生成一段用户信息文本:
package main
import (
"os"
"text/template"
)
type User struct {
Name string
Age int
}
func main() {
const userTpl = "Name: {{.Name}}\nAge: {{.Age}}\n"
t := template.Must(template.New("user").Parse(userTpl))
user := User{Name: "Alice", Age: 30}
_ = t.Execute(os.Stdout, user)
}输出结果就是:
Name: Alice Age: 30
这个过程很直接,核心在于模板语法和传入的数据结构是否匹配。
2. html/template 与 text/template 的区别
虽然两者 API 类似,但它们的用途和安全性设计不同。
-
HTML 转义机制:
html/template在输出时会自动对变量进行 HTML 转义,防止 XSS 漏洞。 - 上下文感知:它可以根据当前 HTML 上下文(如标签属性、JS 字符串等)自动选择合适的转义方式。
-
禁止执行任意函数:为了安全,
html/template对模板中调用函数有更多限制。
例如,在 HTML 模板中插入一个用户名:
package main
import (
"html/template"
"os"
)
func main() {
const htmlTpl = `Hello, {{.Name}}
`
t := template.Must(template.New("page").Parse(htmlTpl))
data := struct{ Name string }{"Alice"}
_ = t.Execute(os.Stdout, data)
}输出结果不会显示加粗的 “Alice”,而是原样显示 HTML 标签,并被自动转义成安全字符:
Hello, zuojiankuohaophpcnbyoujiankuohaophpcnAlicezuojiankuohaophpcn/byoujiankuohaophpcn
这种安全机制在 Web 开发中非常重要。
3. 文本模板 vs HTML 模板的应用场景
理解两者的适用范围,有助于在项目中做出合理选择。
使用 text/template 的常见场景:
- 生成配置文件(如 Nginx 配置、YAML 文件)
- 构建命令行工具的输出格式
- 发送纯文本邮件
- 日志模板化处理
使用 html/template 的常见场景:
- 渲染网页内容(MVC 框架中的 View 层)
- 构建邮件 HTML 内容(需注意样式兼容性)
- 动态生成 PDF 报告(结合 HTML 转 PDF 工具)
简单来说,只要涉及浏览器展示的内容,就优先考虑 html/template,其他情况可以用 text/template。
4. 常见问题和注意事项
- 字段导出问题:模板只能访问结构体中首字母大写的字段(即公开字段),否则会被忽略。
-
嵌套结构支持:可以通过
{{.User.Name}}这样的方式访问嵌套字段。 - 控制语句使用:模板支持 if、range 等逻辑控制,但不建议写太复杂的逻辑。
-
模板继承与组合:支持通过
define和block来定义子模板,适合大型项目组织模板结构。
总的来说,Go 的模板系统虽然不像某些框架那样强大,但它轻量、标准、易用,尤其适合服务端生成静态内容的场景。根据需求选择合适的模板类型,就能很好地完成任务。基本上就这些,不复杂但容易忽略细节。











