Go Web 编程之 模板(一)

概述

模板引擎是 Web 编程中必不可少的一个组件。 模板 能分离逻辑和数据,使得逻辑简洁清晰,并且模板可复用。引用第二篇文章 《程序结构》 一文中的图示,我们可以看到模板引擎在 Web 程序结构中的位置:

模板引擎按照功能可以划分为两种类型:

  • 无逻辑模板引擎 :此类模板引擎只进行字符串的替换,无其它逻辑;
  • 嵌入逻辑模板引擎 :此类模板引擎可以在模板中嵌入逻辑,实现流程控制/循环等。

这两类模板引擎都比较极端。无逻辑模板引擎需要在处理器中额外添加很多逻辑用于生成替换的文本。而嵌入逻辑模板引擎则在模板中混入了大量逻辑,导致维护性较差。实用的模板引擎一般介于这两者之间。

在Go 语言中, text/templatehtml/template 两个库实现模板功能。

模板内容可以是 UTF-8 编码的任何内容。其中用 {{}} 包围的部分称为 动作{{}} 外的其它文本在输出保持不变。模板需要应用到数据,模板中的动作会根据数据生成响应的内容来替换。

模板解析之后可以多次执行,也可以并行执行,但是注意使用同一个 Writer 会导致输出交替出现。

模板的内容较多,我将分为两篇文章介绍。本文介绍 text/template ,包括 Go 模板的基本概念,用法和注意点。下篇文章介绍 html/template

初体验

使用模板引擎一般有 3 个步骤:

  • 定义模板(直接使用字符串字面量或文件);
  • 解析模板(使用 text/templatehtml/template 中的方法解析);
  • 传入数据生成输出。
package main

import (
    "log"
    "os"
    "text/template"
)

type User struct {
    Name string
    Age  int
}

func stringLiteralTemplate() {
    s := "My name is {{ .Name }}. I am {{ .Age }} years old.\n"
    t, err := template.New("test").Parse(s)
    if err != nil {
        log.Fatal("Parse string literal template error:", err)
    }

    u := User{Name: "darjun", Age: 28}
    err = t.Execute(os.Stdout, u)
    if err != nil {
        log.Fatal("Execute string literal template error:", err)
    }
}

func fileTemplate() {
    t, err := template.ParseFiles("test")
    if err != nil {
        log.Fatal("Parse file template error:", err)
    }

    u := User{Name: "dj", Age: 18}
    err = t.Execute(os.Stdout, u)
    if err != nil {
        log.Fatal("Execute file template error:", err)
    }
}

func main() {
    stringLiteralTemplate()

    fileTemplate()
}

在可执行程序目录中新建模板文件 test ,并写入下面的内容:

My name is {{ .Name }}. I am {{ .Age }} years old.

首先调用 template.New 创建一个模板,参数为模板名。

然后调用 Template 类型的 Parse 方法,解析模板字符串,生成模板主体。这个方法返回两个值。如果模板语法正确,则返回模板对象本身和一个 nil 值。

如果有语法错误,则返回一个 error 类型的值作为第二个返回值,这时不应该使用第一个返回值。

最后,调用模板对象的 Execute 方法,传入参数。 Execute 执行模板中的动作,将结果输出到 os.Stdout ,即 标准输出 。最终我们看到模板中 {{ .Name }}uName 字段替换, {{ .Age }}uAge 字段替换,标准输出中显示下面一行字符串:

My name is darjun. I am 28 years old.

上面代码中, fileTemplate 函数还演示了如何从文件中加载模板。其中 template.ParseFiles 方法会创建一个模板,并将用户指定的模板文件名用作这个新模板的名字:

t, err := template.ParseFiles("test")

相当于:

t := template.New("test")
t, err := t.ParseFiles("test")

动作

Go 模板中的动作就是一些嵌入在模板里面的命令。动作大体上可以分为以下几种类型:

  • 点动作;
  • 条件动作;
  • 迭代动作;
  • 设置动作;
  • 包含动作。

点动作

在介绍其它的动作之前,我们先看一个很重要的动作, 点动作{{ . }} )。它其实代表是传递给模板的数据,其他动作或函数基本上都是对这个数据进行处理,以此来达到格式化和内容展示的目的。

