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

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

ccwgpt 2025-04-05 17:17 4 浏览 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中间件,只有在提供正确的用户名和密码时,才能访问该接口。在这里,我们使用了一个固定的用户名和密码。

相关推荐

NestJS入门教程系列一

介绍Nest(NestJS)是用于构建高效,可扩展的Node.js服务器端应用程序的框架。它使用渐进式JavaScript,内置并完全支持TypeScript(但开发人员仍然能够使用JavaScrip...

【推荐】一个网盘资源搜索与转存工具,支持移动端与PC端!

如果您对源码&技术感兴趣,请点赞+收藏+转发+关注,大家的支持是我分享最大的动力!!!项目介绍CloudSaver是一个基于Vue3和Express的网盘资源搜索与转存开源实用工具。它支持...

Appium原理精讲

目前使用Appium新版本和旧版本的企业数目都很多,而两个版本的安装过程和api的使用又有较大的区别。但是无论表面上的东东如何变化,内部原理都是一样的。在这里我给大家介绍一下appium的核心,增进大...

Kubernetes最小部署单元Pod

一、Kubernetes与Pod简介在当今云计算和容器化技术盛行的时代,Kubernetes已然成为容器编排领域的中流砥柱。它是一个开源的容器编排平台,由Google基于其内部使用的Bo...

最常用的四种跨域解决方案

前置知识什么是跨域?浏览器发送的请求地址(URL)与所在页面的地址不同(端口/协议/域名其一不同)。简言之,浏览器发出的请求url,与其所在页面的url不一样。此时,同源策略会让浏览器拒收服务器...

Bolt.New —— 全栈AI Web自动编程

Bolt.New是由StackBlitz公司推出的,全栈AI工具,代码编辑、运行、部署,通通一站式搞定。它使用WebContainers技术,无需任何本地安装或配置,在浏览器中,就可以运行完整的No...

Nodejs Express新手教程&amp;高手进阶

NodejsExpress新手教程&高手进阶Express是一个NodeJS平台的框架,主要用于构于Web服务器项目。本文将通过示例介绍适合新手入门的Express基础使用,以及高手进阶知识,如:c...

Express.js 创建Node.js Web应用

Express.js是一个基于Node.js的Web应用框架,框架的设计目的是构建应用的架构和简化应用的开发。框架会解决一些通用的问题,在Express.js中,Express框架会处理如:中间件、代...

JavaScript 的 Express.js 功能及应用场景详解

Express.js是一个基于Node.js的轻量级Web应用框架,主要用于快速构建服务器端应用和API。它的核心功能包括以下关键点:1.路由管理URL路径与HTTP方法映射:通过...

nodejs的express4文件下载

在nodejs的express框架中,下载变得非常简单,就一个方法,res.download()首先express命令行生成项目基本框架:不会的看这里:http://blog.csdn.net/zz...

Express 系列:快速生成一个项目

系列预告本系列将以一个项目入手结合相关技术细节来带领大家一起学习Express这个基于Node.js的后端框架。本文首先将介绍:如何快速的生成一个具有一定结构的Express项目。Express项目结...

nodejs的express自动生成项目框架

nodejs版本为:4.X,express版本为4.X1.全局安装2个模块express、express-generator在命令行输入:npminstall-gexpressnpminsta...

express开发(一)简介与搭建

上周末去了趟上海书城,不愧是上海数得上号的书城,流行的科技书应有尽有,话不多说直接上图。最经典的C语言O(∩_∩)O最流行的java(づ ̄3 ̄)づ超酷的R语言/(ㄒoㄒ)/~~然而,身为一个坚定的前...

Vue+Echarts可视化大屏系统后端框架搭建(附代码)

各位同学,大家好。上节课,前面我们讲解了Vue+Echarts前端部分的设计方法。这节课程,我们开始讲解使用Express进行后端设计的方法。01项目相关理论介绍什么是expressExpress是...

Shopify电商API接口开发

Shopify电商API接口开发上线流程主要包括以下步骤。北京木奇移动技术有限公司,专业的软件外包开发公司,欢迎洽谈合作。前期准备-注册Shopify账号:在Shopify官网注册,用于后续开发测试...

取消回复欢迎 发表评论: