模板引擎默认使用了 {{
和 }}
作为左右闭合标签,开发者可通过gview.SetDelimiters
方法设置自定义的模板闭合标签。
使用 .
来访问当前对象的值(模板局部变量)。
使用 $
来引用当前模板根级的上下文(模板全局变量)。
使用 $var
来访问特定的模板变量。
模板中支持的 go
语言符号
Code Block |
---|
|
{{"string"}} // 一般 string
{{`raw string`}} // 原始 string
{{'c'}} // byte
{{print nil}} // nil 也被支持 |
模板中的 pipeline
可以是上下文的变量输出,也可以是函数通过管道传递的返回值
Code Block |
---|
|
{{. | FuncA | FuncB | FuncC}} |
当pipeline
的值等于:
false
或0
nil的指针
或interface
- 长度为
0
的array
, slice
, map
, string
那么这个pipeline
被认为是空。
Note |
---|
需要注意:在gf 模板引擎中,当模板中展示的指定变量不存在时,将会显示为空(标准库模板引擎会展示<no value> )。 |
if … else … end
Code Block |
---|
|
{{if pipeline}}...{{end}} |
if
判断时,pipeline
为空时,相当于判断为false
。
支持嵌套的循环
Code Block |
---|
|
{{if .condition}}
...
{{else}}
{{if .condition2}}
...
{{end}}
{{end}} |
也可以使用else if
进行
Code Block |
---|
|
{{if .condition}}
...
{{else if .condition2}}
...
{{else}}
...
{{end}} |
range … end
Code Block |
---|
|
{{range pipeline}} {{.}} {{end}} |
pipeline
支持的类型为slice
, map
, channel
。
注意:在range
循环内部,.
符号会被覆盖为以上类型的子元素(局部变量)。如果想在循环中访问外部变量(全局变量),请加上$
符号,如:{{$.Session.Name}}
此外,对应的值长度为0
时,range
不会执行,.
不会改变。
例如,遍历map
:
Code Block |
---|
|
{{range $key, $value := .MapContent}}
{{$key}}:{{$value}}
{{end}} |
例如,遍历slice
:
Code Block |
---|
|
{{range $index, $elem := .SliceContent}}
{{range $key, $value := $elem}}
{{$key}}:{{$value}}
{{end}}
{{end}} |
with … end
Code Block |
---|
|
{{with pipeline}}...{{end}} |
with
用于重定向pipeline
Code Block |
---|
|
{{with .Field.NestField.SubField}}
{{.Var}}
{{end}} |
define
define
可以用来自定义模板内容块(给一段模板内容定义一个模板名称),可用于模块定义和模板嵌套(使用在template
标签中)。
Code Block |
---|
|
{{define "loop"}}
<li>{{.Name}}</li>
{{end}} |
其中loop
为该模板内容块的名称,随后可使用 template
标签调用模板:
Code Block |
---|
|
<ul>
{{range .Items}}
{{template "loop" .}}
{{end}}
</ul> |
Note |
---|
define 标签需要结合template 标签一起使用,并且支持跨模板使用(在同一模板目录/子目录下有效,原理是使用的ParseFiles 方法解析模板文件)。
|
template
Code Block |
---|
|
{{template "模板名称" pipeline}} |
将对应的上下文pipeline
传给模板,才可以在模板中调用。
注意:template
标签参数为模板名称
,而不是模板文件路径,template
标签不支持模板文件路径。
Note |
---|
template 标签需要结合define 标签一起使用,并且支持跨模板使用(在同一模板目录/子目录下有效,原理是使用的ParseFiles 方法解析模板文件)。
|
include
该标签为gf
框架模板引擎新增标签
Code Block |
---|
|
{{include "模板文件名(需要带完整文件名后缀)" pipeline}} |
在模板中可以使用include
标签载入其他模板(任意路径),模板文件名支持相对路径以及文件的系统绝对路径。如果想要把当前模板的模板变量传递给子模板(嵌套模板),可以这样:
Code Block |
---|
|
{{include "模板文件名(需要带完整文件名后缀)" .}} |
与template
标签的区别是:include
仅支持文件路径,不支持模板名称;而tempalte
标签仅支持模板名称,不支持文件路径。
注释
允许多行文本注释,不允许嵌套。
Code Block |
---|
|
{{/*
comment content
support new line
*/}} |
移除空格换行符
使用{{-语法去除模板内容左侧的所有空白符号, 使用-}}去除模板内容右侧的所有空白符号。
注意:-要紧挨{{和}},同时与模板值之间需要使用空格分隔。
Code Block |
---|
|
{{- .Name -}}
{{- range $key, $value := .list}}
"{{$value}}"
{{- end}} |