从零实现Web框架Geo教程-分组控制-04

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

从零实现Web框架Geo教程-分组控制-04

• 分组的意义
• • 分组嵌套
• 使用 Demo

---

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

---

分组的意义

分组控制(Group Control)是 Web 框架应提供的基础功能之一。所谓分组，是指路由的分组。如果没有路由分组，我们需要针对每一个路由进行控制。但是真实的业务场景中，往往某一组路由需要相似的处理。例如：

• 以/post开头的路由匿名可访问。
• 以/admin开头的路由需要鉴权。
• 以/api开头的路由是 RESTful 接口，可以对接第三方平台，需要三方平台鉴权。

大部分情况下的路由分组，是以相同的前缀来区分的。因此，我们今天实现的分组控制也是以前缀来区分，并且支持分组的嵌套。例如/post是一个分组，/post/a和/post/b可以是该分组下的子分组。作用在/post分组上的中间件(middleware)，也都会作用在子分组，子分组还可以应用自己特有的中间件。

中间件可以给框架提供无限的扩展能力，应用在分组上，可以使得分组控制的收益更为明显，而不是共享相同的路由前缀这么简单。例如/admin的分组，可以应用鉴权中间件；/分组应用日志中间件，/是默认的最顶层的分组，也就意味着给所有的路由，即整个框架增加了记录日志的能力。

提供扩展能力支持中间件的内容，我们将在下一节当中介绍。

---

分组嵌套

一个 Group 对象需要具备哪些属性呢？首先是前缀(prefix)，比如/，或者/api；要支持分组嵌套，那么需要知道当前分组的父亲(parent)是谁；当然了，按照我们一开始的分析，中间件是应用在分组上的，那还需要存储应用在该分组上的中间件(middlewares)。还记得，我们之前调用函数(*Engine).addRoute()来映射所有的路由规则和 Handler 。如果Group对象需要直接映射路由规则的话，比如我们想在使用框架时，这么调用：

r := geo.New()
v1 := r.Group("/v1")
v1.GET("/", func(c *geo.Context) 
	c.html(http.StatusOK, "<h1>Hello Geo</h1>")
)

那么Group对象，还需要有访问Router的能力，为了方便，我们可以在Group中，保存一个指针，指向Engine，整个框架的所有资源都是由Engine统一协调的，那么就可以通过Engine间接地访问各种接口了。

所以，最后的 Group 的定义是这样的：

type RouterGroup struct 
	prefix string
	//存放应用在当前分组上的中间件
	middlewares []HandlerFunc
	//支持嵌套路由,这里存放父分组
	parent *RouterGroup
	//所有分组共享一个engine对象实例
	engine *Engine

我们还可以进一步地抽象，将Engine作为最顶层的分组，也就是说Engine拥有RouterGroup所有的能力。

type Engine struct 
	*RouterGroup
	router *router
	//记录所有分组
	groups []*RouterGroup

那我们就可以将和路由有关的函数，都交给RouterGroup实现了。

func New() *Engine 
	engine := &Enginerouter: newRouter()
	engine.RouterGroup = &RouterGroupengine: engine
	//engine自身作为顶层分组
	engine.groups = []*RouterGroupengine.RouterGroup
	return engine


//路由的添加

//SetContextPath 设置项目路径
func (engine *Engine) SetContextPath(prefix string) 
	engine.prefix = prefix


//Group 创建一个新的分组
func (group *RouterGroup) Group(prefix string) *RouterGroup 
	engine := group.engine
	newGroup := &RouterGroup
		prefix: group.prefix + prefix,
		parent: group,
		engine: engine,
	
	engine.groups = append(engine.groups, newGroup)
	return newGroup


func (group *RouterGroup) addRoute(method string, comp string, handler HandlerFunc) 
	//真实的路由路径需要加上当前分组的前缀路径
	pattern := group.prefix + comp
	log.Printf("Route %4s - %s", method, pattern)
	group.engine.router.addRoute(method, pattern, handler)


// GET defines the method to add GET request
func (group *RouterGroup) GET(pattern string, handler HandlerFunc) 
	group.addRoute("GET", pattern, handler)


// POST defines the method to add POST request
func (group *RouterGroup) POST(pattern string, handler HandlerFunc) 
	group.addRoute("POST", pattern, handler)

可以仔细观察下addRoute函数，调用了group.engine.router.addRoute来实现了路由的映射。由于Engine从某种意义上继承了RouterGroup的所有属性和方法，因为 (*Engine).engine 是指向自己的。这样实现，我们既可以像原来一样添加路由，也可以通过分组添加路由。

---

使用 Demo

package main

import (
	"geo"
	"net/http"
)

func main() 
	r := geo.New()

	r.SetContextPath("/dhy")

	r.GET("/index", func(c *geo.Context) 
		c.HTML(http.StatusOK, "<h1>Index Page</h1>")
	)

	v1 := r.Group("/v1")
	
		v1.GET("/", func(c *geo.Context) 
			c.HTML(http.StatusOK, "<h1>Hello geo</h1>")
		)

		v1.GET("/hello", func(c *geo.Context) 
			// expect /hello?name=geoktutu
			c.String(http.StatusOK, "hello %s, you're at %s\\n", c.Query("name"), c.Path)
		)
	

	v2 := r.Group("/v2")
	
		v2.GET("/hello/:name", func(c *geo.Context) 
			c.String(http.StatusOK, "hello %s, you're at %s\\n", c.Param("name"), c.Path)
		)
		v2.POST("/login", func(c *geo.Context) 
			c.JSON(http.StatusOK, geo.H
				"username": c.PostForm("username"),
				"password": c.PostForm("password"),
			)
		)
	

	r.Run(":9999")