
本文将深入探讨如何在Go语言中使用 html/template 包创建自定义格式化函数,并将其集成到模板中。我们将通过一个实际示例,解释 template.FormatterMap 的工作原理,以及如何编写符合其签名的格式化函数。此外,还将简要讨论如何修改 HTTP 处理函数以接受命令行参数。
自定义模板格式化函数
Go语言的 html/template 包提供了一种强大的方式来动态生成HTML内容。其中一个关键特性是能够使用自定义的格式化函数,通过 template.FormatterMap 将这些函数注册到模板中。
理解 template.FormatterMap
template.FormatterMap 是一个字符串到函数的映射,其中字符串是格式化函数的名称,函数是实际执行格式化的代码。这个映射的类型定义如下:
立即学习“go语言免费学习笔记(深入)”;
type FormatterMap map[string]func(io.Writer, interface{}, string)
这意味着,映射中的每个函数都必须接受三个参数:
io.Writer: 用于写入格式化后的输出。interface{}: 要格式化的值。string: 格式字符串(可选)。
示例分析
在提供的示例代码中,可以看到以下代码片段:
var fmap = template.FormatterMap{ "html": template.HTMLFormatter, "url+html": UrlHtmlFormatter,}
这里定义了一个名为 fmap 的 FormatterMap,它包含了两个格式化函数:
“html”: 使用 template.HTMLFormatter 进行HTML转义。”url+html”: 使用 UrlHtmlFormatter 函数,该函数自定义了URL转义和HTML转义的组合。
template.HTMLFormatter 函数可以直接使用,因为它已经符合 FormatterMap 的函数签名。然而,template.HTMLEscape 函数的签名是 func(w io.Writer, s []byte),与 FormatterMap 的函数签名不匹配。因此,需要一个包装器函数 UrlHtmlFormatter 来适应这个差异。
func UrlHtmlFormatter(w io.Writer, v interface{}, fmt string) { template.HTMLEscape(w, []byte(http.URLEscape(v.(string))))}
UrlHtmlFormatter 函数接收 io.Writer、interface{} 和 string 参数,然后将 interface{} 类型的值转换为字符串,进行URL转义,再将结果转换为字节数组,并使用 template.HTMLEscape 进行HTML转义,最后将转义后的内容写入 io.Writer。
为什么需要包装器函数?
template.FormatterMap 要求所有格式化函数具有相同的签名。由于 template.HTMLEscape 的签名不同,因此需要 UrlHtmlFormatter 作为一个适配器,将 template.HTMLEscape 包装起来,使其符合 FormatterMap 的要求。
使用自定义格式化函数
在模板中,可以使用 {@|url+html} 这样的语法来调用自定义的格式化函数。例如,以下模板片段:
@@##@@
会将变量 @ 的值进行URL转义和HTML转义,然后将其插入到 img 标签的 src 属性中。
修改 HTTP 处理函数以接受命令行参数
示例代码中的 QR 函数从 HTTP 请求的表单数据中获取参数值:
func QR(c *http.Conn, req *http.Request) { templ.Execute(req.FormValue("s"), c)}
要修改 QR 函数以接受命令行参数,可以执行以下步骤:
定义命令行标志: 在 main 函数之外,定义一个命令行标志,用于接收参数值。
var qrValue = flag.String("qr", "", "Text to QR Encode")
解析命令行标志: 在 main 函数中,调用 flag.Parse() 解析命令行标志。
func main() { flag.Parse() // ...}
修改 QR 函数: 修改 QR 函数,使其使用命令行标志的值,而不是从 HTTP 请求中获取。
func QR(c *http.Conn, req *http.Request) { templ.Execute(*qrValue, c)}
修改 HTTP 处理函数注册: 创建一个新的HTTP处理函数,将命令行参数传递给 QR 函数。
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { // 这里忽略了req参数,因为我们使用全局变量 *qrValue QR(w, r)})
完整示例
package mainimport ( "flag" "fmt" "html/template" "io" "log" "net/http" "net/url")var addr = flag.String("addr", ":1718", "http service address") // Q=17, R=18var qrValue = flag.String("qr", "", "Text to QR Encode")var fmap = template.FormatterMap{ "html": template.HTMLFormatter, "url+html": UrlHtmlFormatter,}var templ = template.MustParse(templateStr, fmap)func main() { flag.Parse() http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { QR(w, r) // 忽略了req参数 }) err := http.ListenAndServe(*addr, nil) if err != nil { log.Fatal("ListenAndServe:", err) }}func QR(w http.ResponseWriter, req *http.Request) { templ.Execute(*qrValue, w)}func UrlHtmlFormatter(w io.Writer, v interface{}, fmt string) { template.HTMLEscape(w, []byte(url.QueryEscape(fmt.Sprintf("%v", v))))}const templateStr = `QR Link Generator {.section @}@@##@@
{@|html}
{.end}`
现在,可以通过命令行参数 -qr 来指定要编码的文本,例如:
go run main.go -qr "Hello, world!"
总结
本文详细介绍了如何在Go语言中使用 html/template 包创建自定义格式化函数,并将其集成到模板中。通过理解 template.FormatterMap 的工作原理,可以编写符合其签名的格式化函数,从而扩展模板的功能。此外,还简要讨论了如何修改 HTTP 处理函数以接受命令行参数,使程序更加灵活。在实际应用中,可以根据需要自定义各种格式化函数,以满足不同的需求。


以上就是使用Go语言实现自定义模板格式化函数的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1393352.html
微信扫一扫
支付宝扫一扫