对前面的代码示例稍作修改:

func main() {
    s := "The user is {{ . }}."
    t, err := template.New("test").Parse(s)
    if err != nil {
        log.Fatal("Parse error:", err)
    }

    u := User{Name: "darjun", Age: 28}
    err = t.Execute(os.Stdout, u)
    if err != nil {
        log.Fatal("Execute error:", err)
    }
}

运行程序,标准输出显示:

The user is {darjun 28}.

实际上, {{ . }} 会被替换为传给给模板的数据的字符串表示。这个字符串与以数据为参数调用 fmt.Sprint 函数得到的内容相同。我们可以为 User 结构编写一个方法:

func (u User) String() string {
    return fmt.Sprintf("(name:%s age:%d)", u.Name, u.Age)
}

这样替换的字符串就是格式化之后的内容了:

The user is (name:darjun age:28).

注意:为了使用的方便和灵活,在模板中不同的上下文内, . 的含义可能会改变,下面在介绍不同的动作时会进行说明。

条件动作

在介绍动作的语法时,我采用 Go 标准库中的写法。我觉得这样写更严谨。

其中 pipeline 表示管道,后面会有详细的介绍,现在可以将它理解为一个值。

T1/T2 等形式表示 语句块 ,里面可以嵌套其它类型的动作。 最简单的语句块就是不包含任何动作的字符串

条件动作的语法与编程语言中的 if 语句语法类似,有几种形式:

形式一:

{{ if pipeline }} T1 {{ end }}

如果管道计算出来的值不为空,执行 T1 。否则,不生成输出。下面都表示空值:

false

形式二:

{{ if pipeline }} T1 {{ else }} T2 {{ end }}

如果管道计算出来的值不为空,执行 T1 。否则,执行 T2

形式三:

{{ if pipeline1 }} T1 {{ else if pipeline2 }} T2 {{ else }} T3 {{ end }}

如果管道 pipeline1 计算出来的值不为空,则执行 T1 。反之如果管道 pipeline2 的值不为空,执行 T2 。如果都为空,执行 T3

举个栗子:

type AgeInfo struct {
    Age           int
    GreaterThan60 bool
    GreaterThan40 bool
}

func main() {
    t, err := template.ParseFiles("test")
    if err != nil {
        log.Fatal("Parse error:", err)
    }

    rand.Seed(time.Now().Unix())
    age := rand.Intn(100)
    info := AgeInfo {
        Age:           age,
        GreaterThan60: age > 60,
        GreaterThan40: age > 40,
    }
    err = t.Execute(os.Stdout, info)
    if err != nil {
        log.Fatal("Execute error:", err)
    }
}

在可执行程序的目录下新建模板文件 test ,键入下面的内容:

Your age is: {{ .Age }}
{{ if .GreaterThan60 }}
Old People!
{{ else if .GreaterThan40 }}
Middle Aged!
{{ else }}
Young!
{{ end }}

运行程序,会随机一个年龄,然后根据年龄区间选择性输出 Old People!/Middle Age!/Young! 其中一个。下面是我运行两次运行的输出:

Your age is: 7

Young!
Your age is: 79

Old People!

这个程序有一个问题,会有多余的空格!我们之前说过,除了动作之外的任何文本都会原样保持,包括空格和换行!针对这个问题,有两种解决方案。第一种方案是删除多余的空格和换行, test 文件修改为:

Your age is: {{ .Age }}
{{ if .GreaterThan60 }}Old People!{{ else if .GreaterThan40 }}Middle Aged!{{ else }}Young!{{ end }}

显然,这个方法会导致模板内容很难阅读,不够理想。为此,Go 提供了针对空白符的处理。如果一个动作以 {{- (注意有一个空格),那么该动作与它前面相邻的非空文本或动作间的空白符将会被全部删除。类似地,如果一个动作以 -}} 结尾,那么该动作与它后面相邻的非空文本或动作间的空白符将会被全部删除。例如:

{{23 -}} < {{- 45}}

将会生成输出:

23<45

回到我们的例子中,我们可以将 test 文件稍作修改:

Your age is: {{ .Age }}
{{ if .GreaterThan60 -}}
"Old People!"
{{- else if .GreaterThan40 -}}
"Middle Aged!"
{{- else -}}
"Young!"
{{- end }}

