Go入门: go template 的基本用法

原创 Youfang Xi 开源螺丝钉

2023年05月11日 12:30

Go语言中的模板（Template）是一个强大的工具，它可以让开发者在生成 HTML、XML等文本格式时，更加简单高效。Go的模板语言在设计上非常简洁，但是在功能上非常强大，它支持基本的控制流、条件语句、变量、函数等，同时还可以通过自定义函数和自定义类型等方式扩展其功能。在本文中，我们将学习Go语言中的模板，探讨其常用功能。

Go模板的基本语法

Go模板的基本语法非常简洁，它由模板定义和模板执行两部分组成。模板定义是一个字符串，其中包含了文本和模板指令，用于描述生成文本的规则。模板执行则是将模板定义和数据结构组合起来，生成最终的文本。

下面是一个简单的Go模板例子

package main
import (  "html/template"  "os")
type Person struct {  Name string  Age  int}
func main() {  person := Person{Name: "Alice", Age: 20}
  tmpl := `{{.Name}} is {{.Age}} years old.`  t := template.Must(template.New("person").Parse(tmpl))
  err := t.Execute(os.Stdout, person)  if err != nil {    panic(err)  }}

在这个例子中，我们定义了一个名为Person的结构体，用于保存人的信息。接着，我们定义了一个名为tmpl的模板，它包含了一个输出变量Name和Age的指令。最后，我们将模板和数据组合起来，生成最终的文本输出到控制台。

输出结果：

Alice is 20 years old.

从这个例子中，我们可以看到Go模板的基本语法非常简单，它只需要掌握一些基本的指令即可。

模板指令

在Go模板中，指令是由花括号{}包含的文本块，它们告诉模板引擎如何生成文本。指令可以分为三类：输出指令、控制指令和注释指令。

输出指令

输出指令用于生成变量的值。在模板中，输出指令由双花括号{{}}包含，如下所示

{{.Variable}}

其中，Variable是一个变量名，它的值将会被输出。在输出指令中，变量可以是模板参数、模板参数的字段、自定义函数的返回值等

控制指令

控制指令用于控制模板的执行流程，包括条件语句、循环语句、选择语句等。在模板中，控制指令由单花括号{}包含，如下所示：

{{if .Condition}} ... {{else}} ... {{end}}{{range .Array}} ... {{end}}{{with .Variable}} ... {{end}}

其中，Condition是一个条件表达式，Array是一个数组，Variable是一个变量。这些指令可以让我们轻松地控制模板的执行流程，根据数据的不同情况生成不同的文本。

注释指令

注释指令用于在模板中添加注释，以便于其他人理解代码。在模板中，注释指令由双花括号和注释标记组成，如下所示：

{{/* 注释内容 */}}

其中，注释内容是任意文本。注释指令的作用是在模板中添加注释，以便于其他人理解代码。

模板函数

在Go模板中，函数是一种扩展模板功能的方式。它可以让我们在模板中使用自定义的函数，对数据进行处理，生成更加丰富的文本。Go模板内置了一些常用的函数，如len、html、urlquery等，我们也可以自定义函数，满足自己的需求。

下面是一个示例，展示如何在Go模板中使用函数：

package main
import (  "fmt"  "html/template"  "os"  "strings")
func main() {  funcMap := template.FuncMap{    "upper": strings.ToUpper,  }
  tmpl := `{{.Name | upper}}`
  t := template.Must(template.New("person").Funcs(funcMap).Parse(tmpl))
  person := struct{ Name string }{"Alice"}
  err := t.Execute(os.Stdout, person)  if err != nil {    panic(err)  }}

在这个例子中，我们定义了一个名为upper的函数，用于将字符串转换为大写形式。接着，我们在模板中使用了这个函数，将Name变量转换为大写形式。最后，我们将模板和数据组合起来，生成最终的文本输出到控制台。

输出结果：

ALICE

从这个例子中，我们可以看到Go模板函数的使用非常简单，只需要定义一个函数映射表，将函数注册到模板中即可。

模板嵌套

在Go模板中，我们可以将多个模板组合起来，实现模板的复用。模板嵌套可以让我们将页面的不同部分分开处理，降低代码的复杂度。

下面是一个示例，展示如何在Go模板中进行模板嵌套：

package main
import (  "html/template"  "os"  "strings")
type Person struct {  Name string  Age  int}
func main() {  funcMap := template.FuncMap{    "upper": strings.ToUpper,  }
  tmpl := `{{define "header"}}  <header>{{.Name}}'s Profile</header>{{end}}
{{define "body"}}  <ul>    <li>Name: {{.Name}}</li>    <li>Age: {{.Age}}</li>  </ul>{{end}}{{template "header" .}}{{template "body" .}}`  t := template.Must(template.New("person").Funcs(funcMap).Parse(tmpl))  person := Person{Name: "Alice", Age: 20}  err := t.Execute(os.Stdout, person)  if err != nil {    panic(err)  }}

在上面的代码中，我们定义了两个模板，一个名为header，一个名为body。其中，header模板用于显示页面的头部，body模板用于显示页面的主体内容。接着，我们使用template指令将header模板和body模板组合起来，生成最终的页面。

输出结果：

<header>Alice's Profile</header><ul>  <li>Name: Alice</li>  <li>Age: 18</li></ul>

从这个例子中，我们可以看到Go模板的模板嵌套功能非常实用，可以将页面的不同部分分开处理，降低代码的复杂度。

模板继承

在Go模板中，我们还可以使用模板继承的方式，实现模板的复用。模板继承可以让我们将页面的不同部分分开处理，降低代码的复杂度。

下面是一个示例，展示如何在Go模板中进行模板继承：

package main
import (  "html/template"  "os")
func main() {  tmpl := `{{define "base"}}  <!doctype html>  <html>  <head>    <title>{{template "title" .}}</title>  </head>  <body>    {{template "content" .}}  </body>  </html>{{end}}
{{define "title"}}{{.Name}}'s Profile{{end}}
{{define "content"}}  <ul>    <li>Name: {{.Name}}</li>    <li>Age: {{.Age}}</li>  </ul>{{end}}
{{template "base" .}}`
  t := template.Must(template.New("person").Parse(tmpl))
  person := struct {    Name string    Age  int  }{"Alice", 18}
  err := t.Execute(os.Stdout, person)  if err != nil {    panic(err)  }}

在上面的代码中，我们定义了一个名为base的模板，用于定义页面的基本结构，包括HTML头部、标题和内容。接着，我们使用template指令将title模板和content模板组合起来，生成最终的页面。

输出结果：

<!doctype html><html><head>  <title>Alice's Profile</title></head><body>  <ul>    <li>Name: Alice</li>    <li>Age: 18</li>  </ul></body></html>

从这个例子中，我们可以看到Go模板的模板继承功能非常实用，可以将页面的不同部分分开处理，降低代码的复杂度。

总结

Go模板是Go语言内置的一种模板引擎，具有简单、灵活、易于学习的特点。Go模板提供了丰富的指令和函数，可以轻松地生成各种文本，包括HTML、XML、JSON等。Go模板还支持模板嵌套和模板继承，可以降低代码的复杂度，提高代码的质量。

继续滑动看下一个