gin框架学习-路由分组和中间件

本文涉及的产品
Serverless 应用引擎 SAE,800核*时 1600GiB*时
服务治理 MSE Sentinel/OpenSergo,Agent数量 不受限
云原生网关 MSE Higress,422元/月
简介: Logger中间件将日志写入gin.DefaultWriter,即使配置了GIN_MODE=release。

前言


感谢开源项目gin-vue-admin,以及1010工作室的视频教程

本人学识尚浅,如有错误,请评论指出,谢谢!

详细可见个人博客:https://linzyblog.netlify.app/


一、路由分组


在我们实际的开发应用中我们希望能个各个功能模块的路由进行分组,同一个模块的不同路由带有同样的前缀。


  • 作用:首先是路由更加的清晰 并且我们在针对某一组路由进行中间件权限校验的时候也比较的方便。


代码示例:


r := gin.Default()
v1 := r.Group("v1")
v1.GET("/test1", func(c *gin.Context) {
  c.JSON(200, gin.H{
    "msg": "这里是test1",
  })
})
v1.GET("/test2", func(c *gin.Context) {
  c.JSON(200, gin.H{
    "msg": "这里是test2",
  })
})
r.Run(":8080")


打开postman选择GET请求,访问http://localhost:8080/v1/test1


7c834730148149dbafc104361e24776c.png


二、中间件


1、中间件简介


Gin框架允许开发者在处理请求的过程中,加入用户自己的钩子(Hook)函数。这个钩子函数就叫中间件,中间件适合处理一些公共的业务逻辑,比如登录认证、权限校验、数据分页、记录日志、耗时统计等。


6a0a299373fa45b4a53683a9e9190d32.png


中间件就是作用于两个模块之间的功能软件,可以作为拦截器、记录日志等,比如在前后端开发中


路由--------> 中间件(过滤作用)--------> 控制器


Gin中,中间件的效果可以简单的概括为:


  • 设置好中间件以后,中间件后面的路由都会使用这个中间件
  • 设置在中间件之前的路由则不会生效


2、定义中间件


Gin中的中间件必须是一个gin.HandlerFunc类型,在自定义中间件函数时,有两种写法:


func middleW() gin.HandlerFunc {
  return func(c *gin.Context) {
    ...
  }
}
router.Use(middleW())


或者


func middleW(c *gin.Context) {
  ...
}
router.Use(middleW())


3、注册中间件


在Gin框架中,我们可以注册全局中间件,也可以给单独路由或者路由组注册中间件,可以为路由添加任意数量的中间件。


  • 当我们存在多个中间件的时候,中间件的处理顺序是参考洋葱模型:


a1175dae4b594d2a9e17fafac81ed8d1.png


简而言之,请求是队列处理,响应则是堆栈处理。


  • 定义中间件代码:


//声明一个中间件方法
func middleW() gin.HandlerFunc {
  return func(c *gin.Context) {
    fmt.Println("我在方法前")
    c.Next()
    fmt.Println("我在方法后")
  }
}


1)注册全局中间件


代码示例:


func main() {
  r := gin.Default()
  //注册一个全局中间件
  r.Use(middleW())
  r.GET("/test", func(c *gin.Context) {
    fmt.Println("我在方法内部")
    c.JSON(200, gin.H{
      "msg": "成功了",
    })
  })
  r.Run(":8080")
}


打开postman选择GET请求,访问http://localhost:8080/test

0ab019b39b664bb88780b89eebfdf0e5.png

2bae28763ea342c68dfcd75859a5259d.png


2)单独注册某个路由中间件


代码示例:


func main() {
  r := gin.Default()
  r.GET("/test", middleW(), func(c *gin.Context) {
    fmt.Println("我在方法内部")
    c.JSON(200, gin.H{
      "msg": "成功了",
    })
  })
  r.Run(":8080")
}


打开postman选择GET请求,访问http://localhost:8080/test


0ab019b39b664bb88780b89eebfdf0e5.png

