35.3 模板语法

模板标签

  • {{ }}
  • 模板标签用"{{"和"}}"括起来。

注释

  • {{/* a comment */}}
  • 使用{{/ /}}来包含注释内容。

变量

  • {{.}}
  • 此标签输出当前对象的值。
  • {{.Admpub}}:表示输出对象中字段或方法名称为Admpub的值。 当Admpub是匿名字段时,可以访问其内部字段或方法, 如"Com":{{.Admpub.Com}} ,如果Com是一个方法并返回一个结构体对象,同样也可以访问其字段或方法:{{.Admpub.Com.Field1}}<span> </span>
  • {{.Method1 "参数值1" "参数值2"}}:调用方法Method1,将后面的参数值依次传递给此方法,并输出其返回值。
  • {{$admpub}}:此标签用于输出在模板中定义的名称为"admpub"的变量。当$admpub本身是一个结构体对象时,可访问其字段{{$admpub.Field1}}
  • 在模板中定义变量,变量名称用字母和数字组成,并带上$前缀,采用简式赋值。例如:<span> </span>{{$x := "OK"}}{{$x := pipeline}}<span> </span>

通道函数

  • {{FuncName1}}:此标签将调用名称为"FuncName1"的模板函数(等同于执行"FuncName1()",不传递任何参数)并输出其返回值。
  • {{FuncName1 "参数值1" "参数值2"}}:此标签将调用FuncName1("参数值1", "参数值2"),并输出其返回值。
  • {{.Admpub|FuncName1}}:此标签将调用名称为"FuncName1"的模板函数(等同于执行"FuncName1(this.Admpub)",将竖线"|"左边的".Admpub"变量值作为函数参数传送)并输出其返回值。

条件判断

  • {{if pipeline}} T1 {{end}}:标签结构为<span> </span>{{if ...}} ... {{end}}
  • {{if pipeline}} T1 {{else}} T0 {{end}}:标签结构为<span> </span>{{if ...}} ... {{else}} ... {{end}}
  • {{if pipeline}} T1 {{else if pipeline}} T0 {{end}}:标签结构为<span> </span>{{if ...}} ... {{else if ...}} ... {{end}}。 其中if后面可以是一个条件表达式(包括通道函数表达式),也可以是一个字符窜变量或布尔值变量。当为字符窜变量时,如为空字符串则判断为false,否则判断为true。

循环遍历

  • {{range $k, $v := .Var}} {{$k}} => {{$v}} {{end}}:range...end结构内部如要使用外部的变量,如.Var2,需要写为:$.Var2(即在外部变量名称前加符号$)。
  • {{range .Var}} {{.}} {{end}}:将遍历值直接显示出来。
  • {{range pipeline}} T1 {{else}} T0 {{end}}:当没有可遍历的值时,将执行else部分。

嵌入子模板

  • {{template "name"}}:嵌入名称为"name"的子模板。使用前请确保已经用<span> </span>{{define "name"}}子模板内容{{end}}定义好了子模板内容。
  • {{template "name" pipeline}}:将通道的值赋给子模板中的"."(即"{{.}}")。

子模板嵌套

  • {{define "T1"}}ONE{{end}}
    {{define "T2"}}TWO{{end}}
    {{define "T3"}}{{template "T1"}} {{template "T2"}}{{end}}
    {{template "T3"}}
    
  • 输出如下: ONE TWO

定义局部变量

  • {{with pipeline}} T1 {{end}}
  • 通道的值将赋给该标签内部的"."。(注:这里的“内部”一词是指被{{with pipeline}}...{{end}}包围起来的部分,即T1所在位置)
  • {{with pipeline}} T1 {{else}} T0 {{end}} 如果通道的值为空,"."不受影响并且执行T0,否则,将通道的值赋给"."并且执行T1。 说明:{{end}}标签是if、with、range的结束标签。

