本文共 2843 字，大约阅读时间需要 9 分钟。

Go语言开发利器——Quicktemplate模板引擎

简介

最近在整理项目代码时，我发现各个功能模块的代码结构与提供的功能很相似。为减少重复劳动，本人编写了一个生成代码框架的工具。但在这个过程中，我发现 Go 标准库的 text/template 和 html/template 相对不够方便。寻找合适的替代方案后，我了解到 quicktemplate 这个第三方模板库。经过使用体验，发现它功能强大且语法简洁，非常适合我们的项目需求。下面，我将从安装、使用、语法等方面详细介绍 quicktemplate 的使用方法。

快速开始

1. 安装工具

quicktemplate 是一个 Go 模板引擎，它可以将模板文件转换为 Go 代码。需要先安装 quicktemplate 和 qtc 编译器。

go get -u github.com/valyala/quicktemplatego get -u github.com/valyala/quicktemplate/qtc

2. 编写模板

模板文件以 .qtpl 为扩展名。创建一个简单的示例模板 greeting.qtpl：

{% func Greeting(name string, count int) %}    Hello, {%s name %}{{% for i := 0; i < count; i++ %}} Hello{% endfor %}{% endfunc %}{% endfunc %}

3. 使用模板

将模板文件存放在 templates 设定目录下，运行 qtc 生成对应的 Go 文件：

qtc

生成的 Go 文件包含一个 Greeting 函数，可以直接调用：

package mainimport (	"github.com/darjun/go-daily-lib/quicktemplate/templates")func main() {	templates.Greeting("dj", 5)}

运行程序输出结果：

Hello, djHello, djHello, djHello, djHello, dj

语法结构

quicktemplate 的语法与 Go 代码写作风格非常相似，学习成本低。常用的语法包括 if、for、func 等，并需用 {%...%} 包裹模板标签。

• 模板函数：类似 Go 函数，接受任意参数，且函数外的文本被视为注释。
• 循环语法：{% for %} 和 endfor 用于循环，{% range %} 支持遍历可迭代对象。
• 条件语法：支持 if 和 else，需用 endif 标记结束。

示例：渲染不同类型的数据

编写一个 types.qtpl 模板：

{% func Types(a int, b float64, c []byte, d string) %}	int: {%d a %}, float64: {%f.2 b %}, "bytes: {%z c %}, string with quotes: {%q d %}	string without quotes: {%j d %}{% endfunc %}

使用模板调用：

func main() {	templates.Types(1, 5.75, []byte{'a', 'b', 'c'}, "hello")}

输出结果：

int: 1, float64: 5.75, bytes: abc, string with quotes: "hello", string without quotes: hello

调用自定义函数

quicktemplate 支持在模板中调用其他模板或自定义函数。例如，创建一个 rank.go 文件定义评分函数：

package templatesfunc Rank(score int) string {	if score > 90 {		return "A"	} else if score > 80 {		return "B"	} else if score > 70 {		return "C"	} else if score > 60 {		return "D"	} else {		return "E"	}}

在模板中调用：

{% func ScoreList(name2score map[string]int) %}	{% for name, score := range name2score %}		{%s fmt.Sprintf("%s: score-%d rank-%s", name, score, Rank(score)) %}	{% endfor %}{% endfunc %}

生成的 Go 文件包含 ScoreList 函数，支持传入参数渲染结果：

func main() {	name2score := make(map[string]int)	name2score["dj"] = 85	name2score["lizi"] = 96	name2score["hjw"] = 52	templates.ScoreList(name2score)}

输出结果：

dj: score-85 rank-Blizi: score-96 rank-Ahjw: score-52 rank-E

Web 应用开发

quicktemplate 在 Web 开发中的应用也非常方便。编写一个简单的 index.qtpl 模板：

{% func Index(name string) %}	
Hi, {%s name %}
	
Welcome to the awesome web!!!
{% endfunc %}

创建一个 Web 服务器：

func index(w http.ResponseWriter, r *http.Request) {	templates.WriteIndex(w, r.FormValue("name"))}func main() {	mux := http.NewServeMux()	mux.HandleFunc("/", index)	server := &http.Server{		Handler: mux,		Addr: ":8080",	}	log.Fatal(server.ListenAndServe())}

运行程序后，访问 localhost:8080?name=dj 查看结果。

总结

quicktemplate 的优势在于：

对于开发人员来说，quicktemplate 是一个极其实用的工具，特别适合需要快速生成代码的场景。

转载地址：http://uoeyk.baihongyu.com/