冉冉的365天

分享我的工作、生活与心情，让自己变得丰富多彩！

Go-template-常用方法详解-注意事项

技术 | 2016-12-11 13:39

Go template包下面有两个函数可以创建模板示例

func New(name string) *Template
func ParseFiles(filenames ...string) (*Template, error)

首先要说的是每一个template内部可以存储多个模板 而且每个模板必须对应一个独立的名字

两个的不同点在于

使用New在创建时就为其添加一个模板名称 并且执行t.Execute()会默认去寻找该名称进行数据融合

使用ParseFiles创建模板可以一次指定多个文件加载多个模板进来 但是就不可以使用t.Execute()来执行数据融合

因为使用t.Execute()无法找到要使用哪个加载过的模板进行数据融合  而只有New创建时才会指定一个t.Execute()执行时默认加载的模板

但是ParseFiles可以通过

func (t *Template) ExecuteTemplate(wr io.Writer, name string, data interface{}) error

来进行数据融合因为该函数可以指定模板名因此 实例模板就可以知道要去加载自己内部的哪一个模板进行数据融合

当然无论使用New还是ParseFiles创建模板都是可以使用ExecuteTemplate来进行数据融合

但是对于Execute一般与New创建的模板进行配合使用

html/template text/template

html下的template结构体 实际上是继承了 text下面的template结构体

template包下面还有一个ParseGlob方法用于批量解析文件比如在当前目录下有以h开头的模板10个

使用template.ParseGlob("h*")即可页将10个模板文件一起解析出来

注意事项

下面这段代码的输出一定为空

t := template.New("haha")
t,err := t.ParseFiles("header.tmpl")
fmt.Println(err)
t.Execute(os.Stdout, nil)

原因是为什么呢.....  

首先先记住一个原则 template.New和ParseFiles()最好不要一起使用

如果非要一起使用那么要记住 

New("TName") 中的TName 必须要和header.tmpl中定义的{{define name}}中的name同名

但是正常的做法应该是这样的 同样的ExecuteTemplate中输入的name也必须和模板中[{define name}}相同

t,_ := template.ParseFiles("header.tmpl")
t.ExecuteTemplate(os.Stdout, "header",nil)

这里要注意下 在这种情况下如果使用t.Execute也是不会输出任何结果的 因为他并不知道你要使用哪个模板


另外一点要注意的就是

如果模板中没有与填充数据对应的模板语言 那么很有可能panic


模板中{{}}花括号表达式 自动实现了对js代码的过滤 

如何不过滤js代码呢 只需要使用text/template包下的template

因为html/template包下的模板实现一些针对html的安全操作包括过滤js代码


Golang 当中支持 Pipeline 一样是使用 |

Go允许在模板中自定义变量

Go中还支持定义模板函数

函数定义必须遵循如下格式

func FuncName(args ...interface{}) string

通过template.FuncMap()强制类型转换为FuncMap类型

然后再通过template实例的Func(FuncMap)添加在模板实例中

这样该模板内部在解析时就可以使用该函数

Go模板包中自定义了一系列内置函数

var builtins = FuncMap{
"and":      and,
"call":     call,
"html":     HTMLEscaper,
"index":    index,
"js":       JSEscaper,
"len":      length,
"not":      not,
"or":       or,
"print":    fmt.Sprint,
"printf":   fmt.Sprintf,
"println":  fmt.Sprintln,
"urlquery": URLQueryEscaper,
// Comparisons
"eq": eq, // ==
"ge": ge, // >=
"gt": gt, // >
"le": le, // <=
"lt": lt, // <
"ne": ne, // !=
}


【模板标签】

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

 

【注释】

{{/* a comment */}}

使用“{{/*”和“*/}}”来包含注释内容

 

【变量】

{{.}}

此标签输出当前对象的值

{{.Admpub}}

表示输出Struct对象中字段或方法名称为“Admpub”的值。

当“Admpub”是匿名字段时，可以访问其内部字段或方法,比如“Com”：{{.Admpub.Com}} ，

如果“Com”是一个方法并返回一个Struct对象，同样也可以访问其字段或方法：{{.Admpub.Com.Field1}}

{{.Method1 "参数值1" "参数值2"}}

调用方法“Method1”，将后面的参数值依次传递给此方法，并输出其返回值。

{{$admpub}}

此标签用于输出在模板中定义的名称为“admpub”的变量。当$admpub本身是一个Struct对象时，可访问其字段：{{$admpub.Field1}}

在模板中定义变量：变量名称用字母和数字组成，并带上“$”前缀，采用符号“:=”进行赋值。

比如：{{$x := "OK"}} 或 {{$x := pipeline}}

 

【管道函数】

用法1：

{{FuncName1}}

此标签将调用名称为“FuncName1”的模板函数（等同于执行“FuncName1()”，不传递任何参数）并输出其返回值。

用法2：

{{FuncName1 "参数值1" "参数值2"}}

此标签将调用“FuncName1("参数值1", "参数值2")”，并输出其返回值

用法3：

{{.Admpub|FuncName1}}

此标签将调用名称为“FuncName1”的模板函数（等同于执行“FuncName1(this.Admpub)”，将竖线“|”左边的“.Admpub”变量值作为函数参数传送）并输出其返回值。

 

【条件判断】

用法1：

{{if pipeline}} T1 {{end}}

标签结构：{{if ...}} ... {{end}}

用法2：

{{if pipeline}} T1 {{else}} T0 {{end}}

标签结构：{{if ...}} ... {{else}} ... {{end}}

用法3：

