Golang轻松实现消息模板变量替换:text/template

发布于:2025-02-17 ⋅ 阅读:(107) ⋅ 点赞:(0)

text/template 是 Go 语言标准库中的一个包,用于生成文本输出。它通过解析模板并根据给定的数据执行模板来生成最终的文本。text/template 提供了强大的模板引擎,支持条件判断、循环、变量替换等功能。

基本概念

  1. 模板:模板是一个文本文件或字符串,其中包含一些特殊的占位符或控制结构,用于动态生成内容。
  2. 数据:数据是一个 Go 语言的结构体、映射或其他数据结构,模板引擎会根据这些数据来填充模板中的占位符。
  3. 动作:动作是模板中的特殊语法,用于控制模板的解析和执行过程。动作以 {{ 开始,以 }} 结束。

模板语法

1. 变量替换

最简单的模板动作是变量替换。使用 {{.}} 来表示当前上下文的根对象,使用 {{.FieldName}} 来访问结构体的字段。

package main

import (
	"os"
	"text/template"
)

type Person struct {
	Name string
	Age  int
}

func main() {
	p := Person{Name: "Alice", Age: 30}
	tmpl := "Name: {{.Name}}, Age: {{.Age}}\n"
	t := template.Must(template.New("person").Parse(tmpl))
	t.Execute(os.Stdout, p)
}

输出:

Name: Alice, Age: 30
2. 条件判断

text/template 支持 if-else 条件判断。

package main

import (
	"os"
	"text/template"
)

type Person struct {
	Name string
	Age  int
}

func main() {
	p := Person{Name: "Alice", Age: 30}
	tmpl := "{{if gt .Age 18}}Adult{{else}}Child{{end}}\n"
	t := template.Must(template.New("person").Parse(tmpl))
	t.Execute(os.Stdout, p)
}

输出:

Adult
3. 循环

text/template 支持 range 循环,用于遍历数组、切片或映射。

package main

import (
	"os"
	"text/template"
)

type Person struct {
	Name    string
	Hobbies []string
}

func main() {
	p := Person{Name: "Alice", Hobbies: []string{"Reading", "Swimming", "Coding"}}
	tmpl := "Name: {{.Name}}\nHobbies:\n{{range .Hobbies}}- {{.}}\n{{end}}"
	t := template.Must(template.New("person").Parse(tmpl))
	t.Execute(os.Stdout, p)
}

输出:

Name: Alice
Hobbies:
- Reading
- Swimming
- Coding
4. 函数调用

text/template 支持在模板中调用自定义函数。

package main

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

type Person struct {
	Name string
}

func main() {
	p := Person{Name: "Alice"}
	funcMap := template.FuncMap{
		"ToUpper": strings.ToUpper,
	}
	tmpl := "Name: {{.Name | ToUpper}}\n"
	t := template.Must(template.New("person").Funcs(funcMap).Parse(tmpl))
	t.Execute(os.Stdout, p)
}

输出:

Name: ALICE
5. 嵌套模板

text/template 支持模板嵌套,可以使用 definetemplate 动作来定义和引用嵌套模板。

package main

import (
	"os"
	"text/template"
)

type Person struct {
	Name string
}

func main() {
	p := Person{Name: "Alice"}
	tmpl := `{{define "T1"}}Hello, {{.Name}}!{{end}}{{template "T1" .}}`
	t := template.Must(template.New("person").Parse(tmpl))
	t.Execute(os.Stdout, p)
}

输出:

Hello, Alice!

模板解析和执行过程

  1. 解析模板:使用 template.New 创建一个新的模板对象,然后使用 ParseParseFiles 方法解析模板内容。
  2. 执行模板:使用 ExecuteExecuteTemplate 方法执行模板,并将结果写入指定的输出流(如 os.Stdout 或文件)。

错误处理

在解析和执行模板时,可能会遇到错误。可以使用 Must 函数来简化错误处理,如果解析或执行过程中出现错误,Must 会直接抛出 panic。

t := template.Must(template.New("person").Parse(tmpl))

网站公告

今日签到

点亮在社区的每一天
去签到