在使用golang的template时,我们经常会遇到一些需要转义的情况,例如html中的一些特殊字符(如)需要被转义为对应的html实体,否则可能会对前端页面造成安全性风险等问题。
在golang中提供了两种方法进行template的转义,分别是自动转义和手动转义。
自动转义
在golang中,使用{{}}包含需要替换的内容作为占位符,例如模板代码如下:
package main
import (
"html/template"
"os"
)
func main() {
tpl, err := template.New("test").Parse(`{{.}}`)
if err != nil {
panic(err)
}
err = tpl.Execute(os.Stdout, "")
if err != nil {
panic(err)
}
}输出结果为:
立即学习“go语言免费学习笔记(深入)”;
zuojiankuohaophpcnscriptyoujiankuohaophpcnalert('hello');zuojiankuohaophpcn/scriptyoujiankuohaophpcn可以看到,golang在输出结果时自动将和转义为了HTML实体zuojiankuohaophpcn和youjiankuohaophpcn,避免了执行不安全的脚本。
手动转义
在有些情况下,我们可能需要手动转义模板输出的内容,例如HTML中的特殊字符不一定需要全部转义,而只需要转义对应字符,或者在模板中输出一些自定义的格式而不是HTML字符串。
这时我们可以使用html/template包中的HTMLEscapeString和JSEscapeString函数进行手动转义。
HTMLEscapeString函数用于将字符串中的HTML实体转义,例如:
package main
import (
"html/template"
"os"
)
func main() {
tpl, err := template.New("test").Parse(`{{.}}`)
if err != nil {
panic(err)
}
data := ""
data = template.HTMLEscapeString(data)
err = tpl.Execute(os.Stdout, data)
if err != nil {
panic(err)
}
}输出结果为:
立即学习“go语言免费学习笔记(深入)”;
zuojiankuohaophpcnscriptyoujiankuohaophpcnalert('hello');zuojiankuohaophpcn/scriptyoujiankuohaophpcnJSEscapeString函数用于将字符串中的特殊字符转义为可安全嵌入HTML或JavaScript中的字符,例如:
package main
import (
"html/template"
"os"
)
func main() {
tpl, err := template.New("test").Parse(`{{.}}`)
if err != nil {
panic(err)
}
data := ""
data = template.JSEscapeString(data)
err = tpl.Execute(os.Stdout, data)
if err != nil {
panic(err)
}
}输出结果为:
立即学习“go语言免费学习笔记(深入)”;
u003cscriptu003ealert(u0027hellou0027);u003c/scriptu003e
由于在JavaScript中和>是字符串参数的开始和结束标记,因此在JSEscapeString函数中也会被转义为Unicode字符。
总结
在使用golang的template时,我们可以使用自动转义或手动转义的方式对模板输出进行转义处理,避免一些潜在的安全性问题。自动转义可以使用{{}}包含需要替换的内容来实现,而手动转义可以使用HTMLEscapeString和JSEscapeString函数。