这样,输出的文本就不会包含多余的空格了。

迭代动作

迭代其实与编程语言中的循环遍历类似。有两种形式:

形式一:

{{ range pipeline }} T1 {{ end }}

管道的值类型必须是数组、切片、map、channel。如果值的长度为 0,那么无输出。否则, . 被设置为当前遍历到的元素,然后执行 T1 ,即在 T1. 表示遍历的当前元素,而非传给模板的参数 。如果值是 map 类型,且键是可比较的基本类型, 元素将会以键的顺序访问

形式二:

{{ range pipeline }} T1 {{ else }} T2 {{ end }}

与前一种形式基本一样,如果值的长度为 0,那么执行 T2

举个栗子:

type Item struct {
    Name    string
    Price    int
}

func main() {
    t, err := template.ParseFiles("test")
    if err != nil {
        log.Fatal("Parse error:", err)
    }

    items := []Item {
        { "iPhone", 5499 },
        { "iPad", 6331 },
        { "iWatch", 1499 },
        { "MacBook", 8250 },
    }

    err = t.Execute(os.Stdout, items)
    if err != nil {
        log.Fatal("Execute error:", err)
    }
}

在可执行程序目录下新建模板文件 test ,键入内容:

Apple Products:
{{ range . }}
{{ .Name }}: ¥{{ .Price }}
{{ else }}
No Products!!!
{{ end }}

运行程序,得到下面的输出:

Apple Products:

iPhone: ¥5499

iPad: ¥6331

iWatch: ¥1499

MacBook: ¥8250

range 语句循环体内, . 被设置为当前遍历的元素,可以直接使用 {{ .Name }}{{ .Price }} 访问产品名称和价格。在程序中,将 nil 传给 Execute 方法会得到下面的输出:

Apple Products:

No Products!!!

设置动作

设置动作使用 with 关键字重定义 . 。在 with 语句内, . 会被定义为指定的值。一般用在结构嵌套很深时,能起到简化代码的作用。

形式一:

{{ with pipeline }} T1 {{ end }}

如果管道值不为空,则将 . 设置为 pipeline 的值,然后执行 T1 。否则,不生成输出。

形式二:

{{ with pipeline }} T1 {{ else }} T2 {{ end }}

与前一种形式的不同之处在于当管道值为空时,不改变 . 执行 T2 。举个栗子:

type User struct {
    Name string
    Age  int
}

type Pet struct {
    Name  string
    Age   int
    Owner User
}

func main() {
    t, err := template.ParseFiles("test")
    if err != nil {
        log.Fatal("Parse error:", err)
    }

    p := Pet {
        Name:  "Orange",
        Age:   2,
        Owner: User {
            Name: "dj",
            Age:  28,
        },
    }

    err = t.Execute(os.Stdout, p)
    if err != nil {
        log.Fatal("Execute error:", err)
    }
}

模板文件内容:

Pet Info:
Name: {{ .Name }}
Age: {{ .Age }}
Owner:
{{ with .Owner }}
  Name: {{ .Name }}
  Age: {{ .Age }}
{{ end }}

运行程序,得到下面的输出:

Pet Info:
Name: Orange
Age: 2
Owner:

  Name: dj
  Age: 28

可见,在 with 语句内, . 被替换成了 Owner 字段的值。

包含动作

包含动作可以在一个模板中嵌入另一个模板,方便模板的复用。

形式一:

{{ template "name" }}

形式二:

{{ template "name" pipeline }}

其中 name 表示嵌入的模板名称。第一种形式,将使用 nil 作为传入内嵌模板的参数。第二种形式,管道 pipeline 的值将会作为参数传给内嵌的模板。举个栗子:

package main

import (
    "log"
    "os"
    "text/template"
)

func main() {
    t, err := template.ParseFiles("test1", "test2")
    if err != nil {
        log.Fatal("Parse error:", err)
    }

    err = t.Execute(os.Stdout, "test data")
    if err != nil {
        log.Fatal("Execute error:", err)
    }
}

ParseFiles 方法接收可变参数,可将任意多个文件名传给该方法。

模板 test1 :

