golang html/template模板中使用自定义函数/方法的2种方法总结
在golang的html/template模板库中我们如果希望在视图文件中调用自定义的函数 或者方法可以通过以下2种方法实现：
1. 调用自定义函数
可通过将自定义的函数加入到 template.FuncMap中，然后再使用 template.New("xxx.html").Funcs(funcMap)来在指定的模板中使用自定义函数,如：
func MyFormat(t time.Time) string {//t, _ := time.Parse(DF, time.Now().GoString()) // 演示 将字符串解析为时间对象tstr := fmt.Sprintf("%v", t.Format(DF))return tstr // 返回格式后的时间字符串
}func indexHandler(w http.ResponseWriter, r *http.Request) {// 将自定义的函数放入到模板的FuncMap中fmap := template.FuncMap{"mfc": MyFormat}tpl := template.New("abc.html").Funcs(fmap) // 将自定义函数绑定到模板函数map里面tpl, err := tpl.ParseFiles("views/abc.html") if err != nil || tpl == nil {w.WriteHeader(http.StatusNotFound) // 返回404错误 http.StatusNotFoundw.Write([]byte(fmt.Sprintf("%v", err))) // 将错误信息输出到浏览器return // 这里必须中断后面的代码执行}// tpl.Execute 将解析后的模板和数据绑定tpl.Execute(w,"hello world")
}
2. 调用自定义的方法
这个最简单，不需要使用FuncMap绑定，直接将要调用的对象作为数据data传入模板，然后直接调用对象的方法即可，如：
// 创建一个自定义对象
type DemoFlighter struct {Name string `json:"name"`
}// 对象DemoFlighter的方法
func (s *DemoFlighter) Flight(dst string, n int) string {return fmt.Sprintf("%v正在以每秒%v公里的速度向%v前进!\n", s.Name, dst, n)
}func indexHandler(w http.ResponseWriter, r *http.Request) {tpl, _ := tpl.ParseFiles("views/abc.html") // 定义并初始化一个数据对象data 在视图文件中可通过 .字段名 来访问这里定义的字段,如 .Title 就可访问这里的Title字段// 如果是在模板中访问对象的方法则调用语法为 .Obj.Method [参数] 如: .Ts.Year 即可访问Ts对象中的Year函数 注意不要小括号var data = struct {Title stringTs time.TimeFlighter *DemoFlighter}{Title: "GO模板自定义函数使用示例", Ts: time.Now(), Flighter: &DemoFlighter{Name: "Alex"},}// tpl.Execute 将解析后的模板和数据绑定if err = tpl.Execute(w, data); err != nil {w.WriteHeader(http.StatusInternalServerError) // 返回500 http.StatusInternalServerError错误w.Write([]byte(fmt.Sprintf("%v", err))) //输出错误到浏览器return}
}
注意，golang中函数和方法可是不同的东西，虽然他们的实现都一样，可是定义却不一样！
main启动入口方法
func main() {// :8090 表示服务绑定在当前所有可用IP上,端口为8090server := http.Server{Addr: ":8090"}// 将 / 路由请求交给 indexHandler 这个函数来处理http.HandleFunc("/", indexHandler) // 路由配置//启动服务if err := server.ListenAndServe(); err != nil {fmt.Println("服务启动失败:", err)}
}
视图文件views/abc.html：
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>{{.Title}}</title>
</head><body>当前时间: {{.Ts }}<br>{{.Ts.Year}}<br>{{.Ts.Month}}<br>{{.Ts.Day}}<br>自定义函数格式后的时间: {{ mfc .Ts }}<br><h2>对象调用示例</h2>对象属性调用: {{.Flighter.Name }}<br>对象方法调用示例: 多个参数以空格分隔<br>{{.Flighter.Flight "昆明" 888 }}<br>
</body>
</html>总结：
第一种方式调用自定义的函数 需要使用template.FuncMap绑定等操作，且不方便扩展和维护，仅适合对于通用的工具类函数进行调用， 如非通用工具类调用，则推荐使用 调用自定义方法的方式来进行自定义方法的调用