百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

gin框架中间件详解(gin的中间件)

ccwgpt 2025-04-05 17:17 15 浏览 0 评论

中间件是一种可以拦截HTTP请求-响应生命周期的特殊函数,可以在请求处理过程中加入用户自己的钩子函数。Gin框架提供了一些默认的中间件,如Logger和Recovery,也允许用户自定义中间件

使用中间件的好处有:

  • 实现了逻辑的解耦和分离,每个中间件只负责各自的功能
  • 可以实现一些通用的功能,如日志输出、错误处理、身份验证等
  • 可以根据不同的路由或分组选择不同的中间件,实现灵活的控制

全局中间件:可以使用r.Use()方法注册一个全局中间件,它会对所有的请求生效。例如:

package main
import (
    "fmt"
    "net/http"
    "github.com/gin-gonic/gin"
)
func middleware1() gin.HandlerFunc {
    return func(c *gin.Context) {
        fmt.Println("这是中间件")
        c.Next()
    }
}
func main() {
    r := gin.Default()
    //注册一个全局中间件
    r.Use(middleware1())
    r.GET("/test", func(c *gin.Context) {
        fmt.Println("陈王昔时宴平乐,斗酒十千恣欢谑")
        c.JSON(http.StatusOK, gin.H{
            "msg": "主人何为言少钱,径须沽取对君酌",
        })
    })
    r.Run(":8080")
}

路由分组中间件:可以使用r.Group()方法创建一个路由分组,并在该分组上注册中间件,它只会对该分组下的请求生效。例如:

package main
import (
    "fmt"
    "github.com/gin-gonic/gin"
)
func middleware1() gin.HandlerFunc {
    return func(c *gin.Context) {
        fmt.Println("这是中间件")
        c.Next()
    }
}
func main() {
    r := gin.Default()
    v1 := r.Group("v1")
    v2 := r.Group("v2")
    //注册一个路由分组中间件
    v1.Use(middleware1())
    v1.GET("/test", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "msg": "这里是v1-test",
        })
    })
    v2.GET("/test", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "msg": "这里是v2-test",
        })
    })
    r.Run(":8080")
}

单个路由中间件:可以在注册单个路由时,传入多个处理函数,第一个处理函数就是中间件,它只会对该路由的请求生效。例如:

package main
import (
    "fmt"
    "net/http"
    "github.com/gin-gonic/gin"
)
func middleware1() gin.HandlerFunc {
    return func(c *gin.Context) {
        fmt.Println("这里是中间件")
        c.Next()
    }
}
func main() {
    r := gin.Default()
    //注册一个单个路由中间件
    r.GET("/", middleware1(), func(c *gin.Context) {
        fmt.Println("古来圣贤皆寂寞")
        c.JSON(http.StatusOK, "惟有饮者留其名")
    })
    r.Run(":8080")
}

在gin框架中,编写自定义的中间件函数的方法是定义一个返回值为gin.HandlerFunc类型的函数,并在该函数中接收一个*gin.Context类型的参数,用于获取请求和响应对象。例如:

// 定义一个自定义的日志记录中间件
func Logger() gin.HandlerFunc {
    return func(c *gin.Context) {
        // 获取请求路径和方法
        path := c.Request.URL.Path
        method := c.Request.Method
        // 打印到控制台
        fmt.Printf("路径: %s, 方法: %s\n", path, method)
        // 调用下一个中间件或路由处理函数
        c.Next()
    }
}

Next()函数:

在gin框架中,next()是一个中间件函数中的一个函数,用于将控制权传递给下一个中间件函数或路由处理程序。当遇到c.Next()函数时,它取出所有的没被执行过的注册的函数都执行一遍,然后再回到本函数中。没遇到c.Next()函数将结束当前中间件程序。

package main
import (
    "fmt"
    "github.com/gin-gonic/gin"
)
func middleware1() gin.HandlerFunc {
    return func(c *gin.Context) {
        fmt.Println("中间件1开始")
        c.Next()
        fmt.Println("中间件1结束")
    }
}
func middleware2() gin.HandlerFunc {
    return func(c *gin.Context) {
        fmt.Println("中间件2开始")
        c.Next()
        fmt.Println("中间件2结束")
    }
}
func middleware3() gin.HandlerFunc {
    return func(c *gin.Context) {
        fmt.Println("中间件3开始")
        c.Next()
        fmt.Println("中间件3结束")
    }
}
func main() {
    r := gin.Default()
    r.Use(middleware1(), middleware2(), middleware3())
    r.GET("/", func(c *gin.Context) {
        fmt.Println("古来圣贤皆寂寞")
        c.JSON(200, gin.H{
            "data": "惟有饮者留其名",
        })
    })
    r.Run(":8080")
}