a48c06756f1b4e5b9717c7aade7bcd99.png


3)注册路由组中间件


代码示例:


func main() {
  r := gin.Default()
  //定义一个路由组 并注册中间件
  v1 := r.Group("v1").Use(middleW())
  v1.GET("/test1", func(c *gin.Context) {
    fmt.Println("我在方法内部")
    c.JSON(200, gin.H{
      "msg": "这里是test1",
    })
  })
  v1.GET("/test2", func(c *gin.Context) {
    fmt.Println("我在方法内部")
    c.JSON(200, gin.H{
      "msg": "这里是test2",
    })
  })
  r.Run()
}


打开postman选择GET请求,访问http://localhost:8080/v1/test1


9399ac3ab79c4a26a82225ad76a3304c.png


b9a2405bb57c4580964dc77e113e012e.png


4、中间件的嵌套


中间件可以嵌套使用,这里有三个Gin框架相关的函数。


1)Next()


表示跳过当前中间件剩余内容, 去执行下一个中间件。 当所有操作执行完之后,以出栈的执行顺序返回,执行中间件的剩余代码。


中间件定义:


//定义中间件1
func middlewOne() gin.HandlerFunc {
  return func(c *gin.Context) {
    fmt.Println("我在方法前,我是1")
    c.Next()
    fmt.Println("我在方法后,我是1")
  }
}
//定义中间件2
func middlewTwo() gin.HandlerFunc {
  return func(c *gin.Context) {
    fmt.Println("我在方法前,我是2")
    c.Next()
    fmt.Println("我在方法后,我是2")
  }
}
func main() {
  r := gin.Default()
  //使用多个中间件
  r.GET("/test", middlewOne(), middlewTwo(), func(c *gin.Context) {
    fmt.Println("我在方法内部")
    c.JSON(200, gin.H{
      "msg": "这里是test1",
    })
  })
  r.Run()
}


打开postman选择GET请求,访http://localhost:8080/test


2a3b0545289743c7b266a4630944bf74.png

7d647b6124b54ce4bb5bb1bfafa1352d.png


2)return


终止执行当前中间件剩余内容,执行下一个中间件。 当所有的函数执行结束后,以出栈的顺序执行返回,但不执行return后的代码。


//定义中间件1
func middlewOne() gin.HandlerFunc {
  return func(c *gin.Context) {
    fmt.Println("我在方法前,我是1")
    c.Next()
    fmt.Println("我在方法后,我是1")
  }
}
//定义中间件2
func middlewTwo() gin.HandlerFunc {
  return func(c *gin.Context) {
    fmt.Println("我在方法前,我是2")
    return
    fmt.Println("我在方法后,我是2")
  }
}
//定义中间件3
func middlewThree() gin.HandlerFunc {
  return func(c *gin.Context) {
    fmt.Println("我在方法前,我是3")
    c.Next()
    fmt.Println("我在方法后,我是3")
  }
}
func main() {
  r := gin.Default()
  //使用多个中间件
  r.GET("/test", middlewOne(), middlewTwo(), middlewThree(), func(c *gin.Context) {
    fmt.Println("我在方法内部")
    c.JSON(200, gin.H{
      "msg": "这里是test1",
    })
  })
  r.Run()
}


打开postman选择GET请求,访问http://localhost:8080/test

cce05fc51f28498e90a1740c2d4ca02c.png

8115efe92b494c978c5c3c08ab445bfa.png


3Abort()


只执行当前中间件, 操作完成后,以出栈的顺序,依次返回上一级中间件。


