Go 每日一库之 quicktemplate

时间 2020-09-28

标签每日 quicktemplate 繁體版

原文原文链接

简介

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

快速使用

本文代码使用 Go Modules。git

先建立代码目录并初始化：github

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

quicktemplate会将咱们编写的模板代码转换为 Go 语言代码。所以咱们须要安装quicktemplate包和一个名为qtc的编译器：golang

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

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

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 %}，引号转义为"；
字符串：{%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

我

个人博客：https://darjun.github.io

欢迎关注个人微信公众号【GoUpUp】，共同窗习，一块儿进步~