从零实现Web框架Geo教程-模板-06

Posted 2022-08-29 大忽悠爱忽悠

从零实现Web框架Geo教程-模板-06

• 服务端渲染
• 静态文件(Serve Static Files)
• HTML 模板渲染
• 使用Demo

---

本教程参考：七天用Go从零实现Web框架Gee教程

---

服务端渲染

现在越来越流行前后端分离的开发模式，即 Web 后端提供 RESTful 接口，返回结构化的数据(通常为 JSON 或者 XML)。前端使用 AJAX 技术请求到所需的数据，利用 javascript 进行渲染。Vue/React 等前端框架持续火热，这种开发模式前后端解耦，优势非常突出。后端童鞋专心解决资源利用，并发，数据库等问题，只需要考虑数据如何生成；前端童鞋专注于界面设计实现，只需要考虑拿到数据后如何渲染即可。使用 JSP 写过网站的童鞋，应该能感受到前后端耦合的痛苦。JSP 的表现力肯定是远不如 Vue/React 等专业做前端渲染的框架的。而且前后端分离在当前还有另外一个不可忽视的优势。因为后端只关注于数据，接口返回值是结构化的，与前端解耦。同一套后端服务能够同时支撑小程序、移动APP、PC端 Web 页面，以及对外提供的接口。随着前端工程化的不断地发展，Webpack，gulp 等工具层出不穷，前端技术越来越自成体系了。

但前后分离的一大问题在于，页面是在客户端渲染的，比如浏览器，这对于爬虫并不友好。Google 爬虫已经能够爬取渲染后的网页，但是短期内爬取服务端直接渲染的 html 页面仍是主流。

今天的内容便是介绍 Web 框架如何支持服务端渲染的场景。

---

静态文件(Serve Static Files)