//定义中间件1
func middlewOne() gin.HandlerFunc {
  return func(c *gin.Context) {
    fmt.Println("我在方法前,我是1")
    c.Next()
    fmt.Println("我在方法后,我是1")
  }
}
//定义中间件2
func middlewTwo() gin.HandlerFunc {
  return func(c *gin.Context) {
    fmt.Println("我在方法前,我是2")
    c.Abort()
    fmt.Println("我在方法后,我是2")
  }
}
//定义中间件3
func middlewThree() gin.HandlerFunc {
  return func(c *gin.Context) {
    fmt.Println("我在方法前,我是3")
    c.Next()
    fmt.Println("我在方法后,我是3")
  }
}
func main() {
  r := gin.Default()
  //使用多个中间件
  r.GET("/test", middlewOne(), middlewTwo(), middlewThree(), func(c *gin.Context) {
    fmt.Println("我在方法内部")
    c.JSON(200, gin.H{
      "msg": "这里是test1",
    })
  })
  r.Run()
}


打开postman选择GET请求,访问http://localhost:8080/test


04f7b5cc80e641c2a814c946a513abf6.png

4222e681c5f84f5dab50b84c4e7005e0.png


5、中间件注意事项


1)gin默认中间件


gin.Default()默认使用了Logger和Recovery中间件,其中:


Logger中间件将日志写入gin.DefaultWriter,即使配置了GIN_MODE=release。


Recovery中间件会recover任何panic。如果有panic的话,会写入500响应码。


如果不想使用上面两个默认的中间件,可以使用gin.New()新建一个没有任何默认中间件的路由。


2)gin中间件中使用goroutine


当在中间件或handler中启动新的goroutine时,不能使用原始的上下文(c *gin.Context),必须使用其只读副本(c.Copy())。


参考大佬资料:https://blog.csdn.net/qq_49723651/article/details/123694746

目录
相关文章
|
1天前
|
消息中间件 中间件 Kafka
中间件事件总线路由与分发
【6月更文挑战第20天】
5 1
中间件事件总线路由与分发
|
5天前
|
JSON 监控 中间件
中间件在API路由控制
【6月更文挑战第16天】
18 7
|
17天前
|
消息中间件 存储 中间件
中间件消息队列存储和路由
【6月更文挑战第6天】
19 3
|
8天前
|
JSON 中间件 数据格式
Gin框架学习笔记(五) ——文件上传与路由中间件
Gin框架学习笔记(五) ——文件上传与路由中间件
|
1月前
|
JavaScript 中间件 PHP
中间件应用程序路由和分发
【5月更文挑战第13天】中间件应用程序路由和分发
28 2
|
23天前
|
消息中间件 存储 NoSQL
阿里开源中间件一览
阿里开源中间件一览
26 2
|
1月前
|
算法 NoSQL Java
2023年阿里高频Java面试题:分布式+中间件+高并发+算法+数据库
又到了一年一度的金九银十,互联网行业竞争是一年比一年严峻,作为工程师的我们唯有不停地学习,不断的提升自己才能保证自己的核心竞争力从而拿到更好的薪水,进入心仪的企业(阿里、字节、美团、腾讯.....)
|
10月前
|
NoSQL Java Redis
阿里Java高级岗中间件二面:GC+IO+JVM+多线程+Redis+数据库+源码
虽然“钱多、事少、离家近”的工作可能离技术人比较远,但是找到一份合适的工作,其实并不像想象中那么难。但是,有些技术人确实是认真努力工作,但在面试时表现出的能力水平却不足以通过面试,或拿到高薪,其实不外乎以下 2 个原因:
|
10月前
|
算法 NoSQL Java
2023年阿里高频Java面试题:分布式+中间件+高并发+算法+数据库
又到了一年一度的金九银十,互联网行业竞争是一年比一年严峻,作为工程师的我们唯有不停地学习,不断的提升自己才能保证自己的核心竞争力从而拿到更好的薪水,进入心仪的企业(阿里、字节、美团、腾讯.....)
|
10月前
|
算法 NoSQL Java
2021年阿里高频Java面试题:分布式+中间件+高并发+算法+数据库
又到了一年一度的金九银十,互联网行业竞争是一年比一年严峻,作为工程师的我们唯有不停地学习,不断的提升自己才能保证自己的核心竞争力从而拿到更好的薪水,进入心仪的企业(阿里、字节、美团、腾讯.....)