ange .}}的"."代表的是p.Friends,也就是各个,再此range中又有一层迭代,此内层{{.Fname}}
的点代表Friend结构的实例,分别是&f1
和&f2
,所以{{.Fname}}
代表实例对象的Fname字段。
去除空白
template引擎在进行替换的时候,是完全按照文本格式进行替换的。除了需要评估和替换的地方,所有的行分隔符、空格等等空白都原样保留。所以,对于要解析的内容,不要随意缩进、随意换行。
可以在{{
符号的后面加上短横线并保留一个或多个空格"- "来去除它前面的空白(包括换行符、制表符、空格等),即{{- xxxx
。
在}}
的前面加上一个或多个空格以及一个短横线"-"来去除它后面的空白,即xxxx -}}
。
例如:
{{23}} < {{45}} -> 23 < 45
{{23}} < {{- 45}} -> 23 <45
{{23 -}} < {{45}} -> 23< 45
{{23 -}} < {{- 45}} -> 23<45
其中{{23 -}}
中的短横线去除了这个替换结构后面的空格,即}} <
中间的空白。同理{{- 45}}
的短横线去除了< {{
中间的空白。
再看上一节的例子中:
t.Parse(
`hello {{.UserName}}!
{{ range .Emails }}
an email {{ . }}
{{- end }}
{{ with .Friends }}
{{- range . }}
my friend name is {{.Fname}}
{{- end }}
{{ end }}`)
注意,上面没有进行缩进。因为缩进的制表符或空格在替换的时候会保留。
第一行和第二行之间输出时会换行输出,不仅如此,range {{.Emails}}
自身也占一行,在替换的时候它会被保留为空行。除非range前面没加{{-
。由于range的{{- end
加上了去除前缀空白,所以每次迭代的时候,每个元素之间都换行输出但却不多一空行,如果这里的end去掉{{-
,则每个迭代的元素之间输出的时候都会有空行。同理后面的with和range。
注释
注释方式:{{/* a comment */}}
。
注释后的内容不会被引擎进行替换。但需要注意,注释行在替换的时候也会占用行,所以应该去除前缀和后缀空白,否则会多一空行。
{{- /* a comment without prefix/suffix space */}}
{{/* a comment without prefix/suffix space */ -}}
{{- /* a comment without prefix/suffix space */ -}}
注意,应该只去除前缀或后缀空白,不要同时都去除,否则会破坏原有的格式。例如:
t.Parse(
`hello {{.UserName}}!
{{- /* this line is a comment */}}
{{ range .Emails }}
an email {{ . }}
{{- end }}
管道pipeline
pipeline是指产生数据的操作。比如{{.}}
、{{.Name}}
、funcname args
等。
可以使用管道符号|
链接多个命令,用法和unix下的管道类似:|
前面的命令将运算结果(或返回值)传递给后一个命令的最后一个位置。
例如:
{{.}} | printf "%s\n" "abcd"
{{.}}
的结果将传递给printf,且传递的参数位置是"abcd"之后。
命令可以有超过1个的返回值,这时第二个返回值必须为err类型。
需要注意的是,并非只有使用了|
才是pipeline。Go template中,pipeline的概念是传递数据,只要能产生数据的,都是pipeline。这使得某些操作可以作为另一些操作内部的表达式先运行得到结果,就像是Unix下的命令替换一样。
例如,下面的(len "output")
是pipeline,它整体先运行。
{{println (len "output")}}
下面是Pipeline的几种示例,它们都输出"output"
:
{{`"output"`}}
{{printf "%q" "output"}}
{{"output" | printf "%q"}}
{{printf "%q" (print "out" "put")}}
{{"put" | printf "%s%s" "out" | printf "%q"}}
{{"output" | printf "%s" | printf "%q"}}
变量
可以在template中定义变量:
// 未定义过的变量
$var := pipeline
// 已定义过的变量
$var = pipeline
例如:
{{- $how_long :=(len "output")}}
{{- println $how_long}} // 输出6
再例如:
tx := template.Must(template.New("hh").Parse(
`{{range $x := . -}}
{{$y := 333}}
{{- if (gt $x 33)}}{{println $x $y ($z := 444)}}{{- end}}
{{- end}}
`))
s := []int{11, 22, 33, 44, 55}
_ = tx.Execute(os.Stdout, s)
输出结果:
44 333 444
55 333 444
上面的示例中,使用range迭代slice,每个元素都被赋值给变量$x
,每次迭代过程中,都新设置一个变量$y
,在内层嵌套的if结构中,可以使用这个两个外层的变量。在if的条件表达式中,使用了一个内置的比较函数gt,如果$x
大于33,则为true。在println的参数中还定义了一个$z
,之所以能定义,是因为($z := 444)
的过程是一个Pipeline,可以先运行。
需要注意三点:
- 变量有作用域,只要出现end,则当前层次的作用域结束。内层可以访问外层变量,但外层不能访问内层变量。
- 有一个特殊变量
$
,它代表模板的最顶级作用域对象(通俗地理解,是以模板为全局作用域的全局变量),在Execute()执行的时候进行赋值,且一直不变。例如上面的示例中,$ = [11 22 33 44 55]
。再例如,define定义了一个模板t1,则t1中的$
作用域只属于这个t1。
- 变量不可在模板之间继承。普通变量可能比较容易理解,但对于特殊变量"."和"$",比较容易搞混。见下面的例子。
例如:
func main() {
t1 := template.New("test1")
tmpl, _ := t1.Parse(
`
{{- define &