【GoGin】(3)Gin的数据渲染和中间件的使用:数据渲染、返回JSON、浅.JSON()源码、中间件、Next()方法

本文涉及的产品
可观测可视化 Grafana 版,10个用户账号 1个月
服务治理 MSE Sentinel/OpenSergo,Agent数量 不受限
函数计算FC,每月15万CU 3个月
简介: 我们在正常注册中间件时,会打断原有的运行流程,但是你可以在中间件函数内部添加Next()方法,这样可以让原有的运行流程继续执行,当原有的运行流程结束后再回来执行中间件内部的内容。​ c.Writer.WriteHeaderNow()还会写入文本流中。可以看到使用next后,正常执行流程中并没有获得到中间件设置的值。接口还提供了一个可以修改ContentType的方法。判断了传入的状态码是否符合正确的状态码,并返回。在内部封装时,只是标注了不同的render类型。再看一下其他返回的类型;

1. 数据渲染

1.1 各种数据格式的响应

  • json、结构体、XML、YAML类似于java的properties、ProtoBuf

1.1.1 返回JSON

package main

import (
    "github.com/gin-gonic/gin"
    "net/http"
)

func main() {
   
    r := gin.Default()

    r.POST("/demo", func(res *gin.Context) {
   
        res.JSON(http.StatusOK, gin.H{
   
            "message": "success",
        })
    })
    r.Run(":8080")
}

1.1.2 返回结构体

r.GET("/demo", func(res *gin.Context) {
   
    var obj struct {
   
        name string
        age  int8
    }
    obj.age = 1
    obj.name = "张三"
    res.JSON(http.StatusOK, obj)
})

1.1.3 XML 和 YAML

// 3.XML
r.GET("/someXML", func(c *gin.Context) {
   
    c.XML(200, gin.H{
   "message": "abc"})
})
// 4.YAML响应
r.GET("/someYAML", func(c *gin.Context) {
   
    c.YAML(200, gin.H{
   "name": "zhangsan"})
})

1.1.4 浅浅扒一下源码

进入res.JSON函数里面看一下

res.JSON(http.StatusOK, obj)
func (c *Context) JSON(code int, obj any) {
   
    c.Render(code, render.JSON{
   Data: obj})
}
  • (c *Context) 代表可以被Context类型调用
  • (code int, obj any) 传入参数,状态码和返回对象

它本身内部再次封装了一层提供给Render类型

func (c *Context) Render(code int, r render.Render) {
   
    c.Status(code)

    if !bodyAllowedForStatus(code) {
   
       r.WriteContentType(c.Writer)
       c.Writer.WriteHeaderNow()
       return
    }

    if err := r.Render(c.Writer); err != nil {
   
       // Pushing error to c.Errors
       _ = c.Error(err)
       c.Abort()
    }
}

进入Render里面,可以看到

  • (code int, r render.Render) 参数进行了更改,传入了render包下的Render类型

可以看一下Render这个接口

type Render interface {
   
    // Render writes data with custom ContentType.
    Render(http.ResponseWriter) error
    // WriteContentType writes custom ContentType.
    WriteContentType(w http.ResponseWriter)
}

接口还提供了一个可以修改ContentType的方法

if !bodyAllowedForStatus(code) {
   
    r.WriteContentType(c.Writer)
    c.Writer.WriteHeaderNow()
    return
}
  • bodyAllowedForStatus()进行了判断
func bodyAllowedForStatus(status int) bool {
   
    switch {
   
    case status >= 100 && status <= 199:
        return false
    case status == http.StatusNoContent:
        return false
    case status == http.StatusNotModified:
        return false
    }
    return true
}

判断了传入的状态码是否符合正确的状态码,并返回

  • 当bodyAllowedForStatus()判断为错误状态码时

    会在返回对象中写入ContentType内容

​ c.Writer.WriteHeaderNow()还会写入文本流中

再看一下其他返回的类型;例如XML

func (c *Context) XML(code int, obj any) {
   
    c.Render(code, render.XML{
   Data: obj})
}

在内部封装时,只是标注了不同的render类型

1.2 重定向

访问/demo地址时,将页面重定向跳转至其他页面

package main

import (
    "github.com/gin-gonic/gin"
    "net/http"
)