以上示例中,当中间件1中遇到c.Next(),将控制权传递给中间件2,再次遇到c.Next()函数将控制权传递给中间3,中间件3将控制权传递给路由处理程序;然后再回到中间件3,执行c.Next()后的程序,中间件3结束,后面一次是中间件2、中间件1结束。

备注中间件1中的c.Next()函数,程序执行结果如下:

func middleware1() gin.HandlerFunc {
    return func(c *gin.Context) {
        fmt.Println("中间件1开始")
        // c.Next()
        fmt.Println("中间件1结束")
    }
}

中间件1中没使用c.Next()函数,将直接执行完毕本函数,再依次执行注册的中间件函数。

Abort()函数:

在gin框架中,abort()是Context对象的一个方法,用于立即终止当前请求并返回一个指定的HTTP状态码和错误信息。

func middleware2() gin.HandlerFunc {
    return func(c *gin.Context) {
        fmt.Println("中间件2开始")
        if 3 < 4 {
            c.Abort()
        }
        c.Next()
        fmt.Println("中间件2结束")
    }
}

在中间件2中使用Abort()函数,执行结果如下:

中间件1开始 
中间件2开始 
中间件2结束 
中间件1结束

这个方法函数常用于处理一些非法请求或者权限校验失败的场景。例如:

func AuthMiddleware() gin.HandlerFunc {
    return func(c *gin.Context) {
        // 检查用户是否登录
        if !IsLoggedIn(c) {
            c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "未登录"})
            return
        }
        // 认证通过,继续执行后续的中间件和处理函数
        c.Next()
    }
}

在这个示例中,AuthMiddleware中间件会检查用户是否已登录,如果未登录,则使用abort()方法立即返回一个状态码为401的错误响应,否则继续执行后续的中间件和处理函数。

内置BasicAuth中间件

BasicAuth中间件是一个用于基本认证的中间件,它会对请求进行基本认证,如果认证失败,则返回401 Unauthorized错误响应。

package main

import (
    "net/http"

    "github.com/gin-gonic/gin"
)

var map_data map[string]interface{} = map[string]interface{}{
    "xiaoming": gin.H{"age": 18, "addr": "xxx"},
    "xiaohong": gin.H{"age": 20, "addr": "xxxx"},
}

func main() {
    r := gin.Default()
    // gin.Accounts是gin框架中用于存储用户账号和密码的一种数据结构。
    // 它是一个map[string]string类型的变量,其中键表示用户名,值表示密码。
    // 它通常用于BasicAuth中间件中,用于验证用户的用户名和密码。
    r.GET("/", gin.BasicAuth(gin.Accounts{
        "xiaotu": "123456",
    }), func(c *gin.Context) {
        user_name := c.Query("user_name")
        data, ok := map_data[user_name]
        if ok {
            c.JSON(http.StatusOK, gin.H{
                "user": user_name,
                "data": data,
            })
        } else {
            c.JSON(http.StatusNotFound, gin.H{
                "user": user_name,
                "data": "没有数据",
            })
        }
    })
    r.Run(":8080")
}

使用账户xiaotu和密码123456登录,进行授权认证通过,访问路径中user_name参数为xiaoming和xiaohong的时候,获取对应的信息。

访问路径中user_name参数为xiaohong111的时候,没有对应的数据。

在这个示例中,我们使用了BasicAuth中间件,只有在提供正确的用户名和密码时,才能访问该接口。在这里,我们使用了一个固定的用户名和密码。

相关推荐

2025南通中考作文解读之四:结构框架

文题《继续走,迈向远方》结构框架:清晰叙事,层层递进示例结构:1.开头(点题):用环境描写或比喻引出“走”与“远方”,如“人生如一条长路,每一次驻足后,都需要继续走,才能看见更美的风景”。2.中间...

高中数学的知识框架(高中数学知识框架图第三章)

高中数学的知识框架可以划分为多个核心板块,每个板块包含具体的知识点与内容,以下为详细的知识框架结构:基础知识1.集合与逻辑用语:涵盖集合的概念、表示方式、性质、运算,以及命题、四种命题关系、充分条件...

决定人生的六大框架(决定人生的要素)

