Go语言 template 自定义函数用法详解

原理与准备

在使用模板时，有时内置操作不足以满足需求（如复杂的字符串处理或特定的时间格式）。我们可以编写Go函数，并通过 template.FuncMap 将其挂载到模板对象上。这样在模板语法中就可以像调用内置函数一样调用这些自定义函数，且支持管道风格（Pipe Style）调用。

操作步骤

第1步：定义数据结构与自定义函数

首先定义需要渲染的数据结构（如用户信息），并创建用于处理的Go函数。例如，定义一个函数用于格式化时间：

package main

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

// 定义数据模型
type User struct {
	Username, Password string
	RegTime time.Time
}

// 自定义函数：接收时间和格式字符串，返回格式化后的字符串
func ShowTime(t time.Time, format string) string {
	return t.Format(format)
}

第2步：构建模板并绑定函数

使用 template.New 创建新模板，并通过 .Funcs() 方法传入 template.FuncMap 字典，将Go函数名映射到模板中可用的名称。随后解析模板字符串：

u := User{"dotcoo", "dotcoopwd", time.Now()}

// 1. 创建名为 "text" 的模板
// 2. 绑定自定义函数 showtime 
// 3. 解析模板内容
t, err := template.New("text").Funcs(template.FuncMap{
	"showtime": ShowTime,
}).Parse(`
{{.Username}}|{{.Password}}|{{.RegTime.Format "2006-01-02 15:04:05"}}
{{.Username}}|{{.Password}}|{{showtime .RegTime "2006-01-02 15:04:05"}}
`)

if err != nil {
	panic(err)
}

第3步：执行模板并输出结果

调用 Execute 方法，传入数据结构和输出目标（如标准输出 os.Stdout）：

t.Execute(os.Stdout, u)

完成判断与排错

• 正确结果：程序运行后，控制台应打印出两行包含用户名、密码和时间戳的HTML片段。第一行使用内置 Format 方法，第二行使用自定义 showtime 函数，两者输出应一致。
• 常见错误：如果报错 function "showtime" not defined，请检查是否在 .Funcs() 中正确注册了该函数，且模板内的调用名称是否与注册时的Key一致。

总结

通过 FuncMap 注册自定义函数，可以让Go模板的处理能力无限扩展。这种管道风格的调用方式不仅简洁，还能有效分离业务逻辑与视图展示。以上就是Go语言template自定义函数用法的详细内容，更多关于Go模板开发的资料请关注本站其它相关文章！