func main() {
   
    r := gin.Default()

    r.GET("/demo", func(c *gin.Context) {
   
       c.Redirect(http.StatusMovedPermanently, "http://www.baidu.com")
    })

    r.Run(":8080")
}

2. 中间件

2.1 全局中间件

  • 所有请求都经过此中间件
package main

import (
    "github.com/gin-gonic/gin"
    "log"
    "time"
)

func MiddleWare() gin.HandlerFunc {
   
    return func(c *gin.Context) {
   
        t := time.Now()
        log.Println("中间件开始运行:", t)

        c.Set("middle_1", "中间件1执行结束")

        status := c.Writer.Status()
        log.Println("中间件执行结束:", status)
        t2 := time.Since(t)
        log.Println("耗时:", t2)
    }
}

func main() {
   
    r := gin.Default()

    // 注册中间件
    r.Use(MiddleWare())

    r.GET("/demo", func(c *gin.Context) {
   
        // 获得内容
        m, _ := c.Get("middle_1")
        log.Println("中间件接收参数:", m)
        c.JSON(200, gin.H{
   "中间件接收参数:": m})
    })

    r.Run(":8080")
}

测试:http://localhost:8080/demo

返回结果:

[GIN-debug] Listening and serving HTTP on :8080
2025/04/29 00:12:34 中间件开始运行: 2025-04-29 00:12:34.5992889 +0800 CST m=+1.770059901
2025/04/29 00:12:34 中间件执行结束: 200
2025/04/29 00:12:34 耗时: 11.5258ms
2025/04/29 00:12:34 中间件接收参数: 中间件1执行结束
[GIN] 2025/04/29 - 00:12:34 | 200 |     11.5258ms |             ::1 | GET      "/demo"

gin 使用r.Use()来注册一个组件

  • 在注册组件时,我们需要规定函数的返回类型,这才能让gin知道这是什么组件
func MiddleWare() gin.HandlerFunc {
   
    return func(c *gin.Context) {
   
        t := time.Now()
        log.Println("中间件开始运行:", t)

        c.Set("middle_1", "中间件1执行结束")

        status := c.Writer.Status()
        log.Println("中间件执行结束:", status)
        t2 := time.Since(t)
        log.Println("耗时:", t2)
    }
}
  • 这里MiddleWare()函数规定了返回类型是 gin.HandlerFunc ,这就代表这个函数是一个处理类

2.1.1 Next() 方法

我们在正常注册中间件时,会打断原有的运行流程,但是你可以在中间件函数内部添加Next()方法,这样可以让原有的运行流程继续执行,当原有的运行流程结束后再回来执行中间件内部的内容

package main

import (
    "github.com/gin-gonic/gin"
    "log"
    "time"
)

func MiddleWare() gin.HandlerFunc {
   
    return func(c *gin.Context) {
   
        t := time.Now()
        log.Println("中间件开始运行:", t)

        // 开启正常执行流程
        c.Next()

        c.Set("middle_1", "中间件1执行结束")

        status := c.Writer.Status()
        log.Println("中间件执行结束:", status)
        t2 := time.Since(t)
        log.Println("耗时:", t2)
    }
}

func main() {
   
    r := gin.Default()

    // 注册中间件
    r.Use(MiddleWare())

    r.GET("/demo", func(c *gin.Context) {
   
        // 获得内容
        m, _ := c.Get("middle_1")
        log.Println("中间件接收参数:", m)
        c.JSON(200, gin.H{
   "中间件接收参数:": m})
    })

    r.Run(":8080")
}

测试:http://localhost:8080/demo

返回结果:

[GIN-debug] Listening and serving HTTP on :8080
2025/04/29 00:14:14 中间件开始运行: 2025-04-29 00:14:14.5697461 +0800 CST m=+2.981609901
2025/04/29 00:14:14 中间件接收参数: <nil>
2025/04/29 00:14:14 中间件执行结束: 200
2025/04/29 00:14:14 耗时: 14.0262ms
[GIN] 2025/04/29 - 00:14:14 | 200 |     14.0262ms |             ::1 | GET      "/demo"

可以看到使用next后,正常执行流程中并没有获得到中间件设置的值

