Gin的中间件执行流程与用法详解
作者:GEEK JUMP
一、背景
我们在使用Gin框架进行Web开发的时候,基本上都会遇到登录拦截的场景。 例如某些接口必须在登录以后才能访问,根据登录用户的信息以及权限,拿到属于自己的数据, 反之,没登录过则直接拒绝访问。 那么我们怎么做到这些登录拦截呢? 做过Java spring开发或者其它框架开发的同学知道,这种场景一般都是设置一个登录的拦截器,全局统一在拦截器进行登录权限校验处理, 符合登录条件则放行请求到业务函数,否则拒绝访问。 这样可以方便我们做统一管理,不需要每个业务函数再自己重复写一套一模一样的拦截逻辑。
在Gin当中, 中间件和业务处理函数都是一样的类型,都是一种函数,这个函数签名是这样的 func(c *gin.Context){},Gin的Egine对象就是把这些函数func(c *gin.Context){}放到一个slice切片数组里面, 然后默认按照顺序执行。 只要你的函数func(c *gin.Context){}, 我们都可以把这个函数作为Gin的中间件函数。
业务函数这个handlers切片数组的最后一个元素, 那么在业务函数前面我们可以增加很多的函数,这些函数我们称为中间件函数.
我们可以调用c.Next() 执行下一个中间件函数/后续函数, 也可以调用c.Abort()终止后续的中间件执行。
通过c.Next(), 查看源码我们看到这么一个结构:
c.Next()就是将这个handlers[函数链数组]往下移动一个元素,也就是执行调用下一个中间件函数。
每个函数接收到的*Context, 都可以随时结束响应HTTP请求,也可以获取HTTP请求参数,由此做到中间件拦截处理的作用。
二、执行流程图
1、总流程图
如果没有调用Abort()、Next()这些函数,则执行是按照中间件使用的顺序执行。
2、Abort()的使用
调用Abort(), 终止后续中间件的执行,直接响应HTTP内容。 默认Abort(), 响应状态码是200,并且没有任何payload响应内容。 除了Abort(), 还有基于Abort()演变的几个函数,方便我们更改响应状态码例如403、内容等等。
源测试代码:
package main import ( "fmt" "github.com/gin-gonic/gin" "net/http" ) func A(c *gin.Context) { fmt.Println("A1") c.Abort() } func B(c *gin.Context) { fmt.Println("B1") } func main() { c := gin.Default() // 使用两个中间件函数, 按照定义的顺序执行 A,B c.Use(A, B) c.GET("/hello", func(c *gin.Context) { fmt.Println("业务函数") c.JSON(http.StatusOK, gin.H{ "message": "hello world", }) }) c.Run() }
运行结果: 运行到A中间件遇到Abort(), 后续的中间件或业务函数也不会被执行
3、Next()的使用 ;
源测试代码:
package main import ( "fmt" "github.com/gin-gonic/gin" "net/http" ) func A(c *gin.Context) { fmt.Println("A1") c.Next() fmt.Println("A1-end") } func B(c *gin.Context) { fmt.Println("B1") } func main() { c := gin.Default() // 使用两个中间件函数, 按照定义的顺序执行 A,B c.Use(A, B) c.GET("/hello", func(c *gin.Context) { fmt.Println("业务函数") c.JSON(http.StatusOK, gin.H{ "message": "hello world", }) }) c.Run() }
运行结果:
先运行到A中间件, A调用c.Next()此时继续调用下一个中间件, 所以先打印A1、到B1, 最后到业务函数, 输出"业务函数". 最后业务函数执行完毕,退回上一层B中间件,B中间件执行完毕,回到A. 此时A里面的c.Next()已经全部执行完毕,最后输出A1-end, 最后响应HTTP请求.
所以如果要想做最后的响应拦截,那么第一个中间件要通过c.Next()的方式,在c.Next()之后添加最终响应逻辑。 例如可以统一更改status状态码、或者添加header、或者删除header等等。
以上就是Gin的中间件执行流程与用法详解的详细内容,更多关于Gin中间件执行的资料请关注脚本之家其它相关文章!