golang 模板语法使不解析html标签及特殊字符

场景

有时候需要使用go的模板语法,比如说用go 去渲染html页面的时候,再比如说用go的模板搞代码生成的时候。这时候可能会遇到一个麻烦,不想转译的特殊字符被转译了。

我遇到的情况是写代码生成器的时候,‘<’ 符号被转译了,导致channel 相关的部分有问题。

这个问题很简单,但是资料不多,我也是试了半天才发现。其实把包含特殊字符的字符串 先转成 template.HTML 类型再加载到文件里 就可以了。

解决

先看代码

	t := template.New("initMysql")
    
    type NsqConsumerTpl struct {
		Names        []string
		AngleBracket template.HTML
	}
	
	v := NsqConsumerTpl{
	    Names: nsqConsumerIns, 
	    AngleBracket:template.HTML("<")
	    
	}
		

这里首先声明了一个模板,然后声明一个结构体,用于在模板里的渲染。 其AngleBracket 字段即为一个 在模板里 不被转译的特殊字符字段。这里我用来放‘<’了.

下面的这段代码,声明一段模板,然后模板内直接引用 这个字段即可,此时 ‘<’ 不会被转译。

    tpl := `func (p *NsqConsumerMgr) Start() error {
    	{{range .Names}}
    	err := p.{{.}}.ConnectToNSQLookupds(p.{{.}}.LookupAddr)
    	if err != nil {
    		panic(err)
    	}
    	{{end}}
    
    	ch := make(chan bool)
    	{{ .AngleBracket }}-ch
    	return nil
    }`

    t.Execute(tpl, v)

如果不只一个地方使用的话,可以提出来一个函数

定义函数,函数内容很简单,把str转成temp.HTML类型。

func unescaped (str string) template.HTML { return template.HTML(str) }

把函数注册到模板:

	t = t.Funcs(template.FuncMap{"unescaped": unescaped})

这时候,用于渲染的结构体,特殊字符也可以直接用string

    type NsqConsumerTpl struct {
		Names        []string
		AngleBracket string
	}

模板内使用稍有不同,{{ .AngleBracket | unescaped}} 这一句的意思是: 通过 通道(类似linux 通道的概念)把AngleBracket 作为参数,传给unescaped 函数。

func (p *NsqConsumerMgr) Start() error {
	{{range .Names}}
	err := p.{{.}}.ConnectToNSQLookupds(p.{{.}}.LookupAddr)
	if err != nil {
		panic(err)
	}
	{{end}}

	ch := make(chan bool)
	{{ .AngleBracket | unescaped}}-ch
	return nil
}
    t.Execute(tpl, v)

说起来比较简单,但是资料很少,查起来比较费劲,于是总结与此,分享一下。
欢迎补充

有收获记得点赞哦~

原文地址:https://www.cnblogs.com/mingbai/p/goTmpl.html