2.2 局部中间件

package main

import (
    "github.com/gin-gonic/gin"
    "log"
    "time"
)

func MiddleWare() gin.HandlerFunc {
   
    return func(c *gin.Context) {
   
       t := time.Now()
       log.Println("中间件开始运行:", t)

       c.Set("middle_1", "中间件1执行结束")

       status := c.Writer.Status()
       log.Println("中间件执行结束:", status)
       t2 := time.Since(t)
       log.Println("耗时:", t2)
    }
}

func main() {
   
    r := gin.Default()

    // 局部中间件-在为一个请求添加执行函数时即可挂载中间件
    r.GET("/demo", MiddleWare(), func(c *gin.Context) {
   
       // 获得内容
       m, _ := c.Get("middle_1")
       log.Println("中间件接收参数:", m)
       c.JSON(200, gin.H{
   "中间件接收参数:": m})
    })

    r.Run(":8080")
}
  • 为你想给哪一个请求挂载中间件,直接在对应的请求中添加中间件函数即可

3. ❤️GoGin框架——前文链接

Gin框架学习参考网站:gin框架·Go语言中文文档

目录
相关文章
|
28天前
|
JSON API 数据格式
淘宝拍立淘按图搜索API系列,json数据返回
淘宝拍立淘按图搜索API系列通过图像识别技术实现商品搜索功能,调用后返回的JSON数据包含商品标题、图片链接、价格、销量、相似度评分等核心字段,支持分页和详细商品信息展示。以下是该API接口返回的JSON数据示例及详细解析:
|
1月前
|
JSON 算法 API
Python采集淘宝商品评论API接口及JSON数据返回全程指南
Python采集淘宝商品评论API接口及JSON数据返回全程指南
|
1月前
|
JSON API 数据安全/隐私保护
Python采集淘宝拍立淘按图搜索API接口及JSON数据返回全流程指南
通过以上流程,可实现淘宝拍立淘按图搜索的完整调用链路,并获取结构化的JSON商品数据,支撑电商比价、智能推荐等业务场景。
|
1月前
|
JSON Java Go
【GoGin】(2)数据解析和绑定:结构体分析,包括JSON解析、form解析、URL解析,区分绑定的Bind方法
bind或bindXXX函数(后文中我们统一都叫bind函数)的作用就是将,以方便后续业务逻辑的处理。
249 3
|
3月前
|
JSON API 数据安全/隐私保护
深度分析淘宝卖家订单详情API接口,用json返回数据
淘宝卖家订单详情API(taobao.trade.fullinfo.get)是淘宝开放平台提供的重要接口,用于获取单个订单的完整信息,包括订单状态、买家信息、商品明细、支付与物流信息等,支撑订单管理、ERP对接及售后处理。需通过appkey、appsecret和session认证,并遵守调用频率与数据权限限制。本文详解其使用方法并附Python调用示例。
|
2月前
|
机器学习/深度学习 JSON 监控
淘宝拍立淘按图搜索与商品详情API的JSON数据返回详解
通过调用taobao.item.get接口,获取商品标题、价格、销量、SKU、图片、属性、促销信息等全量数据。
|
2月前
|
JSON 缓存 自然语言处理
多语言实时数据微店商品详情API:技术实现与JSON数据解析指南
通过以上技术实现与解析指南,开发者可高效构建支持多语言的实时商品详情系统,满足全球化电商场景需求。
|
2月前
|
JSON API 数据格式
干货满满!淘宝商品详情数据,淘宝API(json数据返回)
淘宝商品详情 API 接口(如 taobao.item.get)的 JSON 数据返回示例如下
|
3月前
|
JSON 算法 安全
淘宝商品详情API接口系列,json数据返回
淘宝开放平台提供了多种API接口用于获取商品详情信息,主要通过 淘宝开放平台(Taobao Open Platform, TOP) 的 taobao.tbk.item.info.get(淘宝客商品详情)或 taobao.item.get(标准商品API)等接口实现。以下是关键信息及JSON返回示例:
|
2月前
|
JSON API 数据安全/隐私保护
Python采集淘宝评论API接口及JSON数据返回全流程指南
Python采集淘宝评论API接口及JSON数据返回全流程指南