Go pongo2 教程展示了如何使用 pongo2 模板引擎在 Golang 中使用模板。
模板引擎是一个库,旨在将模板与数据结合起来以生成文档。模板引擎用于生成大量电子邮件、源代码预处理或生成动态 HTML 页面。
模板由静态数据和动态区域组成。动态区域稍后被数据替换。渲染函数稍后将模板与数据结合起来。模板引擎用于将模板与数据模型相结合以生成文档。
pongo2 库是一个受 Django 模板引擎启发的 Go 模板引擎。
下载 pongo2 函数库
使用如下命令:
go get -u github.com/flosch/pongo2/v4
安装成功后可以看到如下输出:
go: downloading github.com/flosch/pongo2 v0.0.0-20200913210552-0d938eb266f3 go: downloading github.com/flosch/pongo2/v4 v4.0.2 go: downloading gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b go: downloading github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e go: downloading github.com/kr/text v0.1.0 go: added github.com/flosch/pongo2/v4 v4.0.2
pongo2 在模板字符串中使用了各种分隔符:
{% %}
- statements{{ }}
- expressions to print to the template output{# #}
- comments which are not included in the template output# ##
- line statements
模板可以从带有 pongo2.FromString
的字符串、带有 pongo2.FromFile
的文件或带有pongo2.FromBytes
的字节中读取。
文档使用 Execute
、ExecuteWriter
或 ExecuteBytes
函数呈现。这些函数接受一个上下文,它为模板提供常量、变量、实例或函数。
从字符串中读取模板
pongo2.FromString
函数从字符串中读取模板。如下代码将生成一条简单的文本消息:
package main import ( "fmt" "github.com/flosch/pongo2/v4" "log" ) func main() { tpl, err := pongo2.FromString("Hello {{ name }}~") if err != nil { log.Fatal(err) } res, err := tpl.Execute(pongo2.Context{"name": "宇宙之一粟"}) if err != nil { log.Fatal(err) } fmt.Println(res) }
- 要打印的变量放在
{{ }}
括号内。
tpl, err := pongo2.FromString("Hello {{ name }}!")
- 接着,我们使用 Execute 渲染最终的字符串。在上下文中,我们为 name 变量传递一个值 “宇宙之一粟”:
res, err := tpl.Execute(pongo2.Context{"name": "宇宙之一粟"})
- 最后,运行该代码:
$ go run main.go Hello 宇宙之一粟~
如下图:
再来看一个例子,我们可以传递两个文本:
package main import ( "fmt" "github.com/flosch/pongo2/v4" "log" ) func main() { tpl, err := pongo2.FromString("{{ name }}是{{ occupation }}") if err != nil { log.Fatal(err) } name, occupation := "宇宙之一粟", "程序猿👨💻" ctx := pongo2.Context{"name": name, "occupation": occupation} res, err := tpl.Execute(ctx) if err != nil { log.Fatal(err) } fmt.Println(res) }
运行该代码:
$ go run main.go 宇宙之一粟是程序猿👨💻
从文件中读取文本
使用 pongo2.FromFile
函数,我们从文件中读取模板。
- 新建一个
test.tpl
模板文件:
{{ name }}是{{ occupation }}
- 该示例生成一条简单的消息,同时从文件中读取模板。写好
main.go
文件:
package main import ( "fmt" "github.com/flosch/pongo2/v4" "log" ) func main() { tpl, err := pongo2.FromFile("test.tpl") if err != nil { log.Fatal(err) } name, occupation := "宇宙之一粟", "不掉发的程序猿" ctx := pongo2.Context{"name": name, "occupation": occupation} res, err := tpl.Execute(ctx) if err != nil { log.Fatal(err) } fmt.Println(res) }
运行该程序:
$ go run main.go 宇宙之一粟是不掉发的程序猿