一、为什么需要模板引擎

在日常开发中，我们经常需要动态生成 HTML 页面、邮件内容、配置文件等。如果每次都手动拼接字符串，不仅代码难以维护，而且容易出错。这时候，模板引擎就派上用场了。

Go 语言内置了一个强大的模板引擎 text/template 和 html/template，它们可以帮助我们轻松实现动态内容的生成。text/template 适用于纯文本，而 html/template 在它的基础上增加了 HTML 转义功能，防止 XSS 攻击。

二、Go 模板引擎基础语法

Go 的模板语法非常直观，主要包含以下几个部分：

  1. 变量渲染：{{.VariableName}}
  2. 条件判断：{{if .Condition}} ... {{else}} ... {{end}}
  3. 循环遍历：{{range .Items}} ... {{end}}
  4. 函数调用：{{funcName .Arg1 .Arg2}}
  5. 模板嵌套：{{template "name" .}}

下面是一个简单的例子：

package main

import (
	"os"
	"text/template"
)

func main() {
	// 定义模板
	tmpl := `
		Hello, {{.Name}}!
		{{if .IsVIP}}
			You are a VIP user!
		{{else}}
			Welcome, new user!
		{{end}}
		Your recent orders:
		{{range .Orders}}
			- {{.}}
		{{end}}
	`

	// 准备数据
	data := struct {
		Name   string
		IsVIP  bool
		Orders []string
	}{
		Name:   "Alice",
		IsVIP:  true,
		Orders: []string{"Order1", "Order2", "Order3"},
	}

	// 解析模板
	t := template.Must(template.New("greeting").Parse(tmpl))

	// 渲染并输出
	t.Execute(os.Stdout, data)
}

运行结果：

Hello, Alice!
You are a VIP user!
Your recent orders:
- Order1
- Order2
- Order3

三、HTML 模板与安全防护

在 Web 开发中，直接拼接 HTML 容易导致 XSS（跨站脚本攻击）。Go 的 html/template 会自动对变量进行转义，确保安全性。

package main

import (
	"html/template"
	"os"
)

func main() {
	// 定义 HTML 模板
	tmpl := `
		<!DOCTYPE html>
		<html>
		<head>
			<title>{{.Title}}</title>
		</head>
		<body>
			<h1>{{.Heading}}</h1>
			<p>{{.Content}}</p>
		</body>
		</html>
	`

	// 准备数据（包含恶意脚本）
	data := struct {
		Title   string
		Heading string
		Content string
	}{
		Title:   "XSS Test",
		Heading: "Welcome!",
		Content: "<script>alert('Hacked!')</script>",
	}

	// 解析并渲染
	t := template.Must(template.New("webpage").Parse(tmpl))
	t.Execute(os.Stdout, data)
}

输出结果：

<!DOCTYPE html>
<html>
<head>
	<title>XSS Test</title>
</head>
<body>
	<h1>Welcome!</h1>
	<p>&lt;script&gt;alert(&#39;Hacked!&#39;)&lt;/script&gt;</p>
</body>
</html>

可以看到，<script> 标签被自动转义，不会被执行。

四、高级用法：自定义函数与嵌套模板

Go 模板引擎支持自定义函数，我们可以扩展它的功能。

package main

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

func main() {
	// 注册自定义函数
	funcMap := template.FuncMap{
		"formatDate": func(t time.Time) string {
			return t.Format("2006-01-02")
		},
	}

	// 定义模板（使用自定义函数）
	tmpl := `
		Today is {{formatDate .Now}}.
		{{template "footer"}}
	`

	// 定义子模板
	footer := `
		{{define "footer"}}
		<footer>© 2023 My App</footer>
		{{end}}
	`

	// 解析模板
	t := template.Must(template.New("main").Funcs(funcMap).Parse(tmpl))
	template.Must(t.Parse(footer))

	// 渲染
	t.Execute(os.Stdout, struct{ Now time.Time }{Now: time.Now()})
}

运行结果：

Today is 2023-10-05.
<footer>© 2023 My App</footer>

五、应用场景分析

  1. Web 页面渲染：动态生成 HTML，适用于博客、电商网站等。
  2. 邮件模板：批量发送个性化邮件。
  3. 配置文件生成：根据环境变量动态生成 Kubernetes YAML 或 Nginx 配置。
  4. 代码生成：自动化生成重复性代码，如 CRUD 接口。

六、技术优缺点

优点：

  • 语法简单，学习成本低。
  • 内置安全防护（HTML 转义）。
  • 支持自定义函数和模板嵌套。

缺点：

  • 错误信息不够友好，调试较麻烦。
  • 复杂逻辑处理能力有限，不适合做业务计算。

七、注意事项

  1. 避免在模板中写复杂逻辑，尽量在 Go 代码中处理数据。
  2. 注意模板缓存，避免重复解析影响性能。
  3. 谨慎使用 template.JS 等免转义函数，确保数据来源可信。

八、总结

Go 的模板引擎是一个非常实用的工具，特别适合动态生成 HTML 和文本内容。它简单易用，安全性高，适用于多种场景。虽然它在复杂逻辑处理上稍显不足，但结合自定义函数和模板嵌套，仍然可以满足大部分需求。