{{if pipeline}} T1 {{else if pipeline}} T0 {{end}}

标签结构：{{if ...}} ... {{else if ...}} ... {{end}}

其中if后面可以是一个条件表达式（包括管道函数表达式。pipeline即管道），也可以是一个字符窜变量或布尔值变量。当为字符窜变量时，如为空字符串则判断为false，否则判断为true。

 

【遍历】

用法1：

{{range $k, $v := .Var}} {{$k}} => {{$v}} {{end}}

range...end结构内部如要使用外部的变量，比如.Var2，需要这样写：$.Var2

（即：在外部变量名称前加符号“$”即可，单独的“$”意义等同于global）

用法2：

{{range .Var}} {{.}} {{end}}

用法3：

{{range pipeline}} T1 {{else}} T0 {{end}}

当没有可遍历的值时，将执行else部分。

 

【嵌入子模板】

用法1：

{{template "name"}}

嵌入名称为“name”的子模板。使用前，请确保已经用“{{define "name"}}子模板内容{{end}}”定义好了子模板内容。

用法2：

{{template "name" pipeline}}

将管道的值赋给子模板中的“.”（即“{{.}}”）

 

【子模板嵌套】

{{define "T1"}}ONE{{end}}
{{define "T2"}}TWO{{end}}
{{define "T3"}}{{template "T1"}} {{template "T2"}}{{end}}
{{template "T3"}}

输出：

ONE TWO

 

【定义局部变量】

用法1：

{{with pipeline}} T1 {{end}}

管道的值将赋给该标签内部的“.”。（注：这里的“内部”一词是指被{{with pipeline}}...{{end}}包围起来的部分，即T1所在位置）

用法2：

{{with pipeline}} T1 {{else}} T0 {{end}}

如果管道的值为空，“.”不受影响并且执行T0，否则，将管道的值赋给“.”并且执行T1。

说明：{{end}}标签是if、with、range的结束标签。

 

【例子：输出字符窜】

{{"\"output\""}}

输出一个字符窜常量。

 

{{`"output"`}}

输出一个原始字符串常量

 

{{printf "%q" "output"}}

函数调用.（等同于：printf("%q", "output")。）

 

{{"output" | printf "%q"}}

竖线“|”左边的结果作为函数最后一个参数。（等同于：printf("%q", "output")。）

 

{{printf "%q" (print "out" "put")}}

圆括号中表达式的整体结果作为printf函数的参数。（等同于：printf("%q", print("out", "put"))。）

 

{{"put" | printf "%s%s" "out" | printf "%q"}}

一个更复杂的调用。（等同于：printf("%q", printf("%s%s", "out", "put"))。）

 

{{"output" | printf "%s" | printf "%q"}}

等同于：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}}

同上，但使用了管道。（等同于：printf("%q", "output")。）

 

===============【预定义的模板全局函数】================

【and】

{{and x y}}

表示：if x then y else x

如果x为真，返回y，否则返回x。等同于Golang中的：x && y

 

【call】

{{call .X.Y 1 2}}

表示：dot.X.Y(1, 2)

call后面的第一个参数的结果必须是一个函数（即这是一个函数类型的值），其余参数作为该函数的参数。

该函数必须返回一个或两个结果值，其中第二个结果值是error类型。

如果传递的参数与函数定义的不匹配或返回的error值不为nil，则停止执行。

 

【html】

转义文本中的html标签，如将“<”转义为“&lt;”，“>”转义为“&gt;”等

 

【index】

{{index x 1 2 3}}

返回index后面的第一个参数的某个索引对应的元素值，其余的参数为索引值

表示：x[1][2][3]

x必须是一个map、slice或数组

 

【js】

返回用JavaScript的escape处理后的文本

 

【len】

返回参数的长度值（int类型）

 

【not】

返回单一参数的布尔否定值。

 

【or】

{{or x y}}

表示：if x then x else y。等同于Golang中的：x || y

如果x为真返回x，否则返回y。

 

【print】

fmt.Sprint的别名

 

【printf】

fmt.Sprintf的别名

 

【println】

fmt.Sprintln的别名

 

【urlquery】

返回适合在URL查询中嵌入到形参中的文本转义值。（类似于PHP的urlencode）

 

=================【布尔函数】===============

布尔函数对于任何零值返回false，非零值返回true。

这里定义了一组二进制比较操作符函数：

 

【eq】

返回表达式“arg1 == arg2”的布尔值

 

【ne】

返回表达式“arg1 != arg2”的布尔值

 

【lt】

返回表达式“arg1 < arg2”的布尔值

 

【le】

返回表达式“arg1 <= arg2”的布尔值

 

【gt】

返回表达式“arg1 > arg2”的布尔值

 

【ge】

返回表达式“arg1 >= arg2”的布尔值

 

对于简单的多路相等测试，eq只接受两个参数进行比较，后面其它的参数将分别依次与第一个参数进行比较，

{{eq arg1 arg2 arg3 arg4}}

即只能作如下比较：

arg1==arg2 || arg1==arg3 || arg1==arg4 ...


谢谢您！

相信自己，顶着风和雨，迈过坎和坷，走过山和洼，趟过沟和河，历经艰辛和万难，闯过戈壁沙漠，踏过现实的荒芜，穿越心的海洋，到达梦的彼岸，寻求生活的真谛，索求期待已久的幸福。

博客目录

  1. 生活
  3. 工作
  5. 旅行

收藏目录

  1. 好文
  3. 技术

功能

  1. 登录

冉冉的365天 渝ICP备14008124号-2