本文介绍了在使用 Go 模板引擎向 JavaScript 代码中动态插入变量时，如何避免字符串值被自动添加引号的问题。通过使用字符串指针以及理解 Go 模板引擎的处理机制，可以实现将 null 或字符串值正确地传递到 JavaScript 环境中。
在使用 Go 模板引擎生成 HTML，特别是嵌入 JavaScript 代码时，经常会遇到需要动态插入变量的情况。一个常见的问题是，当变量为字符串类型时，Go 模板引擎会自动用引号将其包裹，这在某些场景下是不希望发生的，例如需要插入 null 值或者已经包含引号的 HTML 片段。
以下是如何解决这个问题的详细步骤和解释：
使用字符串指针
立即学习“Java免费学习笔记（深入）”；
Go 语言中的字符串类型是值类型，不能为 nil。如果需要表示一个可能为空的字符串，应该使用字符串指针 *string。通过将模板数据中的字段定义为字符串指针，可以传递 nil 值到模板中，从而在 JavaScript 中生成 null。
示例代码
package main
import (
"html/template"
"log"
"os"
)
type TemplateData struct {
Email *string
}
func main() {
const temp = "<script>var email = {{.Email}};</script>\n"
t := template.Must(template.New("email_template").Parse(temp))
email := "<a class=\"__cf_email__\" data-cfemail=\"e1928e8c84838e8598a1928e8c849689849384cf828e8c\" href=\"/cdn-cgi/l/email-protection\">[email protected]</a>"
err := t.Execute(os.Stdout, TemplateData{
Email: &email,
})
if err != nil {
log.Println("executing template:", err)
}
err = t.Execute(os.Stdout, TemplateData{
Email: nil,
})
if err != nil {
log.Println("executing template:", err)
}
}代码解释
- 定义模板数据结构体: TemplateData 结构体包含一个 Email 字段，类型为 *string (字符串指针)。
- 模板定义: const temp = "<script>var email = {{.Email}};</script>\n" 定义了一个简单的模板，用于生成 JavaScript 代码。{{.Email}} 是一个占位符，用于插入 Email 字段的值。
- 模板解析: t := template.Must(template.New("email_template").Parse(temp)) 解析模板字符串并创建一个模板对象。template.Must 函数用于处理解析错误，如果解析失败则会 panic。
-
执行模板:
- email := "<a class=\"__cf_email__\" data-cfemail=\"e1928e8c84838e8598a1928e8c849689849384cf828e8c\" href=\"/cdn-cgi/l/email-protection\">[email protected]</a>" 定义了一个包含 HTML 的字符串。
- err := t.Execute(os.Stdout, TemplateData{Email: &email}) 执行模板，将 email 字符串的指针传递给模板。这会将 HTML 代码片段插入到 JavaScript 代码中，而不会添加额外的引号。
- err := t.Execute(os.Stdout, TemplateData{Email: nil}) 执行模板，将 nil 传递给模板。这会在 JavaScript 代码中生成 var email = <nil>;，Go 模板会将 nil 转换为 <nil> 字符串，如果需要输出 null，还需要配合自定义模板函数进行处理（见下文）。
注意事项
- 空字符串与 nil: 如果将 Email 字段定义为 string 类型，即使不赋值，其默认值也是空字符串 ""，而不是 nil。这将导致在 JavaScript 中生成 var email = "";。
- HTML 注入: 直接将 HTML 代码插入到 JavaScript 中需要注意安全性，确保 HTML 代码的来源可信，避免跨站脚本攻击 (XSS)。可以使用 Go 模板引擎提供的转义函数来防止 XSS 攻击。
- 自定义模板函数: 如果需要更灵活的控制输出，例如将 nil 值转换为 JavaScript 中的 null，可以自定义模板函数。
自定义模板函数示例
package main
import (
"html/template"
"log"
"os"
)
type TemplateData struct {
Email *string
}
func main() {
const temp = "<script>var email = {{.Email | jsNull}};</script>\n"
funcMap := template.FuncMap{
"jsNull": func(s *string) interface{} {
if s == nil {
return template.JS("null")
}
return template.JS(*s)
},
}
t := template.Must(template.New("email_template").Funcs(funcMap).Parse(temp))
email := "<a class=\"__cf_email__\" data-cfemail=\"e1928e8c84838e8598a1928e8c849689849384cf828e8c\" href=\"/cdn-cgi/l/email-protection\">[email protected]</a>"
err := t.Execute(os.Stdout, TemplateData{
Email: &email,
})
if err != nil {
log.Println("executing template:", err)
}
err = t.Execute(os.Stdout, TemplateData{
Email: nil,
})
if err != nil {
log.Println("executing template:", err)
}
}代码解释
- 定义自定义函数: funcMap := template.FuncMap{ ... } 定义了一个函数映射，将 jsNull 函数与模板中的 jsNull 名称关联起来。
- jsNull 函数: jsNull 函数接收一个字符串指针作为参数。如果指针为 nil，则返回 template.JS("null")，否则返回字符串指针指向的值。template.JS 类型用于告诉模板引擎，该字符串已经过 JavaScript 转义，不需要再次转义。
- 注册自定义函数: t := template.Must(template.New("email_template").Funcs(funcMap).Parse(temp)) 将自定义函数映射注册到模板中。
- 在模板中使用自定义函数: {{.Email | jsNull}} 在模板中使用管道符 | 将 Email 字段的值传递给 jsNull 函数。
总结
通过使用字符串指针和自定义模板函数，可以有效地控制 Go 模板引擎的输出，避免字符串被自动添加引号的问题，从而实现将 null 或包含 HTML 代码的字符串正确地插入到 JavaScript 代码中。请务必注意安全性，并对 HTML 代码进行适当的转义，以防止 XSS 攻击。
