[TOC]
# beego 模板语法指南
本文讲述 beego 中使用的模板语法,与 go 模板语法基本相同。
## 基本语法
go 统一使用了 `{{` 和 `}}` 作为左右标签,没有其他的标签符号。如果您想要修改为其它符号,可以参考 [模板标签](http://beego.me/docs/mvc/view/view.md#%E6%A8%A1%E6%9D%BF%E6%A0%87%E7%AD%BE)。
使用 `.` 来访问当前位置的上下文
使用 `$` 来引用当前模板根级的上下文
使用 `$var` 来访问创建的变量
[more]
**模板中支持的 go 语言符号**
```
{{"string"}} // 一般 string
{{`raw string`}} // 原始 string
{{'c'}} // byte
{{print nil}} // nil 也被支持
```
**模板中的 pipeline**
可以是上下文的变量输出,也可以是函数通过管道传递的返回值
```
{{. | FuncA | FuncB | FuncC}}
```
当 pipeline 的值等于:
* false 或 0
* nil 的指针或 interface
* 长度为 0 的 array, slice, map, string
那么这个 pipeline 被认为是空
#### if ... else ... end
```
{{if pipeline}}{{end}}
```
if 判断时,pipeline 为空时,相当于判断为 False
```
this.Data["IsLogin"] = true
this.Data["IsHome"] = true
this.Data["IsAbout"] = true
```
支持嵌套的循环
```
{{if .IsHome}}
{{else}}
{{if .IsAbout}}{{end}}
{{end}}
```
也可以使用 else if 进行
```
{{if .IsHome}}
{{else if .IsAbout}}
{{else}}
{{end}}
```
#### range ... end
```
{{range pipeline}}{{.}}{{end}}
```
pipeline 支持的类型为 array, slice, map, channel
range 循环内部的 `.` 改变为以上类型的子元素
对应的值长度为 0 时,range 不会执行,`.` 不会改变
```
pages := []struct {
Num int
}{{10}, {20}, {30}}
this.Data["Total"] = 100
this.Data["Pages"] = pages
```
使用 `.Num` 输出子元素的 Num 属性,使用 `$.` 引用模板中的根级上下文
```
{{range .Pages}}
{{.Num}} of {{$.Total}}
{{end}}
```
使用创建的变量,在这里和 go 中的 range 用法是相同的。
```
{{range $index, $elem := .Pages}}
{{$index}} - {{$elem.Num}} - {{.Num}} of {{$.Total}}
{{end}}
```
range 也支持 else
```
{{range .Pages}}
{{else}}
{{/* 当 .Pages 为空 或者 长度为 0 时会执行这里 */}}
{{end}}
```
#### with ... end
```
{{with pipeline}}{{end}}
```
with 用于重定向 pipeline
```
{{with .Field.NestField.SubField}}
{{.Var}}
{{end}}
```
也可以对变量赋值操作
```
{{with $value := "My name is %s"}}
{{printf . "slene"}}
{{end}}
```
with 也支持 else
```
{{with pipeline}}
{{else}}
{{/* 当 pipeline 为空时会执行这里 */}}
{{end}}
```
#### define
define 可以用来定义自模板,可用于模块定义和模板嵌套
```
{{define "loop"}}
<li>{{.Name}}</li>
{{end}}
```
使用 template 调用模板
```
<ul>
{{range .Items}}
{{template "loop" .}}
{{end}}
</ul>
```
#### template
```
{{template "模板名" pipeline}}
```
将对应的上下文 pipeline 传给模板,才可以在模板中调用
**Beego 中支持直接载入文件模板**
```
{{template "path/to/head.html" .}}
```
Beego 会依据你设置的模板路径读取 head.html
在模板中可以接着载入其他模板,对于模板的分模块处理很有用处
#### 注释
允许多行文本注释,不允许嵌套
```
{{/* comment content
support new line */}}
```
## 基本函数
变量可以使用符号 `|` 在函数间传递
```
{{.Con | markdown | addlinks}}
```
```
{{.Name | printf "%s"}}
```
使用括号
```
{{printf "nums is %s %d" (printf "%d %d" 1 2) 3}}
```
#### and
```
{{and .X .Y .Z}}
```
and 会逐一判断每个参数,将返回第一个为空的参数,否则就返回最后一个非空参数
#### call
```
{{call .Field.Func .Arg1 .Arg2}}
```
call 可以调用函数,并传入参数
调用的函数需要返回 1个值 或者 2个值,返回两个值时,第二个值用于返回 error 类型的错误。返回的错误不等于 nil 时,执行将终止。
#### index
index 支持 map, slice, array, string,读取指定类型对应下标的值
```
this.Data["Maps"] = map[string]{"name": "Beego"}
```
```
{{index .Maps "name"}}
```
#### len
```
{{printf "The content length is %d" (.Content|len)}}
```
返回对应类型的长度,支持类型:map, slice, array, string, chan
#### not
not 返回输入参数的否定值,if true then false else true
#### or
```
{{or .X .Y .Z}}
```
and 会逐一判断每个参数,将返回第一个非空的参数,否则就返回最后一个参数
#### print
对应 fmt.Sprint
#### printf
对应 fmt.Sprintf
#### println
对应 fmt.Sprintln
#### urlquery
```
{{urlquery "http://beego.me"}}
```
将返回
```
http%3A%2F%2Fbeego.me
```
#### eq / ne / lt / le / gt / ge
这类函数一般配合在 if 中使用
`eq`: arg1 == arg2
`ne`: arg1 != arg2
`lt`: arg1 < arg2
`le`: arg1 <= arg2
`gt`: arg1 > arg2
`ge`: arg1 >= arg2
eq 和其他函数不一样的地方是,支持多个参数,和下面的逻辑判断相同
```
arg1==arg2 || arg1==arg3 || arg1==arg4 ...
```
与 if 一起使用
```
{{if eq true .Var1 .Var2 .Var3}}{{end}}
```
```
{{if lt 100 200}}{{end}}
```
> 更多文档请访问 [beego 官网](http://beego.me/docs/mvc/view/view.md)。
- 写在前面的话
- 第0章 beego 简介
- 0.1 为beego贡献
- 0.2 发布版本
- 0.3 升级指南
- 第1章 安装升级
- 1.1 bee工具的使用
- 第2章 快速入门
- 2.1 新建项目
- 2.2 路由设置
- 2.3 Controller运行机制
- 2.4 Model逻辑
- 2.5 View编写
- 2.6 静态文件处理
- 第3章 beego的MVC架构
- 3.1 Model设计
- 3.1.1 概述
- 3.1.2 ORM使用
- 3.1.3 CRUD操作
- 3.1.4 高级查询
- 3.1.5 原生SQL查询
- 3.1.6 构造查询
- 3.1.7 事物处理
- 3.1.8 模型定义
- 3.1.9 命令模式
- 3.1.10 测试用例
- 3.1.11 自定义字段
- 3.1.12 FAQ
- 3.2 View设计
- 3.2.1 模板语法指南
- 3.2.2 模板处理
- 3.2.3 模板函数
- 3.2.4 静态文件处理
- 3.2.5 模板分页处理
- 3.3 Controller设计
- 3.3.1 参数配置
- 3.3.2 路由设置
- 3.3.3 控制器函数
- 3.3.4 XSRF过滤
- 3.3.5 请求数据处理
- 3.3.6 session 控制
- 3.3.7 过滤器
- 3.3.8 flash 数据
- 3.3.9 URL构建
- 3.3.10 多种格式数据输出
- 3.3.11 表单数据验证
- 3.3.12 错误处理
- 3.3.13 日志处理
- 第4章 beego的模块设计
- 4.1 session 模块
- 4.2 grace 模块
- 4.3 cache 模块
- 4.4 logs 模块
- 4.5 httplib 模块
- 4.6 context 模块
- 4.7 toolbox 模块
- 4.8 config 模块
- 4.9 i18n 模块
- 第5章 beego高级编程
- 5.1 进程内监控
- 5.2 API自动化文档
- 第6章 应用部署
- 6.1 独立部署
- 6.2 Supervisor部署
- 6.3 Nginx 部署
- 6.4 Apache 部署
- 第7章 第三方库
- 第8章 应用例子
- 8.1 在线聊天室
- 8.2 短域名服务
- 8.3 Todo列表
- 第9章 FAQ