Golang模板语法简明教程[新]

##【模板标签】
模板标签用`{{`和`}}`括起来
 
##【注释】
`{{/* a comment */}}`
使用`{{/*`和`*/}}`来包含注释内容

##【去掉空白】
`{{- . -}}`
可以使用`{{- `和` -}}`来分别去掉标签左右两边的空白。
可以单独使用，例如:
```
{{- 2 }}
{{ 3 -}}
```

##【变量】
* `{{.}}`
此标签输出当前对象的值
* `{{.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部分。
 
## 【定义子模板】
`{{define "T1"}}ONE{{end}}`
这是定义一个名称为T1的子模板，内部的ONE就是子模板的内容

##【嵌入子模板】
* 用法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")`。）
> 管道左边的数据总是会被作为管道函数的最后一个参数来传递(即放在最后边)，这倒也符合Go语言的一贯个性(我们都知道在Go语言中声明变量的时候也是把数据类型放在最右边)
 
* `{{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 "<hr/>"}}`
转义文本中的html标签，如将“<”转义为“<”，“>”转义为“>”等
 
###【index】
`{{index x 1 2 3}}`
返回index后面的第一个参数的某个索引对应的元素值，其余的参数为索引值
表示：x[1][2][3]
x必须是一个map、slice或数组
 
### 【slice】
`{{slice x 1 2 3}}`
返回slice后面第一个切片参数进行其它参数操作后的结果
表示：x[1:2:3]
x必须是一个string, slice 或 array
 
###【js】
`{{js "中国"}}`
返回用JavaScript的escape处理后的文本
 
###【len】
`{{len "admpub"}}`
返回参数的长度值（int类型）
 
###【not】
`{{not false}}`
返回单一参数的布尔否定值。
 
###【or】
`{{or x y}}`
表示：if x then x else y。等同于Golang中的：x || y
如果x为真返回x，否则返回y。
 
###【print】
`{{print "done"}}`
fmt.Sprint的别名
 
###【printf】
`{{printf "%s.com" "admpub"}}`
fmt.Sprintf的别名
 
###【println】
`{{println "done"}}`
fmt.Sprintln的别名
 
###【urlquery】
`?url={{urlquery "http://www.admpub.com/"}}`
返回适合在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. 在HTML代码里输出HTML代码时，HTML代码会被转义；
2. 在Javascript代码里输出Javascript代码时，Javascript代码会被转义；
3. 在CSS代码里输出CSS代码时，CSS代码会被转义

有时候，我们并不需要golang的模板引擎在这些地方进行转义，这时候应该怎么办呢？
我们只需要将要输出的内容转为相应的`template.HTML`、`template.JS`、`template.CSS`数据类型就可以避免自动转义。这里的template是指`html/template`包。
 
###【block】
从Go 1.6版本开始，有一个新的语法叫做`block`，这个语法的使用类似于`template`语法的使用，但是不同的是`block`会有一个默认值，而`template`没有默认值

下面来演示下，具体说的是什么意思

下面有两个页面：分别是首页和关于我页面 我将用这两个页面解释下`template`是如何工作的，并且如何使用新语法`block`来改变`template`语法

* content模板

每个页面都会使用这个模版

* 首页模版(home.tmpl)

```html
  {{define "title"}}Home{{end}}
  {{define "content"}}This is the Home page.{{end}}
  ```

* 关于我页面模板(about.tmpl)

```html
  {{define "title"}}About{{end}}
  {{define "content"}}This is the About page.{{end}}
  ```

* Base模板 一个基础模板(base.tmpl):

```html
  <title>{{template "title" .}}</title>
  <body>{{template "content" .}}</body>
  ```

**渲染模版**

在这个例子中，Base模板(base.tmpl)作为ParseFiles()第一个参数，content模板作为第二个参数。如果你转换了顺序的话，将不会展示任何东西，所以顺序很重要。

渲染首页的代码
```go
t, err := template.ParseFiles("base.tmpl", "home.tmpl")
if err != nil {
	log.Fatal(err)
}

if err := t.Execute(os.Stdout, nil); err != nil {
	log.Fatal(err)
}
```
首页渲染的结果
```html
<title>Home</title>
<body>This is the home page</body>
```
关于我页面渲染的代码
```
t, err := template.ParseFiles("base.tmpl", "about.tmpl")
if err != nil {
	log.Fatal(err)
}

if err := t.Execute(os.Stdout, nil); err != nil {
	log.Fatal(err)
}
```
关于我渲染页面的结果
```html
<title>About</title>
<body>This is the about page.</body>
```
**template语法的限制**

假设你的网站有500个content模板。为了在base.tmpl中添加一个footer部分的话，你必须修改所有这些500个content模板并且要添加对应的定义，否则你将得到一个类似下面的错误
```
no such template "footer"
```

**新语法**

现在我们来将template语法修改为block语法。不需要修改任何content模板的代码，只需要修改Base模板(base.tmpl)，想下面这样：
```html
<title>{{block "title" .}}Default Title{{end}}</title>
<body>{{block "content" .}}This is the default body.{{end}}</body>
```
如果你的content模板没有任何匹配的定义，将会显示默认的内容。现在在build没有定义content的模板将不会再报错。

站长博客

Navigation

Recent Posts

Friend Links