Go每日一库之quicktemplate的使用

目录
  • 简介
  • 快速使用
  • 语法结构
    • 变量
    • 调用函数
  • Web
  • 总结
  • 参考

简介

最近在整理我们项目代码的时候，发现有很多活动的代码在结构和提供的功能上都非常相似。为了方便今后的开发，我花了一点时间编写了一个生成代码框架的工具，最大程度地降低重复劳动。代码本身并不复杂，且与项目代码关联性较大，这里就不展开介绍了。在这个过程中，我发现 Go 标准的模板库text/template和html/template使用起来比较束手束脚，很不方便。我从 GitHub 了解到quicktemplate这个第三方模板库，功能强大，语法简单，使用方便。今天我们就来介绍一下quicktemplate。

快速使用

本文代码使用 Go Modules。

先创建代码目录并初始化：

$ mkdir quicktemplate && cd quicktemplate
$ go mod init github.com/darjun/go-daily-lib/quicktemplate

quicktemplate会将我们编写的模板代码转换为 Go 语言代码。因此我们需要安装quicktemplate包和一个名为qtc的编译器：

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

首先，我们需要编写quicktemplate格式的模板文件，模板文件默认以.qtpl作为扩展名。下面我编写了一个简单的模板文件greeting.qtpl：

All text outside function is treated as comments.

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

模板语法非常简单，我们只需要简单了解以下 2 点：

  • 模板以函数为单位，函数可以接受任意类型和数量的参数，这些参数可以在函数中使用。所有函数外的文本都是注释，qtc编译时会忽视注释；
  • 函数内的内容，除了语法结构，其他都会原样输出到渲染后的文本中，包括空格和换行。

将greeting.qtpl保存到templates目录，然后执行qtc命令。该命令会生成对应的 Go 文件greeting.qtpl.go，包名为templates。现在，我们就可以使用这个模板了：

package main

import (
  "fmt"

  "github.com/darjun/go-daily-lib/quicktemplate/get-started/templates"
)

func main() {
  fmt.Println(templates.Greeting("dj", 5))
}

调用模板函数，传入参数，返回渲染后的文本：

$ go run .
    Hello, dj

Hello, dj

Hello, dj

Hello, dj

Hello, dj

{%s name %}执行文本替换，{% for %}循环生成重复文本。输出中出现多个空格和换行，这是因为函数内除了语法结构，其他内容都会原样保留，包括空格和换行。

需要注意的是，由于quicktemplate是将模板转换为 Go 代码使用的，所以如果模板有修改，必须先执行qtc命令重新生成 Go 代码，否则修改不生效。

语法结构

quicktemplate支持 Go 常见的语法结构，if/for/func/import/return。而且写法与直接写 Go 代码没太大的区别，几乎没有学习成本。只是在模板中使用这些语法时，需要使用{%和%}包裹起来，而且if和for等需要添加endif/endfor明确表示结束。

变量

上面我们已经看到如何渲染传入的参数name，使用{%s name %}。由于name是 string 类型，所以在{%后使用s指定类型。quicktemplate还支持其他类型的值：

  • 整型：{%d int %}，{%dl int64 %}，{%dul uint64 %}；
  • 浮点数：{%f float %}。还可以设置输出的精度，使用{%f.precision float %}。例如{%f.2 1.2345 %}输出1.23；
  • 字节切片（[]byte）：{%z bytes %}；
  • 字符串：{%q str %}或字节切片：{%qz bytes %}，引号转义为&quot;；
  • 字符串：{%j str %}或字节切片：{%jz bytes %}，没有引号；
  • URL 编码：{%u str %}，{%uz bytes %}；
  • {%v anything %}：输出等同于fmt.Sprintf("%v", anything)。

先编写模板：

{% 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() {
  fmt.Println(templates.Types(1, 5.75, []byte{'a', 'b', 'c'}, "hello"))
}

运行：

$ go run .

int: 1, float64: 5.75, bytes: abc, string with quotes: &quot;hello&quot;, string without quotes: hello.

调用函数

quicktemplate支持在模板中调用模板函数、标准库的函数。由于qtc会直接生成 Go 代码，我们甚至还可以在同目录下编写自己的函数给模板调用，模板 A 中也可以调用模板 B 中定义的函数。

我们先在templates目录下编写一个文件rank.go，定义一个Rank函数，传入分数，返回评级：

package templates

func 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"
  }
}

然后我们可以在模板中调用这个函数：

{% import "fmt" %}
{% 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 %}

编译模板：

