Go Web——Beego之view设计

最新推荐文章于 2024-07-24 21:47:59 发布

PPPsych

最新推荐文章于 2024-07-24 21:47:59 发布

阅读量588

点赞数

分类专栏： Beego Go Web 文章标签： golang 前端 beego

本文链接：https://blog.csdn.net/qq_39280718/article/details/126660583

版权

beego 模板语法指南

本文讲述 beego 中使用的模板语法，与 go 模板语法基本相同。

基本语法

go 统一使用了 { { 和 }} 作为左右标签，没有其他的标签符号。如果您想要修改为其它符号，可以参考模板标签。

使用 . 来访问当前位置的上下文

使用 $ 来引用当前模板根级的上下文

使用 $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]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}}

or 会逐一判断每个参数，将返回第一个非空的参数，否则就返回最后一个参数

print

对应 fmt.Sprint

printf

对应 fmt.Sprintf

println

对应 fmt.Sprintln

urlquery

{
   {
   urlquery "http://beego.vip"}}

将返回

http%3A%2F%2Fbeego.vip

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

模板目录

beego 中默认的模板目录是 views，用户可以把模板文件放到该目录下，beego 会自动在该目录下的所有模板文件进行解析并缓存，开发模式下每次都会重新解析，不做缓存。当然，用户也可以通过如下的方式改变模板的目录（只能指定一个目录为模板目录）：

beego.ViewsPath = "myviewpath"

自动渲染

用户无需手动的调用渲染输出模板，beego 会自动的在调用完相应的 method 方法之后调用 Render 函数，当然如果您的应用是不需要模板输出的，那么可以在配置文件或者在 main.go 中设置关闭自动渲染。

配置文件配置如下：

autorender = false

main.go 文件中设置如下：

web.AutoRender = false

模板标签

Go 语言的默认模板采用了 { { 和 }} 作为左右标签，但是我们有时候在开发中可能界面是采用了 AngularJS 开发，他的模板也是这个标签，故而引起了冲突。在 beego 中你可以通过配置文件或者直接设置配置变量修改：

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

模板数据

模板中的数据是通过在 Controller 中 this.Data 获取的，所以如果你想在模板中获取内容 { {.Content}} ,那么你需要在 Controller 中如下设置：

this.Data["Content"] = "value"

如何使用各种类型的数据渲染：

结构体

结构体结构
go type A struct{ Name string Age int }
控制器数据赋值

this.Data["a"]=&A{
     Name:"astaxie",Age:25}

模板渲染数据如下：

the username is {
    {.a.Name}}
the age is {
    {.a.Age}}

map

控制器数据赋值

mp["name"]="astaxie"
mp["nickname"] = "haha"
this.Data["m"]=mp

模板渲染数据如下：

the username is {
    {.m.name}}
the username is {
    {.m.nickname}}

slice

控制器数据赋值

ss :=[]string{
     "a","b","c"}
this.Data["s"]=ss

模板渲染数据如下：

{
    {range $key, $val := .s}}
{
    {$key}}
{
    {$val}}
{
    {end}}

模板名称

beego 采用了 Go 语言内置的模板引擎，所有模板的语法和 Go 的一模一样，至于如何写模板文件，详细的请参考模板教程。

用户通过在 Controller 的对应方法中设置相应的模板名称，beego 会自动的在 viewpath 目录下查询该文件并渲染，例如下面的设置，beego 会在 admin 下面找 add.tpl 文件进行渲染：

this.TplName = "admin/add.tpl"

我们看到上面的模板后缀名是 tpl，beego 默认情况下支持 tpl 和 html 后缀名的模板文件，如果你的后缀名不是这两种，请进行如下设置：

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

当你设置了自动渲染，然后在你的 Controller 中没有设置任何的 TplName，那么 beego 会自动设置你的模板文件如下：

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

也就是你对应的 Controller 名字+请求方法名.模板后缀，也就是如果你的 Controller 名是 AddController，请求方法是 POST，默认的文件后缀是 tpl，那么就会默认请求 /viewpath/AddController/post.tpl 文件。

Layout 设计

beego 支持 layout 设计，例如你在管理系统中，整个管理界面是固定的，只会变化中间的部分，那么你可以通过如下的设置：

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

在 layout.html 中你必须设置如下的变量：

{
  {.LayoutContent}}

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

目前采用首先把目录下所有的文件进行缓存，所以用户还可以通过类似这样的方式实现 layout：

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

特别注意后面的.,这是传递当前参数到子模板

LayoutSection

对于一个复杂的 LayoutContent，其中可能包括有javascript脚本、CSS 引用等，根据惯例，通常 css 会放到 Head 元素中，javascript 脚本需要放到 body 元素的末尾，而其它内容则根据需要放在合适的位置。在 Layout 页中仅有一个 LayoutContent 是不够的。所以在 Controller 中增加了一个 LayoutSections属性，可以允许 Layout 页中设置多个 section，然后每个 section 可以分别包含各自的子模板页。

layout_blog.tpl:

<!DOCTYPE html>
<html>
<head>
    <title>Lin Li</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="Content-Type" content