45岁的自己混到今天,其实是失败的,要是早点意识到影响人生的六大框架,也不至于今天的模样啊!排第一的是环境,不是有句话叫人是环境的产物,身边的环境包括身边的人和事,这些都会对一个人产生深远的影响。其次...

2023年想考过一级造价师土建计量,看这30个知识点(三)

第二章工程构造考点一:工业建筑分类[考频分析]★★★1.按厂房层数分:(1)单层厂房;(2)多层厂房;(3)混合层数厂房。2.按工业建筑用途分:(1)生产厂房;(2)生产辅助厂房;(3)动力用厂房;(...

一级建造师习题集-建筑工程实务(第一章-第二节-2)

建筑工程管理与实务题库(章节练习)第一章建筑工程技术第二节结构设计与构造二、结构设计1.常见建筑结构体系中,适用建筑高度最小的是()。A.框架结构体系B.剪力墙结构体系C.框架-剪力墙结构体系D...

冷眼读书丨多塔斜拉桥,这么美又这么牛

”重大交通基础设施的建设是国民经济和社会发展的先导,是交通运输行业新技术集中应用与创新的综合体现。多塔斜拉桥因跨越能力强、地形适应性强、造型优美等特点,备受桥梁设计者的青睐,在未来跨越海峡工程中将得...

2021一级造价师土建计量知识点:民用建筑分类

2021造价考试备考开始了,学霸君为大家整理了一级造价师备考所用的知识点,希望对大家的备考道路上有所帮助。  民用建筑分类  一、按层数和高度分  1.住宅建筑按层数分类:1~3层为低层住宅,4~6层...

6个建筑结构常见类型,你都知道吗?

建筑结构是建筑物中支承荷载(作用)起骨架作用的体系。结构是由构件组成的。构件有拉(压)杆、梁、板、柱、拱、壳、薄膜、索、基础等。常见的建筑结构类型有6种:砖混结构、砖木结构、框架结构、钢筋混凝土结构、...

框架结构设计经验总结(框架结构设计应注意哪些问题)

1.结构设计说明主要是设计依据,抗震等级,人防等级,地基情况及承载力,防潮抗渗做法,活荷载值,材料等级,施工中的注意事项,选用详图,通用详图或节点,以及在施工图中未画出而通过说明来表达的信息。2.各...

浅谈混凝土框架结构设计(混凝土框架结构设计主要内容)

浅谈混凝土框架结构设计 摘要:结构设计是个系统的全面的工作,需要扎实的理论知识功底,灵活创新的思维和严肃认真负责的工作态度。钢筋混凝土框架结构虽然相对简单,但设计中仍有很多需要注意的问题。本文针...

2022一级建造师《建筑实务》1A412020 结构设计 精细考点整理

历年真题分布统计1A412021常用建筑结构体系和应用一、混合结构体系【2012-3】指楼盖和屋盖采用钢筋混凝土或钢木结构,而墙和柱采用砌体结构建造的房屋,大多用在住宅、办公楼、教学楼建筑中。优点:...

破土动工!这个故宫“分院”科技含量有点儿高

故宫“分院”设计图。受访者供图近日,位于北京海淀区西北旺镇的故宫北院区项目已开始破土动工,该项目也被称作故宫“分院”,筹备近十年之久。据悉,故宫本院每年展览文物的数量不到1万件,但是“分院”建成后,预...

装配式结构体系介绍(上)(装配式结构如何设计)

PC构件深化、构件之间连接节点做法等与相应装配式结构体系密切相关。本节列举目前常见的几种装配式结构体系:装配整体式混凝土剪力墙结构体系、装配整体式混凝土框架结构体系、装配整体式混凝土空腔结构体系(S...

这些不是双向抗侧结构体系(这些不是双向抗侧结构体系的特点)

双向抗侧土木吧规范对双向抗恻力结构有何规定?为何不应采用单向有墙的结构?双向抗侧土木吧1.规范对双向抗侧力结构体系的要求抗侧力体系是指抵抗水平地震作用及风荷载的结构体系。对于结构体系的布置,规范针对...

2022一级建造师《建筑实务》1A412020 结构设计 精细化考点整理

1A412021常用建筑结构体系和应用一、混合结构体系【2012-3】指楼盖和屋盖采用钢筋混凝土或钢木结构,而墙和柱采用砌体结构建造的房屋,大多用在住宅、办公楼、教学楼建筑中。优点:抗压强度高,造价...

取消回复欢迎 发表评论: