golang template 库使用教程

在我写 tplate 时，我发现网上能找到的 golang template 教程都很分散，不是很方便，于是打算写一篇文章留给自己用

本文中展示的库默认使用 html/template 库，可能与 text/template 用法有些差别

基本

首先让我们来看看怎么定义、解析和调用模板

定义模板

当我们使用 template.ParseFiles() 函数加载模板文件时，默认会按单个文件生成一个模板，并以此文件的文件名作为模板名，统一存放在 template.Template > nameSpace > set map 对象中

不定义模板名称

如果只是使用少量的模板且不嵌套使用，那不定义模板名称没有什么问题，否则可能出现一些混乱的情况：

.
├── dir
│   └── abc.tmpl # 存放在子目录中
├── 123.tmpl
├── abc.tmpl # 文件名与 ./dir/abc.tmpl 相同
└── xyz.tmpl

# 解析的结果
["123.tmpl", "abc.tmpl", "xyz.tmpl"]

可以看到我们在 ./ 目录中定义了四个 .tmpl 文件，而解析的结果只有三个模板对象

而其中的 abc.tmpl 模板更是一个叠加态，它可能是 ./dir/abc.tmpl，也可能是 ./abc.tmpl，这取决于哪个文件最后被解析，而且模板名中并不会保留路径名，你会没法分辨具体是哪个文件

定义模板名称

但若我们手动定义模板名称，就可以避免上方的问题：

# ./abc.tmpl 文件
{{ define "abc" }} # 定义一个模板并命名为 "abc"
{{/* 模板中的逻辑 */}}
{{ end }} # 结束定义模板

# ./dir/abc.tmpl 文件
{{ define "dir/abc" }} # 定义一个模板并命名为 "dir/abc"
{{/* 模板中的逻辑 */}}
{{ end }} # 结束定义模板

# 解析的结果
["abc", "dir/abc", "abc.tmpl"]

可以看到，我们通过定义模板名称来让模板保留了层级信息，这样我们可以更清楚的知道使用了哪个模板

就算定义了模板名称，但在结果中可以看出，程序还是会按照原来的方式解析文件并保留到 template map 对象中，这个问题似乎也没有什么好办法，在解析大量模板时会不会额外占用内存也不清楚，但为了更方便的调用模板，推荐还是手动定义模板名称

解析模板

html/template 库提供了三个函数来加载模板，它们分别是：

1. ParseFS(fs fs.FS, patterns ...string) (*Template, error)
2. ParseFiles(filenames ...string) (*Template, error)
3. ParseGlob(pattern string) (*Template, error)

综合使用最多的还是 template.ParseFiles() 搭配 filepath.WalkDir()

ParseFS()

没有用过，不是很清楚用法

ParseFiles()

接受可变参数的模板路径，通常搭配 filepath.WalkDir() 函数来自动解析一个文件夹及其全部子目录下的全部模板文件：

var paths []string
var tmplDir string = "./templates"
var tmplExt string = ".tmpl"

err := filepath.WalkDir(tmplDir, func(path string, d os.DirEntry, err error) error {
	if err != nil {
		return err
	}
	if !d.IsDir() && filepath.Ext(path) == tmplExt {
		paths = append(paths, path)
	}
	return nil
})
if err != nil {
	log.Println(err)
}

tmpl, err := template.ParseFiles(paths...)
if err != nil {
	log.Println(err)
}

ParseGlob()

接受一个目录路径，仅解析此目录下的文件（拓展名不确定），不包含子目录和其中的文件

var tmplDir string = "./templates"

tmpl, err := template.ParseGlob(tmplDir)
if err != nil {
	log.Println(err)
}

调用模板

template.Template 结构体有两个方法可以执行模板，分别是：

1. (t *Template) Execute(wr io.Writer, data any) error
2. (t *Template) ExecuteTemplate(wr io.Writer, name string, data any) error

调用单个模板

当仅解析一个 .tmpl 文件时，可以简单的调用 Template.Execute() 方法来执行这个模板：

tmpl, err := template.ParseFiles("./a.tmpl") // 只传入了一个模板文件路径
if err != nil {
	log.Println(err)
}

var buf bytes.Buffer // 创建一个 buffer 作为执行模板的缓冲

// 执行模板时传入 buf 的地址作为 io.Writer 接口，因为暂时不需要数据，data 传入 nil
err = tmpl.Execute(&buf, nil)
if err != nil {
	log.Println(err)
}

// 在终端里输出执行模板后的结果
fmt.Println(buf.String())

多个模板调用一个

但在实际使用中，更多的情况是初始化时一次性加载多个模板，在使用时指定模板名称来执行，这里我们就可以使用 Template.ExecuteTemplate() 方法:

tmpl, err := template.ParseFiles("./a.tmpl", "./b.tmpl", "./c.tmpl") // 传入了三个模板文件的路径
if err != nil {
    log.Println(err)
}

var buf bytes.Buffer // 创建一个 buffer 作为执行模板的缓冲

// 第一个参数同样传入 buf 的地址
// 第二个参数为模板的名称，这里我使用了文件名，实际上应该自定义模板名称
// 第三个参数因为暂时不需要数据，同样传入 nil
err = tmpl.ExecuteTemplate(&buf，"a.tmpl", nil)
if err != nil {
    log.Println(err)
}

fmt.Println(buf.String())

如果解析了多个模板，但调用时使用 Template.Execute() 方法，我不清楚具体会发生什么，但不推荐这样做

模板语法

if else 条件式

我们也可以在模板中判断一些条件，来控制要执行的数据

{{ if .A }}
  {{/* 符合 .A 条件的内容 */}}
{{ end }}

当然也可以嵌套条件式：

{{ if .A }}
  {{/* 符合 .A 条件时的内容 */}}
{{ else if .B }}
  {{/* 符合 .B 条件时的内容 */}}
{{ else }}
  {{/* 不符合上面两个条件时的内容 */}}
{{ end }}

遍历

我们只需要简单的使用 range 方法即可遍历数组、切片或 map 键值对，下面是一个最简单的演示：

{{ range . }}
当前遍历的值: {{ . }}
{{ end }}

使用循环外的值

在 range 方法的作用域中，. 符号指向的数据将是当前遍历的值，若我们需要在作用域中使用作用域外的数据，可以在使用时添加 $ 前缀：

{{/* 这里假设你在执行模板时，传入的数据中有 Slice 和 Value 这两个变量 */}}
这是 Value 的值: {{ $.Value }}
{{ range .Slice }}
当前遍历的值: {{ . }}
在循环内调用 Value 的值: {{ $.Value }}
{{ end }}

获取索引或键

我们可以在使用 range 方法时按照下面的方法创建临时变量来获取索引值或 map 键值对中的键：

{{ range $index, $data := . }}
当前遍历的值: {{ . }}
index 变量:  {{ $index }}
data 变量:   {{ $data }}
{{ end }}

可以看到就算创建了变量，依然可以通过 {{ . }} 来直接调用当前作用域中的值

循环为空时的其他条件

range 方法还可以在要遍历的数组、切片或 map 键值对中没有值时，触发其他条件：

{{ range . }}
当前遍历的值: {{ . }}
{{ else }}
这个数组是空的
{{ end }}

逻辑判断

golang template 语法相比 go 语言没有那么严格的类型限制，但这可能并不是什么好事...

逻辑运算符

比较运算符

入门示例

很可惜，golang 的工具包并没有对 golang template 文件的静态检查，语法也没有，如果你使用的是 vscode 编辑器，你可以安装 gotemplate-syntax 拓展来获得语法高亮

简单示例

下面是一个简单的模板内容：

{{ define "base" }}
大家好啊，我是 {{ . }}，今天来点大家想看的东西啊
{{ end }}

第一行的 {{ define "base" }} 的作用是定义了一个模板，名称为 base，前面讲过，这样我们可以在解析多个模板文件时通过此名称精确指定执行这个模板

第二行则是一段文字，可以看到 我是 {{ . }} 处应该跟着的是一个名字，但这里却使用了 {{ . }} 来作为占位符，这是一个 template 的语法，其中的 . 代表了执行此模板时将传入的数据

第三行是 {{ end }}，其中的 end 代表了某个逻辑块的结束，这里对应的是第一行，定义模板时需要以 {{ define "模板名称" }} 作为开始，使用 {{ end }} 结束。每个逻辑块都需要使用 {{ end }} 结束，否则执行模板时会发生错误

让我们试试执行它（暂时没有电脑的话，也可以前往 Go Playground 尝试）：

package main

import (
	"bytes"
	"fmt"
	"html/template"
	"log"
)

func main() {
	// 由于这里我没法创建文件
	// 所以我们使用 `template.New()` 函数创建 `template.Template` 结构体
	// 再调用 `Parse()` 方法直接将模板写进代码中解析
	tmpl, err := template.New("").Parse(`{{ define "base" }}大家好啊，我是 {{ . }}，今天来点大家想看的东西啊{{ end }}`)
	if err != nil {
		log.Println(err)
	}

	var buf bytes.Buffer // 创建一个 buffer 作为执行模板的缓冲

	// 调用 ExecuteTemplate() 方法时
	// 第一个参数中传入 buf 的内存地址
	// 第二个参数传入 "base" 字符串即模板定义时的名称
	// 第三个参数传入了我的名字 "Hubert"，你可以尝试修改第三个参数再运行
	err = tmpl.ExecuteTemplate(&buf, "base", "Hubert")
	if err != nil {
		log.Println(err)
	}

	fmt.Println(buf.String())
}

终端中的运行输出：

$ go run main.go
大家好啊，我是 Hubert，今天来点大家想看的东西啊

可以看到，模板中的 我是 {{ . }} 被替换成了 我是 Hubert，我们在执行模板时，只需要修改传入的参数，就可以很方便的更改文本的部分数据，配合代码逻辑，我们就可以达到更复杂的效果