输出字符串

  • {{"\"output\""}}:输出一个字符窜常量。
  • {{"output"}}:输出一个原始字符串常量。
  • {{printf "%q" "output"}}:函数调用,等同于<span> </span>printf("%q", "output")
  • {{"output" | printf "%q"}}:竖线"|"左边的结果作为函数最后一个参数,等同于<span> </span>printf("%q", "output")
  • {{printf "%q" (print "out" "put")}}:圆括号中表达式的整体结果作为printf函数的参数,等同于printf("%q", print("out", "put"))
  • {{"put" | printf "%s%s" "out" | printf "%q"}}:一个更复杂的调用,等同于<span> </span>printf("%q", printf("%s%s", "out", "put"))
  • {{"output" | printf "%s" | printf "%q"}}:等同于<span> </span>printf("%q", printf("%s", "output"))
  • {{with "output"}}{{printf "%q" .}}{{end}}:一个使用点号"."的with操作,等同于:printf("%q", "output")
  • {{with $x := "output" | printf "%q"}}{{$x}}{{end}}:with结构定义变量,值为执行通道函数之后的结果,等同于$x := printf("%q", "output")
  • {{with $x := "output"}}{{printf "%q" $x}}{{end}}:with结构中,在其它动作中使用定义的变量。
  • {{with $x := "output"}}{{$x | printf "%q"}}{{end}}:with结构使用了通道,等同于printf("%q", "output")

预定义的模板全局函数

  • {{and x y}}:模板全局函数and,如果x为真,返回y,否则返回x。等同于Go中的x && y。
  • {{call .X.Y 1 2}}:模板全局函数call,后面的第一个参数的结果必须是一个函数(即这是一个函数类型的值),其余参数作为该函数的参数。 该函数必须返回一个或两个结果值,其中第二个结果值是error类型。 如果传递的参数与函数定义的不匹配或返回的error值不为nil,则停止执行。
  • {{html }}:模板全局函数HTML,转义文本中的HTML标签,如将"<"转义为"<",">"转义为">"等。
  • {{index x 1 2 3}}:模板全局函数index,返回index后面的第一个参数的某个索引对应的元素值,其余的参数为索引值。x必须是一个map、slice或数组。
  • {{js}}:模板全局函数js,返回用JavaScript的escape处理后的文本。
  • {{len x}}:模板全局函数len,返回参数的长度值(int类型)。
  • {{not x}}:模板全局函数not,返回单一参数的布尔否定值。
  • {{or x y}}:模板全局函数or,如果x为真返回x,否则返回y。等同于Go中的:x || y。
  • {{print }}:模板全局函数print,fmt.Sprint的别名。
  • {{printf }}:模板全局函数printf,fmt.Sprintf的别名。
  • {{println }}:模板全局函数println,fmt.Sprintln的别名。
  • {{urlquery }}:模板全局函数urlquery,返回适合在URL查询中嵌入到形参中的文本转义值。类似于PHP的urlencode。

布尔函数

  • {{eq arg1 arg2}}:布尔函数eq,返回表达式"arg1 == arg2"的布尔值。
  • {{ne arg1 arg2}}:布尔函数ne,返回表达式"arg1 != arg2"的布尔值。
  • {{lt arg1 arg2}}:布尔函数lt,返回表达式"arg1 < arg2"的布尔值。
  • {{le arg1 arg2}}:布尔函数le,返回表达式"arg1 <= arg2"的布尔值。
  • {{gt arg1 arg2}}:布尔函数gt,返回表达式"arg1 > arg2"的布尔值。
  • {{ge arg1 arg2}}:布尔函数ge,返回表达式"arg1 >= arg2"的布尔值。
  • 布尔函数对于任何零值返回false,非零值返回true。对于简单的多路相等测试,eq只接受两个参数进行比较,后面其它的参数将分别依次与第一个参数进行比较。
    • {{eq arg1 arg2 arg3 arg4}}
    • 即只能作如下比较:
    • arg1==arg2 || arg1==arg3 || arg1==arg4