Golang 语言 Web 框架 beego v2 之模板(上)

简介: Golang 语言 Web 框架 beego v2 之模板

01

介绍


beego 的模板处理引擎采用的是 Go 内置的 html/template 包进行处理,而且 beego 的模板处理逻辑是采用了缓存编译方式,也就是所有的模板会在 beego 应用启动的时候全部编译然后缓存在 map 里面。


02

模板处理

模板目录


beego 的默认模板目录是 views,也可以通过 beego.ViewPath = "viewPath" 指定模板目录。beego 会自动解析并缓存模板目录中的所有模板文件。但是在开发模式下,每次修改模板文件都会重新解析,并且不做缓存。


自动渲染


beego 会在调用完相应 method 方法之后自动调用 Render 函数,不需要用户手动调用渲染输出模板。如果不需要模板输出,可以在配置文件中配置:

autorender=false

或在 main.go 文件中设置配置变量:

web.AutoRender = false


模板标签


beego 默认使用{{}}双大括号作为模板标签,但是可能会和某些模板引擎使用的标签冲突,beego 可以通过配置文件或者设置配置变量:


web.TemplateLeft="<<"
web.TemplateRight=">>"


模板数据


模板数据是通过在 controller中 this.Data 获取的,Data 字段的类型是:


Data map[interface{}]interface{}

key 和 value 都是空接口类型的 map


模板名称


自动渲染模式中,如果没有在 controller 中没有设置任何的模板名称TplName,beego 会自动将 controller 名字,method 名字,和模板后缀拼接成一个字符串,作为模板名称。


c.TplName = strings.ToLower(c.controllerName) + "/" + strings.ToLower(c.actionName) + "." + c.TplExt


beego 默认支持两种模板文件的后缀名,分别是 tpl 和 html。如果你的模板文件的后缀名不是这两种,需要设置配置变量:

web.AddTemplateExt("模板文件的后缀名")


用户还可以在 controller 中指定模板名称,beego 会自动在 viewPath 目录中查找该模板文件,设置方式如下:


this.TplName = "admin/add.tpl"


Layout 设计


beego 支持 Layout 设计,可以通过如下设置:


this.Layout = "admin/layout.html"
this.TplName = "admin/add.tpl"


在 layout.html 文件中,设置如下变量:


{{.LayoutContent}}


beego 就会首先解析 TplName 指定的文件,获取到内容后,赋值给 LayoutContent,最后渲染 layout.html 文件。


另外,还可以使用如下方式:


{{template "header.html" .}}
Logic code
{{template "footer.html" .}}


LayoutSection


根据惯例,js 文件放在 body 的末尾,css 文件放到 head 中,所以 layout.html 文件只有一个 LayoutContent 是不够用的。


所以,在 controller 中还有一个 LayoutSection 属性,可以给 Layout.html 设置多个 section,每个 section 都可以包含各自的子模板页面。



type BlogsController struct {
  web.Controller
}
func (this *BlogsController) Get() {
  this.Layout = "layout_blog.tpl"
  this.TplName = "blogs/index.tpl"
  this.LayoutSections = make(map[string]string)
  this.LayoutSections["HtmlHead"] = "blogs/html_head.tpl"
  this.LayoutSections["Scripts"] = "blogs/scripts.tpl"
  this.LayoutSections["Sidebar"] = "blogs/side_bar.tpl"
}


renderform 使用


struct:


type User struct {
  Id    int         `form:"-"`
  Name  interface{} `form:"username"`
  Age   int         `form:"age,text,年龄:"`
  Sex   string
  Intro string `form:",textarea"`
}


StructTag 的定义用的标签为 form,和 ParseForm 方法共用一个标签,标签后面有三个可选参数,用 , 分割。


第一个参数为表单中类型的 name 的值,如果为空,则以 struct field name 为值。


第二个参数为表单组件的类型,如果为空,则为 text。表单组件的标签默认为 struct field name 的值,否则为第三个值。


如果要忽略一个字段,有两种办法,一是:字段名小写开头,二是:form 标签的值设置为 -


如果 form 标签只有一个值,则为表单中类型 name 的值,除了最后一个值可以忽略外,其他位置的必须要有 ,号分割,如:form:",,姓名:"


