Gin增加超时控制中间件

简介: Gin增加超时控制中间件

Gin增加超时控制



背景


  • 有时候很多API有业务超时要求,就是数据必须在几秒内返回,超时的话立刻结束,不用卡死在某一个页面上。


目标


  • 对这一类API特定处理,增加超时控制,不要影响别的API


方案


  • 方案很简单,就是利用go提供的context技术对gin框架的request对象进行改造,使其具备超时控制机能。


代码:

package main
import (
 "context"
 "fmt"
 "log"
 "net/http"
 "time"
 "github.com/gin-gonic/gin"
)
// 超时控制中间件
func timeoutMiddleware(timeout time.Duration) func(c *gin.Context) {
 return func(c *gin.Context) {
  // 用超时context wrap request的context
  ctx, cancel := context.WithTimeout(c.Request.Context(), timeout)
  defer func() {
   // 检查是否超时
   if ctx.Err() == context.DeadlineExceeded {
    c.Writer.WriteHeader(http.StatusGatewayTimeout)
    c.Abort()
   }
   //清理资源
   cancel()
  }()
  // 替换
  c.Request = c.Request.WithContext(ctx)
  c.Next()
 }
}
func timedHandler(duration time.Duration) func(c *gin.Context) {
 return func(c *gin.Context) {
  // 获取替换之后的context 它具备了超时控制
  ctx := c.Request.Context()
  // 定义响应struct
  type responseData struct {
   status int
   body   map[string]interface{}
  }
  // 创建一个done chan表明request要完成了
  doneChan := make(chan responseData)
  // 模拟API耗时的处理
  go func() {
   time.Sleep(duration)
   doneChan <- responseData{
    status: 200,
    body:   gin.H{"hello": "world"},
   }
  }()
  // 监听两个chan谁先到达
  select {
  // 超时
  case <-ctx.Done():
   return
   // 请求完成
  case res := <-doneChan:
   c.JSON(res.status, res.body)
  }
 }
}
func main() {
 engine := gin.New()
 // 不用超时控制
 group := engine.Group("/normal")
 {
  group.GET("/short", timedHandler(time.Second))
 }
 // 需要超时控制 时间控制在2s
 timeoutGroup := engine.Group("/timeout")
 timeoutGroup.Use(timeoutMiddleware(time.Second * 2))
 {
  // 延迟5s
  timeoutGroup.GET("/long", timedHandler(time.Second*5))
 }
 // run the server
 log.Fatal(engine.Run(":5090"))
}


验证


  1. 正常请求

  2. 超时请求
目录
打赏
0
0
0
1
5
分享
相关文章
gin中间件(Use)不能写在响应函数之后的原因——源码分析
gin中间件(Use)不能写在响应函数之后的原因——源码分析
156 0
gin框架学习-路由分组和中间件
Logger中间件将日志写入gin.DefaultWriter,即使配置了GIN_MODE=release。
453 57
gin框架学习-路由分组和中间件
史上最详细的Gin中间件使用教程
1.概述 Gin框架允许开发者在处理请求的过程中,加入用户自己的钩子(Hook)函数。这个钩子函数就叫中间件,中间件适合处理一些公共的业务逻辑,比如登录认证、权限校验、数据分页、记录日志、耗时统计等。
1365 59
史上最详细的Gin中间件使用教程
你用Go写过中间件吗?带你用Gin实现【用户角色权限管理中间件】
管理后台有超管权限,超管拥有所有权限;普通管理员可以设置角色,角色单选;角色可以赋予多个权限,权限多选;这样我们就实现了对普通管理员的角色和权限的灵活管理
535 71
你用Go写过中间件吗?带你用Gin实现【用户角色权限管理中间件】
gin注册自定义中间件失效
gin注册自定义中间件失效
327 39
【消息中间件】详解三大MQ:RabbitMQ、RocketMQ、Kafka
【消息中间件】详解三大MQ:RabbitMQ、RocketMQ、Kafka
7655 0
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等

登录插画

登录以查看您的控制台资源

管理云资源
状态一览
快捷访问