簡介

最近在整理我們項目代碼的時候，發現有很多活動的代碼在結構和提供的功能上都非常相似。為了方便今后的開發，我花了一點時間編寫了一個生成代碼框架的工具，最大程度地降低重復勞動。代碼本身并不復雜，且與項目代碼關聯性較大，這里就不展開介紹了。在這個過程中，我發現 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;helloquot;, 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內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持腳本之家！