写点什么

Go Web 编程入门:Go pongo2 模板引擎

作者:宇宙之一粟
  • 2022 年 5 月 16 日
  • 本文字数:2937 字

    阅读完需:约 10 分钟

Go Web 编程入门:Go pongo2 模板引擎

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-0d938eb266f3go: downloading github.com/flosch/pongo2/v4 v4.0.2go: downloading gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05bgo: downloading github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8ego: downloading github.com/kr/text v0.1.0go: 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 的字节中读取。


文档使用 ExecuteExecuteWriterExecuteBytes 函数呈现。这些函数接受一个上下文,它为模板提供常量、变量、实例或函数。


从字符串中读取模板

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)}
复制代码


  1. 要打印的变量放在 {{ }} 括号内。

tpl, err := pongo2.FromString("Hello {{ name }}!")
复制代码


  1. 接着,我们使用 Execute 渲染最终的字符串。在上下文中,我们为 name 变量传递一个值 “宇宙之一粟”:

res, err := tpl.Execute(pongo2.Context{"name": "宇宙之一粟"})
复制代码


  1. 最后,运行该代码:

$ 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 函数,我们从文件中读取模板。

  1. 新建一个 test.tpl 模板文件:

{{ name }}是{{ occupation }}
复制代码
  1. 该示例生成一条简单的消息,同时从文件中读取模板。写好 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宇宙之一粟是不掉发的程序猿
复制代码

Go pongo2 迭代

for 语句用于迭代模板中的数据集合。

  1. 新建一个 words.tpl 文件:

{% for word in words -%}    {{ word }}{% endfor %}
复制代码
  1. 在模板中,我们使用 for 指令来遍历 words 数据结构的元素。可以用 - 字符去除空白字符。

package main
import ( "fmt" "github.com/flosch/pongo2/v4" "log")
func main() {
tpl, err := pongo2.FromFile("words.tpl")
if err != nil { log.Fatal(err) }
words := []string{"只要", "对", "编码", "保持", "热爱", "!"}
ctx := pongo2.Context{"words": words}
res, err := tpl.Execute(ctx)
if err != nil { log.Fatal(err) }
fmt.Println(res)}
复制代码

在程序中,我们将一段单词传递给 tempate 引擎。我们得到一个单词列表作为输出。

$ go run main.go只要编码保持热爱!
复制代码

Go pongo2 过滤

可以将过滤器应用于数据以修改它们。在 | 之后应用过滤器特点。

  1. 更改 words.tpl 文件

{% for word in words -%}    {{ word }} has {{ word | length }} characters{% endfor %}
复制代码
  1. main 文件:

package main
import ( "fmt" "github.com/flosch/pongo2/v4" "log")
func main() {
tpl, err := pongo2.FromFile("words.tpl")
if err != nil { log.Fatal(err) }
words := []string{"只要", "对", "编码", "保持", "热爱", "!"}
ctx := pongo2.Context{"words": words}
res, err := tpl.Execute(ctx)
if err != nil { log.Fatal(err) }
fmt.Println(res)}
复制代码
  1. 在程序中,我们将一段单词传递给模板。我们打印每个单词及其大小。运行该程序:

只要 has 2 characters对 has 1 characters编码 has 2 characters保持 has 2 characters热爱 has 2 characters! has 1 characters
复制代码

Go pongo2 条件

可以使用 if/endif 指令创建条件。

  1. 新建一个 todo.tpl 文件:


{% for todo in todos -%}    {% if todo.Done %}        {{- todo.Title -}}    {% endif %}{% endfor %}
复制代码

在模板文件中,我们使用 if 指令仅输出已完成的任务。


  1. 我们从一片待办事项中生成输出。在输出中,我们仅包含已完成的任务。

package main
import ( "fmt" "github.com/flosch/pongo2/v4" "log")
type Todo struct { Title string Done bool}
type Data struct { Todos []Todo}
func main() {
tpl, err := pongo2.FromFile("todo.tpl")
if err != nil { log.Fatal(err) }
todos := []Todo{ {Title: "看书一小时", Done: false}, {Title: "写代码五小时", Done: true}, {Title: "吃饭三餐", Done: true}, {Title: "不加班", Done: false}, {Title: "日更写文章", Done: true}, }
ctx := pongo2.Context{"todos": todos}
res, err := tpl.Execute(ctx)
if err != nil { log.Fatal(err) }
fmt.Println(res)}
复制代码
  1. 运行代码:

$ go run main.go
写代码五小时吃饭三餐
日更写文章


复制代码

总结

这篇文章介绍了第三方模板库 pongo2,pongo2 是一种类似于 Django 语法的 Go 的模板语言。并介绍了从字符串和文件中两种方式获取文本,并介绍了 pongo2 的迭代、过滤和 if 条件的使用,并给出了每个代码案例,希望能对你有帮助。关于 pongo2 的更多用法请参考官方链接,还有更多基于 pongo2 的第三方扩展库,都值得一看,哪个方便用哪个。


感谢阅读,下一篇文章再见~


参考链接:

发布于: 刚刚阅读数: 3
用户头像

宇宙古今无有穷期,一生不过须臾,当思奋争 2020.05.07 加入

🏆InfoQ写作平台-第二季签约作者 🏆 混迹于江湖,江湖却没有我的影子 热爱技术,专注于后端全栈,轻易不换岗 拒绝内卷,工作于软件工程师,弹性不加班 热衷分享,执着于阅读写作,佛系不水文

评论

发布
暂无评论
Go Web 编程入门:Go pongo2 模板引擎_Go web_宇宙之一粟_InfoQ写作社区