Go 示例: 文本模板

Go 提供了内置支持,可以使用 text/template 包创建动态内容或向用户显示自定义输出。名为 html/template 的姊妹包提供了相同的 API,但具有额外的安全功能,应用于生成 HTML。

package main
import (
    "os"
    "text/template"
)
func main() {

我们可以创建一个新的模板,并从字符串中解析其内容。模板是静态文本和包含在 {{...}} 中的“操作”的混合,用于动态插入内容。

    t1 := template.New("t1")
    t1, err := t1.Parse("Value is {{.}}\n")
    if err != nil {
        panic(err)
    }

或者,我们可以使用 template.Must 函数,如果 Parse 返回错误,则会引发恐慌。这对于在全局范围内初始化的模板特别有用。

    t1 = template.Must(t1.Parse("Value: {{.}}\n"))

通过“执行”模板,我们使用其操作的特定值生成其文本。{{.}} 操作将被替换为传递给 Execute 的参数值。

    t1.Execute(os.Stdout, "some text")
    t1.Execute(os.Stdout, 5)
    t1.Execute(os.Stdout, []string{
        "Go",
        "Rust",
        "C++",
        "C#",
    })

我们将使用下面的辅助函数。

    Create := func(name, t string) *template.Template {
        return template.Must(template.New(name).Parse(t))
    }

如果数据是结构体,我们可以使用 {{.FieldName}} 操作来访问其字段。字段应导出,以便在执行模板时可访问。

    t2 := Create("t2", "Name: {{.Name}}\n")
    t2.Execute(os.Stdout, struct {
        Name string
    }{"Jane Doe"})

映射也是如此;对于映射,键名称的大小写没有限制。

    t2.Execute(os.Stdout, map[string]string{
        "Name": "Mickey Mouse",
    })

if/else 为模板提供条件执行。如果一个值是类型的默认值(例如 0、空字符串、空指针等),则该值被认为是 false。此示例演示了模板的另一个功能:在操作中使用 - 来修剪空白。

    t3 := Create("t3",
        "{{if . -}} yes {{else -}} no {{end}}\n")
    t3.Execute(os.Stdout, "not empty")
    t3.Execute(os.Stdout, "")

range 块允许我们循环遍历切片、数组、映射或通道。在 range 块内,{{.}} 设置为当前迭代项。

    t4 := Create("t4",
        "Range: {{range .}}{{.}} {{end}}\n")
    t4.Execute(os.Stdout,
        []string{
            "Go",
            "Rust",
            "C++",
            "C#",
        })
}
$ go run templates.go 
Value: some text
Value: 5
Value: [Go Rust C++ C#]
Name: Jane Doe
Name: Mickey Mouse
yes 
no 
Range: Go Rust C++ C# 

下一个示例:正则表达式.