做后端开发的时候,最常见的就是模板同步变量的添加,这一讲我们就介绍一下如何使用Gin在前端模板上输出变量,跟第五讲一样我们先要创建一个go_test3文件夹,然后把go_test2中的内容全部都复制到这个文件夹下 。然后在go_test2中创建一个tmpl文件夹用来存放html模板。
在此文件夹下我们需要创建三个文件,第一个是header.html文件。代码清单如下:
{{define "header"}}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<span>header</span>
{{end}}
然后在该文件夹下创建一个叫做footer.html的文件,其中代码清单如下:
{{define "footer"}}
<span>footer</span>
</body>
</html>
{{end}}
最后我们创建一个引用header.html和 footer.html的文件,叫index.tmpl,也放在tmpl中,代码如下:
{{template "header" }}
<div>body</div>
{{template "footer" }}
这里要特此声明一下,html与tmpl文件后缀的区别,大家之前在写nodejs的时候记得nodejs中的模板变量吧。比如最常用的.ejs,这里的tmpl就相当于nodejs的ejs,可以在模板上添加变量输入。go模板的html则与Nodejs的html相同。(在Go中html模板中也可以添加模板变量,在Nodejs中需要设置模板引擎文件后缀名)
最后我们来打开main.go编写一下主程序,代码清单如下:
package main
import "github.com/gin-gonic/gin"
import "net/http"
func main() {
r:= gin.Default()
r.LoadHTMLGlob("tmpl/*")
r.GET("/index", func(c *gin.Context) {
c.HTML(http.StatusOK, "index.tmpl",gin.H{
"title": "Users",
})
})
r.Run(":9999")
}
r.LoadHTMLGlob("tmpl/*")函数指定了模板的存放空间,比如我们刚刚创建的header.html、footer.html和index.tmpl三个模板都在项目根路径的tmpl文件夹下,就是可以配置 r.LoadHTMLGlob("tmpl/*")。
然后在引用模板的时候直接输入名称就可以了,因为c.HTML访问模板变量的时候会自动把LoadHTMLGlob配置到路径用,就像代码清单中我们访问的是index.tmpl模板,实际在LoadHTMLGlob拼接之后,就会变成tmpl/index.tmpl文件。
接下来在项目根路径执行go build,然后执行可执行文件gin_test,就能看到下图了。
一个简单的模板拼装的页面就完成了。
如果说模板上有一些需要跟着模板同步返回的变量,需要返回怎么办呢?我们可以吧main.go的改成列代码,在返回在模板的变量中加入一条 "data1":"test"
package main
import "github.com/gin-gonic/gin"
import "net/http"
func main() {
r:= gin.Default()
r.LoadHTMLGlob("tmpl/*")
r.GET("/index", func(c *gin.Context) {
c.HTML(http.StatusOK, "index.tmpl",gin.H{
"title": "Users",
"data1":"test"
})
})
r.Run(":9999")
}
然后更改一下index.tmpl文件把代码更改成如下代码,我们可以把这部分数据理解成php的smarty模板或者Nodejs的ejs模板,如果这两个都没有用过的前端工程师,就把这种模板变量使用方式理解成Vue或者React所常用的方式就好(虽说从实现原理上有根本的不同)。
{{template "header" }}
<div>body</div>
{{.data1}}
{{template "footer" }}
运行这段代码之后就会看到如下界面,我们发现body下面多出了一个test单词,他就是我们刚刚在模板上添加的data1变量。
本讲我们介绍了Gin的常用模板拼装、模板变量的使用,其实模板变量还是可以做很多事情,比如模板变量中也包含if、for等基本逻辑语法。这部分知识在我们使用的时候在做介绍。
最后要介绍一下关于开发过程中开发效率的问题。其实我们在开发过程中,总能碰到一个点就是更新页面模板数据的时候时候每次都需要重新build 或者重新执行go run来编译代码,其实Gin早就替我们想到了。在engine := gin.Default()之前,可以设置Debug启动模式或者Release启动模式。
gin.SetMode(gin.ReleaseMode)// 更改模板上的代码的时候,需要重新启动Gin服务。
gin.SetMode(gin.DebugMode)// 更改模板上的代码的时候,可以不用重新启动Gin服务
至于它如何实现的我们只需要看一下LoadHTMLFiles的实现就可以了,源码中其实判断了一下启动模式,然后根据启动模式来确定,加载页面模板(template)时是启动时加载一次,还是每次启动加载。
func (engine *Engine) LoadHTMLFiles(files ...string) {
//这里判断为debug模式运行的时候实例化HTMLDebug这个结构体
//这个结构体里的每次调用Instance方法会去重新读取模板
if IsDebugging() {
engine.HTMLRender = render.HTMLDebug{Files: files, FuncMap: engine.FuncMap, Delims: engine.delims}
return
}
templ := template.Must(template.New("").Delims(engine.delims.Left, engine.delims.Right).Funcs(engine.FuncMap).ParseFiles(files...))
engine.SetHTMLTemplate(templ)
}
陈辰(CC老师) 978563552@qq.com