$ qtc

编写程序：

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

  fmt.Println(templates.ScoreList(name2score))
}

运行程序输出：

$ go run .

dj: score-85 rank-B

lizi: score-96 rank-A

hjw: score-52 rank-E

由于我们在模板中用到fmt包，需要先使用{% import %}将该包导入。

在模板中调用另一个模板的函数也是类似的，因为模板最终都会转为 Go 代码。Go 代码中有同样签名的函数。

Web

quicktemplate常用来编写 HTML 页面的模板：

{% func Index(name string) %}
<html>
  <head>
    <title>Awesome Web</title>
  </head>
  <body>
    <h1>Hi, {%s name %}
    <p>Welcome to the awesome web!!!</p>
  </body>
</html>
{% 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())
}

qtc会生成一个Write*的方法，它接受一个io.Writer的参数。将模板渲染的结果写入这个io.Writer中，我们可以直接将http.ResponseWriter作为参数传入，非常便捷。

运行：

$ qtc
$ go run .

浏览器输入localhost:8080?name=dj查看结果。

总结

quicktemplate至少有下面 3 个优势：

  • 语法与 Go 语言非常类似，几乎没有学习成本；
  • 会先转换为 Go，渲染速度非常快，比标准库html/template快 20 倍以上；
  • 为了安全考虑，会执行一些编码，避免受到攻击。

从我个人的实际使用情况来看，确实很方便，很实用。感兴趣的还可以去看看qtc生成的 Go 代码。
大家如果发现好玩、好用的 Go 语言库，欢迎到 Go 每日一库 GitHub 上提交 issue😄

参考

quicktemplate GitHub：https://github.com/valyala/quicktemplate
Go 每日一库 GitHub：https://github.com/darjun/go-daily-lib