This is in test1.
{{ template "test2" }}

{{ template "test2" . }}

模板 test2 :

This is in test2.
Get: {{ . }}.

运行程序得到输出:

This is in test1.
This is in test2.
Get: <no value>.

This is in test2.
Get: test data.

前一个嵌入模板,没有传递参数。后一个传入 . ,即传给 test1 模板的参数。

其它元素

在介绍了几种动作之后,我们回过头来看几种基本组成部分。

注释

注释只有一种语法:

{{ /* 注释 */ }}

注释的内容不会呈现在输出中,它就像代码注释一样,是为了让模板更易读。

参数

一个参数就是模板中的一个值。它的取值有多种:

  • 布尔值、字符串、字符、整数、浮点数、虚数和复数等 字面量
  • 结构中的一个字段或 map 中的一个键。 结构的字段名必须是导出的,即大写字母开头,map 的键名则不必
  • 一个函数或方法。必须只返回一个值,或者只返回一个值和一个错误。如果返回了非空的错误,则 Execute 方法执行终止,返回该错误给调用者;
  • 等等等等。

上面几种形式可以结合使用:

{{ .Field1.Key1.Method1.Field2.Key2.Method2 }

其实,我们已经用过很多次参数了。下面看一个方法调用的栗子:

type User struct {
    FirstName     string
    LastName    string
}

func (u User) FullName() string {
    return u.FirstName + " " + u.LastName
}

func main() {
    t, err := template.ParseFiles("test")
    if err != nil {
        log.Fatal("Parse error:", err)
    }

    err = t.Execute(os.Stdout, User{FirstName: "lee", LastName: "darjun"})
    if err != nil {
        log.Fatal("Execute error:", err)
    }
}

模板文件 test

My full name is {{ .FullName }}.

模板执行会使用 FullName 方法的返回值替换 {{ .FullName }} ,输出:

My full name is lee darjun.

关于参数的几个要点:

  • 参数可以是任何类型;
  • 如果参数为指针,实现会根据需要取其基础类型;
  • 如果参数计算得到一个函数类型,它不会自动调用。例如 {{ .Method1 }} ,如果 Method1 方法返回一个函数,那么返回值函数不会调用。如果要调用它,使用内置的 call 函数。

管道

管道的语法与 Linux 中的管道类似,即 命令 的链式序列:

{{ p1 | p2 | p3 }}

每个单独的命令(即 p1/p2/p3... )可以是下面三种类型:

  • 参数,见上面;
  • 可能带有参数的方法调用;
  • 可能带有参数的函数调用。

在一个链式管道中,每个命令的结果会作为下一个命令的最后一个参数。最后一个命令的结果作为整个管道的值。

管道必须只返回一个值,或者只返回一个值和一个错误。如果返回了非空的错误,那么 Execute 方法执行终止,并将该错误返回给调用者。

在迭代程序的基础上稍作修改:

type Item struct {
    Name  string
    Price float64
    Num   int
}

func (item Item) Total() float64 {
    return item.Price * float64(item.Num)
}

func main() {
    t, err := template.ParseFiles("test")
    if err != nil {
        log.Fatal("Parse error:", err)
    }

    item := Item {"iPhone", 5499.99, 2 }

    err = t.Execute(os.Stdout, item)
    if err != nil {
        log.Fatal("Execute error:", err)
    }
}

模板文件 test

Product: {{ .Name }}
Price: ¥{{ .Price }}
Num: {{ .Num }}
Total: ¥{{ .Total | printf "%.2f" }}

先调用 Item.Total 方法计算商品总价,然后使用 printf 格式化,保留两位小数。最终输出:

Product: iPhone
Price: ¥5499.99
Num: 2
Total: ¥10999.98

printf 是 Go 模板内置的函数,这样的函数还有很多。

变量

在动作中,可以用管道的值定义一个变量。

$variable := pipeline

$variable 为变量名,声明变量的动作不生成输出。

类似地,变量也可以重新赋值:

$variable = pipeline

range 动作中可以定义两个变量:

range $index, $element := range pipeline

这样就可以在循环中通过 $index$element 访问索引和元素了。

变量的作用域持续到定义它的控制结构的 {{ end }} 动作。如果没有这样的控制结构,则持续到模板结束。模板调用不继承变量。

执行开始时, $ 被设置为传入的数据参数,即 . 的值。

函数

Go 模板提供了大量的预定义函数,如果有特殊需求也可以实现自定义函数。模板执行时,遇到函数调用,先从模板自定义函数表中查找,而后查找全局函数表。

预定义函数

预定义函数分为以下几类:

  • 逻辑运算, and/or/not
  • 调用操作, call
  • 格式化操作, print/printf/println ,与用参数直接调用 fmt.Sprint/Sprintf/Sprintln 得到的内容相同;
  • 比较运算, eq/ne/lt/le/gt/ge

在上面条件动作的示例代码中,我们在代码中计算出大小关系再传入模板,这样比较繁琐,可以直接使用比较运算简化。

有两点需要注意:

  • 由于是函数调用,所有的参数都会被求值,没有 短路求值
  • 比较运算只作用于基本类型,且没有 Go 语法那么严格,例如可以比较有符号和无符号整数。

自定义函数

默认情况下,模板中无自定义函数,可以使用模板的 Funcs 方法添加。下面我们实现一个格式化日期的自定义函数:

package main

import (
    "log"
    "os"
    "text/template"
    "time"
)

func formatDate(t time.Time) string {
    return t.Format("2016-01-02")
}

func main() {
    funcMap := template.FuncMap {
        "fdate": formatDate,
    }
    t := template.New("test").Funcs(funcMap)
    t, err := t.ParseFiles("test")
    if err != nil {
        log.Fatal("Parse errr:", err)
    }

    err = t.Execute(os.Stdout, time.Now())
    if err != nil {
        log.Fatal("Exeute error:", err)
    }
}

模板文件 test

Today is {{ . | fdate }}.

模板的 Func 方法接受一个 template.FuncMap 类型变量,键为函数名,值为实际定义的函数。

可以一次设置多个自定义函数。自定义函数要求只返回一个值,或者返回一个值和一个错误。

设置之后就可以在模板中使用 fdate 了,输出:

Today is 7016-01-07.

这里不能使用 template.ParseFiles ,因为在解析模板文件的时候 fdate 未定义会导致解析失败。 必须先创建模板,调用 Funcs 设置自定义函数,然后再解析模板。

模板的几种创建方式

我们前面学习了两种模板的创建方式:

  • 先调用 template.New 创建模板,然后使用 Parse/ParseFiles 解析模板内容;
  • 直接使用 template.ParseFiles 创建并解析模板文件。

第一种方式,调用 template.New 创建模板时需要传入一个模板名字,后续调用 ParseFiles 可以传入一个或多个文件,这些文件中必须有一个 基础名 (即去掉路径部分)与模板名相同。如果没有文件名与模板名相同,则 Execute 调用失败,返回错误。例如:

package main

import (
    "log"
    "os"
    "text/template"
)

func main() {
    t := template.New("test")
    t, err := t.ParseFiles("test1")

    if err != nil {
        log.Fatal("Parse error:", err)
    }

    err = t.Execute(os.Stdout, nil)
    if err != nil {
        log.Fatal("Execute error:", err)
    }
}

上面代码先创建模板 test ,然后解析文件 test1 。执行该程序会出现下面的错误:

Execute error:template: test: "test" is an incomplete or empty template

Why?

我们先来看看模板的结构:

// src/text/template.go
type common struct {
    tmpl   map[string]*Template // Map from name to defined templates.
    option option
    muFuncs    sync.RWMutex // protects parseFuncs and execFuncs
    parseFuncs FuncMap
    execFuncs  map[string]reflect.Value
}

type Template struct {
    name string
    *parse.Tree
    *common
    leftDelim  string
    rightDelim string
}

模板结构 Template 中有一个字段 commoncommon 中又有一个字段 tmpl 保存名字到模板的映射。其实,最外层的 Template 结构是 主模板 ,我们调用 Execute 方法时执行的就是主模板。

执行 ParseFiles 方法时,每个文件都会生成一个模板。只有文件基础名与模板名相同时,该文件的内容才会解析到主模板中。这也是上面的程序执行失败的原因——主模板为空。

其它文件解析生成 关联模板 ,存储在字段 tmpl 中。关联模板可以是在主模板中通过 {{ define }} 动作定义,或者在非主模板文件中定义。关联模板也可以执行,但是需要使用 ExecuteTemplate 方法,显式传入模板名:

func main()
    t := template.New("test")
    t, err := t.ParseFiles("test1")
    
    if err != nil {
        log.Fatal("in associatedTemplate Parse error:", err)
    }
    
    err = t.ExecuteTemplate(os.Stdout, "test1", nil)
    if err != nil {
        log.Fatal("in associatedTemplate Execute error:", err)
    }
}