网页的三剑客，JavaScript、CSS 和 HTML。要做到服务端渲染，第一步便是要支持 JS、CSS 等静态文件。还记得我们之前设计动态路由的时候，支持通配符*匹配多级子路径。比如路由规则/assets/*filepath，可以匹配/assets/开头的所有的地址。例如/assets/js/geektutu.js，匹配后，参数filepath就赋值为js/geektutu.js。

那如果我么将所有的静态文件放在/usr/web目录下，那么filepath的值即是该目录下文件的相对地址。映射到真实的文件后，将文件返回，静态服务器就实现了。

找到文件后，如何返回这一步，net/http库已经实现了。因此，geo 框架要做的，仅仅是解析请求的地址，映射到服务器上文件的真实地址，交给http.FileServer处理就好了。

• gee.go

//创建一个静态处理器
func (group *RouterGroup) createStaticHandler(relativePath string, fs http.FileSystem) HandlerFunc 
	absolutePath := path.Join(group.prefix, relativePath)
	//剥离请求前缀,剩下的是文件路径---例如: /static/dhy/a.txt ---> 这里absolutePath为/static
	//那么剩下的文件路径就是 /dhy/a.txt
	//而fs对应的目录为./static ---> 所以文件最终位置为 ./static/dhy/a.txt
	fileServer := http.StripPrefix(absolutePath, http.FileServer(fs))
	return func(c *Context) 
		file := c.Param("filepath")
		// Check if file exists and/or if we have permission to access it
		if _, err := fs.Open(file); err != nil 
			c.Status(http.StatusNotFound)
			return
		
		//将静态资源文件返回给前端
		fileServer.ServeHTTP(c.Writer, c.Req)
	


// 用户设置静态资源映射
func (group *RouterGroup) Static(relativePath string, root string) 
	handler := group.createStaticHandler(relativePath, http.Dir(root))
	urlPattern := path.Join(relativePath, "/*filepath")
	// Register GET handlers
	group.GET(urlPattern, handler)

我们给RouterGroup添加了2个方法，Static这个方法是暴露给用户的。用户可以将磁盘上的某个文件夹root映射到路由relativePath。例如：

func main() 
	r := geo.New()
	r.Static("/static", "./static")
	r.Run(":9999")

当用户访问http://localhost:9999/static/a.txt，最终返回 ./static/a.txt

---

HTML 模板渲染

Go语言内置了text/template和html/template2个模板标准库，其中html/template为 HTML 提供了较为完整的支持。包括普通变量渲染、列表渲染、对象渲染等。gee 框架的模板渲染直接使用了html/template提供的能力。

type Engine struct 
	*RouterGroup
	router *router
	//记录所有分组
	groups        []*RouterGroup
	htmlTemplates *template.Template // for html render
	funcMap       template.FuncMap   // for html render


// html模板渲染

func (engine *Engine) SetFuncMap(funcMap template.FuncMap) 
	engine.funcMap = funcMap


func (engine *Engine) LoadHTMLGlob(pattern string) 
	engine.htmlTemplates = template.Must(template.New("").Funcs(engine.funcMap).ParseGlob(pattern))

首先为 Engine 示例添加了 *template.Template 和 template.FuncMap对象，前者将所有的模板加载进内存，后者是所有的自定义模板渲染函数。

另外，给用户分别提供了设置自定义渲染函数funcMap和加载模板的方法。

接下来，对原来的 (*Context).HTML()方法做了些小修改，使之支持根据模板文件名选择模板进行渲染。

• context.go

type Context struct 
    // ...
	//context内部新增一个指向engine的指针
	engine *Engine


func (c *Context) HTML(code int, name string, data interface) 
	c.SetHeader("Content-Type", "text/html")
	c.Status(code)
	if err := c.engine.htmlTemplates.ExecuteTemplate(c.Writer, name, data); err != nil 
		c.Fail(500, err.Error())
	

我们在 Context 中添加了成员变量 engine *Engine，这样就能够通过 Context 访问 Engine 中的 HTML 模板。实例化 Context 时，还需要给 c.engine 赋值。

• geo.go

func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request) 
	var middlewares []HandlerFunc
	for _, group := range engine.groups 
		if strings.HasPrefix(req.URL.Path, group.prefix) 
			middlewares = append(middlewares, group.middlewares...)
		
	
	c := newContext(w, req)
	c.handlers = middlewares
	//将engine赋值给当前context
	c.engine = engine
	engine.router.handle(c)

---

使用Demo

• 最终的目录结构

---geo/
---static/
   |---css/
        |---dhy.css
   |---file1.txt
---templates/
   |---arr.tmpl
   |---css.tmpl
   |---custom_func.tmpl
---main.go

• main.go

package main

import (
	"fmt"
	"geo"
	"html/template"
	"net/http"
	"time"
)

type student struct 
	Name string
	Age  int8


func FormatAsDate(t time.Time) string 
	year, month, day := t.Date()
	return fmt.Sprintf("%d-%02d-%02d", year, month, day)


func main() 
	r := geo.New()
	//注册全局中间件
	r.Use(geo.Logger())
	//注册模板中可以使用的自定义函数
	r.SetFuncMap(template.FuncMap
		"FormatAsDate": FormatAsDate,
	)
	//加载模板文件
	r.LoadHTMLGlob("templates/*")
	//注册静态文件处理器
	r.Static("/assets", "./static")
   
	stu1 := &studentName: "dhy", Age: 20
	stu2 := &studentName: "Jack", Age: 22
	
	r.GET("/", func(c *geo.Context) 
		c.HTML(http.StatusOK, "css.tmpl", nil)
	)
	
	r.GET("/students", func(c *geo.Context) 
		c.HTML(http.StatusOK, "arr.tmpl", geo.H
			"title":  "geo",
			"stuArr": [2]*studentstu1, stu2,
		)
	)

	r.GET("/date", func(c *geo.Context) 
		c.HTML(http.StatusOK, "custom_func.tmpl", geo.H
			"title": "geo",
			"now":   time.Date(2019, 8, 17, 0, 0, 0, 0, time.UTC),
		)
	)

	r.Run(":9999")