到此这篇关于Go每日一库之quicktemplate的使用的文章就介绍到这了,更多相关Go quicktemplate内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • 详解golang 模板(template)的常用基本语法

    模板 在写动态页面的网站的时候,我们常常将不变的部分提出成为模板,可变部分通过后端程序的渲染来生成动态网页,golang提供了html/template包来支持模板渲染. 这篇文章不讨论golang后端的模板读取及渲染方法,只讨论模板中嵌入变量,渲染变量.循环等一些基本用法. 变量 在golang渲染template的时候,可以接受一个interface{}类型的变量,我们在模板文件中可以读取变量内的值并渲染到模板里. 有两个常用的传入参数的类型.一个是struct,在模板内可以读取该struc

  • Go语言多值替换的HTML模板实例分析

    本文实例分析了Go语言多值替换的HTML模板用法.分享给大家供大家参考.具体如下: 这里通过两种方式提供基于HTML模板的多变量值替换.另外附加一个数组迭代的示例. 传入map实现多值替换 复制代码 代码如下: package main import (  "html/template"  "os" ) func main() {  t, _ := template.New("demo").Parse(`{{define "T"

  • Go html/template 模板的使用实例详解

    从字符串载入模板 我们可以定义模板字符串,然后载入并解析渲染: template.New(tplName string).Parse(tpl string) // 从字符串模板构建 tplStr := ` {{ .Name }} {{ .Age }} ` // if parse failed Must will render a panic error tpl := template.Must(template.New("tplName").Parse(tplStr)) tpl.Exe

  • golang模板template自定义函数用法示例

    本文实例讲述了golang模板template自定义函数用法.分享给大家供大家参考,具体如下: golang的模板十分强大,其中的unix管道风格函数调用很是喜欢. 模板中有很多内置可以参看pkg文档, 另外还可以实现自定义函数. 例子如下: 复制代码 代码如下: package main import (     "text/template"     "time"     "os" ) type User struct {     Usern

  • Go每日一库之quicktemplate的使用

    目录 简介 快速使用 语法结构 变量 调用函数 Web 总结 参考 简介 最近在整理我们项目代码的时候,发现有很多活动的代码在结构和提供的功能上都非常相似.为了方便今后的开发,我花了一点时间编写了一个生成代码框架的工具,最大程度地降低重复劳动.代码本身并不复杂,且与项目代码关联性较大,这里就不展开介绍了.在这个过程中,我发现 Go 标准的模板库text/template和html/template使用起来比较束手束脚,很不方便.我从 GitHub 了解到quicktemplate这个第三方模板库

  • Go 每日一库之termtables的使用

    目录 快速使用 模式 总结 今天学个简单点的

  • Go每日一库之dateparse处理时间

    目录 简介 快速使用 格式 时区 cli 总结 参考 简介 不管什么时候,处理时间总是让人头疼的一件事情.因为时间格式太多样化了,再加上时区,夏令时,闰秒这些细枝末节处理起来更是困难.所以在程序中,涉及时间的处理我们一般借助于标准库或第三方提供的时间库.今天要介绍的dateparse专注于一个很小的时间处理领域--解析日期时间格式的字符串. 快速使用 本文代码使用 Go Modules. 创建目录并初始化: $ mkdir dateparse && cd dateparse $ go mo

  • Go位集合相关操作bitset库安装使用

    目录 简介 安装 使用 为什么要使用它? 总结 一点闲话 参考 简介 我们都知道计算机是基于二进制的,位运算是计算机的基础运算.位运算的优势很明显,CPU 指令原生支持.速度快.基于位运算的位集合在有限的场景中替换集合数据结构可以收到意想不到的效果.bitset库实现了位集合及相关操作,不妨拿来即用. 安装 本文代码使用 Go Modules. 创建目录并初始化: $ mkdir -p bitset && cd bitset $ go mod init github.com/darjun/

  • Go语言测试库testify使用学习

    目录 简介 准备工作 assert Contains DirExists ElementsMatch Empty EqualError EqualValues Error ErrorAs ErrorIs 逆断言 Assertions 对象 require mock suite 测试 HTTP 服务器 总结 简介 testify可以说是最流行的(从 GitHub star 数来看)Go 语言测试库了.testify提供了很多方便的函数帮助我们做assert和错误信息输出.使用标准库testing,

  • Go gorilla/sessions库安装使用

    Go gorilla/sessions库安装使用

    目录 简介 快速使用 cookie 存储 记录登录状态 第三方后端存储 总结 简介 上一篇文章<Go 每日一库之 securecookie>中,我们介绍了 cookie.同时提到 cookie 有两个缺点,一是数据不宜过大,二是安全问题.session 是服务器端的存储方案,可以存储大量的数据,而且不需要向客户端传输,从而解决了这两个问题. 但是 session 需要一个能唯一标识用户的 ID,这个 ID 一般存放在 cookie 中发送到客户端保存,随每次请求一起发送到服务器.cookie

  • Go gorilla securecookie库的安装使用详解

    Go gorilla securecookie库的安装使用详解

    目录 简介 快速使用 使用 JSON 自定义编解码 Hash/Block 函数 更换 Key 总结 简介 cookie 是用于在 Web 客户端(一般是浏览器)和服务器之间传输少量数据的一种机制.由服务器生成,发送到客户端保存,客户端后续的每次请求都会将 cookie 带上.cookie 现在已经被多多少少地滥用了.很多公司使用 cookie 来收集用户信息.投放广告等. cookie 有两大缺点: 每次请求都需要传输,故不能用来存放大量数据: 安全性较低,通过浏览器工具,很容易看到由网站服务器

  • go goth封装第三方认证库示例详解

    go goth封装第三方认证库示例详解

    目录 简介 快速使用 更换 store 总结 简介 当前很多网站直接采用第三方认证登录,例如支付宝/微信/ Github 等.goth封装了接入第三方认证的方法,并且内置实现了很多第三方认证的实现: 图中截取的只是goth支持的一部分,完整列表可在其GitHub 首页查看. 快速使用 本文代码使用 Go Modules. 创建目录并初始化: $ mkdir goth && cd goth $ go mod init github.com/darjun/go-daily-lib/goth 安

  • python实现微信每日一句自动发送给喜欢的人

    本文实例为大家分享了python实现微信每日一句自动发送的具体代码,供大家参考,具体内容如下 参考了一篇博客:教你使用python实现微信每天给女朋友说晚安 代码: # -*- coding: utf-8 -*- ''' 这是一个用来测试微信自动发送消息的demo 恩,主要就是用到了一个微信库--wxpy 安装很简单 pip install wxpy 下面就开始吧 主要就两个函数 1.getNews();用以获取信息 2.sendNews();用以发送信息 我这里发送消息用的是for循环本意是群

  • Python获取基金网站网页内容、使用BeautifulSoup库分析html操作示例

    本文实例讲述了Python获取基金网站网页内容.使用BeautifulSoup库分析html操作.分享给大家供大家参考,具体如下: 利用 urllib包 获取网页内容 #引入包 from urllib.request import urlopen response = urlopen("http://fund.eastmoney.com/fund.html") html = response.read(); #这个网页编码是gb2312 #print(html.decode("

随机推荐