现在的代码版本只能实现固定的格式,用 br 标签实现换行,无法实现 css 和 class 等代码的插入。所以,要实现 form 的高级排版,不能使用 renderform 的方法,而需要手动处理每一个字段。


controller:


func (this *AddController) Get() {
  this.Data["Form"] = &User{}
  this.TplName = "index.tpl"
}


Form 的参数必须是一个 struct 的指针。


template:

<form action="" method="post">
{{.Form | renderform}}
</form>


上面的代码生成的表单为:


Name: <input name="username" type="text" value="test"></br>
年龄:<input name="age" type="text" value="0"></br>
Sex: <input name="Sex" type="text" value=""></br>
Intro: <input name="Intro" type="textarea" value="">


03

模板语法


模板中支持的 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 */}}



目录
相关文章
|
8天前
|
人工智能 开发框架 数据可视化
Eino:字节跳动开源基于Golang的AI应用开发框架,组件化设计助力构建AI应用
Eino 是字节跳动开源的大模型应用开发框架,帮助开发者高效构建基于大模型的 AI 应用。支持组件化设计、流式处理和可视化开发工具。
138 27
|
5月前
|
Go
Golang语言之管道channel快速入门篇
这篇文章是关于Go语言中管道(channel)的快速入门教程,涵盖了管道的基本使用、有缓冲和无缓冲管道的区别、管道的关闭、遍历、协程和管道的协同工作、单向通道的使用以及select多路复用的详细案例和解释。
181 4
Golang语言之管道channel快速入门篇
|
5月前
|
Go
Golang语言文件操作快速入门篇
这篇文章是关于Go语言文件操作快速入门的教程,涵盖了文件的读取、写入、复制操作以及使用标准库中的ioutil、bufio、os等包进行文件操作的详细案例。
90 4
Golang语言文件操作快速入门篇
|
5月前
|
Go
Golang语言之gRPC程序设计示例
这篇文章是关于Golang语言使用gRPC进行程序设计的详细教程,涵盖了RPC协议的介绍、gRPC环境的搭建、Protocol Buffers的使用、gRPC服务的编写和通信示例。
150 3
Golang语言之gRPC程序设计示例
|
5月前
|
安全 Go
Golang语言goroutine协程并发安全及锁机制
这篇文章是关于Go语言中多协程操作同一数据问题、互斥锁Mutex和读写互斥锁RWMutex的详细介绍及使用案例,涵盖了如何使用这些同步原语来解决并发访问共享资源时的数据安全问题。
118 4
|
3月前
|
中间件 Go API
Go语言中几种流行的Web框架,如Beego、Gin和Echo,分析了它们的特点、性能及适用场景,并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架
本文概述了Go语言中几种流行的Web框架,如Beego、Gin和Echo,分析了它们的特点、性能及适用场景,并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架。
228 1
|
5月前
|
Go 调度
Golang语言goroutine协程篇
这篇文章是关于Go语言goroutine协程的详细教程,涵盖了并发编程的常见术语、goroutine的创建和调度、使用sync.WaitGroup控制协程退出以及如何通过GOMAXPROCS设置程序并发时占用的CPU逻辑核心数。
147 4
Golang语言goroutine协程篇
|
5月前
|
Prometheus Cloud Native Go
Golang语言之Prometheus的日志模块使用案例
这篇文章是关于如何在Golang语言项目中使用Prometheus的日志模块的案例,包括源代码编写、编译和测试步骤。
102 3
Golang语言之Prometheus的日志模块使用案例
|
4月前
|
前端开发 中间件 Go
实践Golang语言N层应用架构
【10月更文挑战第2天】本文介绍了如何在Go语言中使用Gin框架实现N层体系结构,借鉴了J2EE平台的多层分布式应用程序模型。文章首先概述了N层体系结构的基本概念,接着详细列出了Go语言中对应的构件名称,包括前端框架(如Vue.js、React)、Gin的处理函数和中间件、依赖注入和配置管理、会话管理和ORM库(如gorm或ent)。最后,提供了具体的代码示例,展示了如何实现HTTP请求处理、会话管理和数据库操作。
67 0
|
4月前
|
JSON Prometheus Go
Golang模板template
Golang模板template

热门文章

最新文章