第二种方式将创建和解析两步合并在一起了。 template.ParseFiles 方法将传入的第一个文件名作为模板名称,其余的文件(如果有的话)解析后存放在 tmpl 中。

t, err := template.ParseFiles("file1", "file2", "file3")

其实就等价于:

t := template.New("file1")
t, err := t.ParseFiles("file1", "file2", "file3")

少了不一致的可能性,所以调用 Execute 方法时不会出现上面的错误。

还有一种创建方式,使用 ParseGlob 函数。 ParseGlob 会对匹配给定模式的所有文件进行语法分析。

func main() {
    t, err := template.ParseGlob("tmpl*.glob")
    if err != nil {
        log.Fatal("in globTemplate parse error:", err)
    }

    err = t.Execute(os.Stdout, nil)
    if err != nil {
        log.Fatal(err)
    }

    for i := 1; i <= 3; i++ {
        err = t.ExecuteTemplate(os.Stdout, fmt.Sprintf("tmpl%d.glob", i), nil)
        if err != nil {
            log.Fatal(err)
        }
    }
}

ParseGlob 返回的模板以匹配的第一个文件基础名作为名称。 ParseGlob 解析时会对同一个目录下的文件进行排序,所以第一个文件总是固定的。

我们创建三个模板文件, tmpl1.glob

In glob template file1.

tmpl2.glob

In glob template file2.

tmpl3.glob

In glob template file3.

最终输出为:

In glob template file1.
In glob template file1.
In glob template file2.
In glob template file3.

注意,如果多个不同路径下的文件名相同,那么后解析的会覆盖之前的。

嵌套模板

在一个模板文件中还可以通过 {{ define }} 动作定义其它的模板,这些模板就是 嵌套模板 。模板定义必须在模板内容的最顶层,像 Go 程序中的全局变量一样。

嵌套模板一般用于 布局(layout) 。很多文本的结构其实非常固定,例如邮件有标题和正文,网页有首部、正文和尾部等。

我们可以为这些固定结构的每部分定义一个模板。

定义模板文件 layout.tmpl

{{ define "layout" }}
This is body.
{{ template "content" . }}
{{ end }}

{{ define "content" }}
This is {{ . }} content.
{{ end }}

上面定义了两个模板 layoutcontentlayout 中使用了 content 。执行这种方式定义的模板必须使用 ExecuteTemplate 方法:

func main() {
    t, err := template.ParseFiles("layout.tmpl")
    if err != nil {
        log.Fatal("Parse error:", err)
    }

    err = t.ExecuteTemplate(os.Stdout, "layout", "amazing")
    if err != nil {
        log.Fatal("Execute error:", err)
    }
}

嵌套模板在网页布局中应用非常广泛,下一篇文章介绍 html/template 时还会讲到。

块动作

块动作其实就是定义一个默认模板,语法如下:

{{ block "name" arg }}
T1
{{ end }}

其实它就等价于定义一个模板,然后立即使用它:

{{ define "name" }}
T1
{{ end }}

{{ template "name" arg }}

如果后面定义了模板 content ,那么使用后面的定义,否则使用默认模板。

例如上面的示例中,我们将模板修改如下:

{{ define "layout" }}
This is body.
{{ block "content" . }}
This is default content.
{{ end }}
{{ end }}

去掉后面的 content 模板定义,执行 layout 时, content 部分会显示默认值。

总结

本文介绍了 Go 提供的模板 text/template 。模板比较简单易用,对于一些细节需要多加留意。代码在 Github 上。

参考链接

  1. Go Web 编程
  2. text/template 文档
我来评几句
登录后评论

已发表评论数()

相关站点

热门文章