1 中间件介绍
中间件就是当用户请求还没有到达路由时需要执行的代码块,我们就可以理解为是中间件
package main
import (
"fmt"
"github.com/gin-gonic/gin"
)
func main() {
// 1.实例化引擎
r := gin.Default()
// 中间件应用在请求达到路由层之前就可以称为中间件
// 2.路由
r.GET("/", func(context *gin.Context) {
context.String(200, "haha")
})
fmt.Println("http://10.0.0.134:8080/")
// 3.启动
r.Run()
}
- Gin框架允许开发者在处理请求的过程中,加入用户自己的钩子(Hook)函数。
- 这个钩子函数就叫中间件,中间件适合处理一些公共的业务逻辑
- 比如 登录认证、权限校验 、数据分页、记录日志、耗时统计等。
2 中间件范例
2.1 全局中间件
在下面的例子中我们可以看到一个最基本的中间件该如何通过代码来实现呢?
gin 的中间件中必须返回一个 gin.HandlerFunc
的方法,只要满足这个方法就实现了中间件
package main
import (
"fmt"
"github.com/gin-gonic/gin"
)
// 4.定义一个全局中间件(所有路由都会使用到)
// gin.HandlerFunc:是 gin 中间件中必须返回的方法
func MiddleWare() gin.HandlerFunc {
return func(context *gin.Context) {
fmt.Println("全局中间件")
}
}
func main() {
// 1.实例化引擎
r := gin.Default()
// 5.注册全局中间件
r.Use(MiddleWare())
// 2.路由
r.GET("/", func(context *gin.Context) {
fmt.Println("我是路由!")
context.String(200, "haha")
})
fmt.Println("http://10.0.0.134:8080/")
// 3.启动
r.Run()
}
当用户请求之后,可以看到先执行的是我们中间件,然后在执行路由里面的内容
2.2 局部中间件
所谓的局部中间件其实就是对应单独的一个 URL 做处理函数,也就是当用户访问某些特定的 URL 之后就触发执行对应的注册局部中间件。
package main
import (
"fmt"
"github.com/gin-gonic/gin"
)
// 3.局部中间件
func MiddleWare() gin.HandlerFunc {
return func(context *gin.Context) {
fmt.Println("我是中间件")
}
}
func main() {
// 1.实例引擎
r := gin.Default()
// 4.注册中间件,当用户访问 home URL 就触发 MiddleWare() 中间件,并返回 gin.HandlerFunc 中的内容
// 局部中间件只对指定路由进行限制
r.GET("/home", MiddleWare(), func(context *gin.Context) {
fmt.Println("我是 home")
context.JSON(200, gin.H{"msg": "/home success"})
})
// 2.路由
r.GET("/hello", func(context *gin.Context) {
fmt.Println("我是 hello")
context.JSON(200, gin.H{"msg": "/hello success"})
})
fmt.Println("http://10.0.0.134:8080")
// 5.运行
r.Run()
}
第一次访问 hello URL
第二次访问 home URL
可以看到通过不同的 URL 就实现对不同的路由进行访问
2.3 Next() 方法
- 在中间件中调用 next() 方法,会从 next() 方法调用的地方跳转到视图函数
- 视图函数执行完成再调用 next() 方法
package main
import (
"fmt"
"github.com/gin-gonic/gin"
)
// 3.局部中间件
func MiddleWare() gin.HandlerFunc {
return func(c *gin.Context) {
fmt.Println("开始执行中间件")
// 执行视图函数
c.Next()
fmt.Println("视图函数执行完毕后在调用 next 方法")
}
}
func main() {
// 1.实例引擎
r := gin.Default()
// 4.全局中间件
r.Use(MiddleWare())
// 2.路由
r.GET("/hello", func(context *gin.Context) {
fmt.Println("我是 hello")
context.JSON(200, gin.H{"msg": "/hello success"})
})
fmt.Println("http://10.0.0.134:8080")
// 5.运行
r.Run()
}
访问 hello 路由
后台服务端输出可以看到,在中间件中加了 next() 方法后可以看到,当用户请求访问的了 /hello 方法之后虽然执行了全局中间件 MiddleWare
,但是在 MiddleWare
中间件中包含了 Next() 方法,所以 Next() 方法就回去调用 /hello
路由,当 hello 处理完毕之后在重新跳转至 Next() 方法中的 MiddleWare
中间件继续执行后续的代码
那么一般在什么场景下使用 Next()
方法的这么一个中间件呢?那么就看下面的示例
2.4 实现 Token 认证
http://127.0.0.1:8080/index index首页无需 token 直接访问
http://127.0.0.1:8080/home home家目录需要对 token 进行验证,验证通过才可访问
在这个范例代码中我将写两个页面分别是 index 和 home 页面;index 页面无需用户登陆就能够看到,而 home 页面则需要用户登录才能够实现访问。
这里的 token 密码为 123456
package main
import (
"fmt"
"github.com/gin-gonic/gin"
)
func Auth() gin.HandlerFunc {
return func(c *gin.Context) {
// 通过 c.Request 可以获取用户请求时头部信息携带的 token 字段
token := c.Request.Header.Get("token")
fmt.Println("获取 token :", token)
// 校验 token
if token != "123456" {
c.String(403, "token 错误")
c.Abort() // 该方法可以提前终止当前请求,也就是说当 token 校验失败就停止访问,并不会将请求转发给路由
return
}
// 如果 token 验证成功调用 Next() 方法执行处理函数
c.Next()
}
}
func main() {
r := gin.Default()
// index 无须登录直接访问
r.GET("/index", func(c *gin.Context) {
c.JSON(200, gin.H{"msg": "/index 无须 token 登录直接访问"})
})
// home 页面需要登陆访问,注册 Auth 认证中间件
r.GET("/home", Auth(), func(c *gin.Context) {
c.JSON(200, gin.H{"msg": "/home 需要验证 token 访问"})
})
r.Run()
}
1 访问 index 页面无须 token ,访问成功获取响应
2 访问 home 页面输入错误 token,无法访问到 home 页面,状态码 403
3 输入正确 token 进行访问,访问成功
3 Restful 风格
3.1 什么时 Restful 风格
-
REST与技术无关,代表的是一种软件架构风格(REST是Representational State Transfer的简称,中文翻译为“表征状态转移”)
-
REST从 资源 的角度类审视整个网络,它将分布在网络中某个节点的 资源通过URL进行标识
-
所有的数据,不过是通过网络获取的还是 操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
- 就是在 Restful 里面所有的数据都可以看作一个资源对象
- 比如我们在点外卖的时候下单买的菜、买的东西这些都可以理解为资源,Restful 可以将所有内容都抽象成一种资源
-
对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)
3.2 web 开发本质
- 对数据库中的表进行增删改查操作
- Restful 风格就是把所有数据都当做资源 , 对表的操作就是对资源操作
- 在 url 同通过 资源名称来指定资源
- 通过(增删改查) get/post/put/delete/patch 对资源的操作
- get : 获取一条数据 (一个学生信息) 、或者是获取数据列表(所有学生信息)
- post:添加一条数据
- put:修改一些信息
- delete:删除一条数据
3.3 RESTful 设计规范
3.3.1 URL 路径
面向资源编程 : 路径,视网络上任何东西都是资源, 均使用名词表示(可复数),不要使用动词
# 不好的例子:url中含有动词
/getProducts
/listOrders
# 正确的例子:地址使用名词复数
GET /products # 将返回所有产品信息
POST /products # 将新建产品信息
GET /products/4 # 将获取产品4
PUT /products/4 # 将更新产品4
3.3.2 请求方式
- 访问同一个URL地址,采用不同的请求方式,代表要执行不同的操作
- 常用的HTTP请求方式有如下四种:
GET /books # 获取所有图书数据
POST /books # 新建一本图书数据
GET /books/<id>/ # 获取某个指定的图书数据
PUT /books/<id>/ # 更新某个指定的图书数据
DELETE /books/<id>/ # 删除某个指定的图书数据
3.3.3 过滤信息
过滤,分页,排序
:通过在 url 上传参的形式传递搜索条件- 常见的参数:
?limit=10 # 指定返回记录的数量。
?offset=10 # 指定返回记录的开始位置。
?page=2&pagesize=100 # 指定第几页,以及每页的记录数。
?sortby=name&order=asc # 指定返回结果按照哪个属性排序,以及排序顺序。