Golang 关于Gin框架请求参数的获取方法

 更新时间:2024年10月21日 11:05:25   作者:景天科技苑  
Gin是Go语言的Web框架,提供路由和中间件支持,本文介绍如何使用Gin获取HTTP请求参数,包括URLPath参数、URLQuery参数、HTTPBody参数和Header参数,详解直接获取和绑定到结构体两种方法,帮助开发者高效处理Web请求

Gin框架请求参数的获取

Gin是一个用Go语言编写的Web框架,它提供了强大的路由和中间件功能,使得开发Web应用变得更加简单和高效。
在使用Gin框架开发Web应用时,处理请求参数是一个非常重要的环节。本文将结合实际案例,详细介绍在Go语言中如何使用Gin框架处理请求参数。

一、请求参数的类型和位置

在HTTP请求中,参数可以通过多种方式传递,常见的类型包括:

URL Path参数:参数直接写在请求路径中,例如/user/:id。
URL Query参数:参数跟在URL的?后面,以键值对的形式传递,多个参数之间用&分隔,例如/user/list?name=John&gender=男。
HTTP Body参数:参数在请求体中传递,通常用于POST、PUT等请求方法,内容格式可以是JSON、XML等。
Header参数:参数在HTTP请求头中传递,例如Content-Type、Accept等。

二、获取请求参数的方法

Gin框架提供了多种方法来获取请求参数,包括直接获取和绑定到结构体中两种方式。

1. 直接获取请求参数

(1)获取URL Path参数

URL Path参数是指直接写在请求路径中的参数,可以通过Gin框架的Param方法获取。
后台获取路径请求参数通过ctx.Param(“参数名”) 来获取

示例代码:

package main
import (
    "github.com/gin-gonic/gin"
    "net/http"
)
func main() {
    engine := gin.Default()
    //请求参数 用:变量名 表示
    engine.GET("/user/:id", func(ctx *gin.Context) {
        //后台获取请求参数通过ctx.Param("参数名") 来获取
        id := ctx.Param("id")
        //响应到页面
        //fmt.Fprintf(ctx.Writer, "你的请求id: %s", id)
        ctx.String(http.StatusOK, "您的id是%s", id)
    })
    engine.Run()
}

运行后,发起请求http://localhost:8080/user/100,会返回你的请求id: 100。

(2)获取URL Query参数

URL Query参数是指跟在URL的?后面的键值对集合,可以通过Gin框架的Query、DefaultQuery、QueryArray、QueryMap等方法获取。

示例代码:

package main
import (
    "fmt"
    "github.com/gin-gonic/gin"
    "net/http"
)
func main() {
    engine := gin.Default()
    engine.GET("/user/list", func(ctx *gin.Context) {
        name := ctx.Query("name")
        gender := ctx.DefaultQuery("gender", "男")
        habits := ctx.QueryArray("habits")
        fmt.Printf("name: %s, gender: %s, habits: %v\n", name, gender, habits)
        works := ctx.QueryMap("works")
        //响应到页面
        ctx.String(http.StatusOK, "%s, %s, %v, %s\n", name, gender, habits, works)
    })
    engine.Run(":8080")
}

运行后,浏览器发起请求
http://127.0.0.1:8080/user/list?name=John&gender=男&habits=reading&habits=sports&works[teacher]=math&works[engineer]=computer
会返回 John, 男, [reading sports], map[engineer:computer teacher:math]

(3)获取HTTP Body参数

HTTP Body参数是指请求体中的参数,通常用于POST、PUT等请求方法。可以通过Gin框架的PostForm、DefaultPostForm、PostFormArray、PostFormMap等方法获取。

示例代码:

package main
import (
    "fmt"
    "github.com/gin-gonic/gin"
)
func main() {
    engine := gin.Default()
    //使用post请求
    engine.POST("/user/add", func(ctx *gin.Context) {
        name := ctx.PostForm("name")
        gender := ctx.DefaultPostForm("gender", "男")
        //获取切片数据
        habits := ctx.PostFormArray("habits")
        //获取map数据
        works := ctx.PostFormMap("works")
        fmt.Printf("%s, %s, %v, %s\n", name, gender, habits, works)
    })
    engine.Run()
}

postman发请求

(4)获取Header参数

Header参数是指HTTP请求头中的参数,可以通过Gin框架的GetHeader方法获取。

示例代码:

package main
import (
    "github.com/gin-gonic/gin"
    "net/http"
)
func main() {
    engine := gin.Default()
    engine.POST("/getHeader", func(ctx *gin.Context) {
        //拿到请求头参数数据
        userAgent := ctx.GetHeader("User-Agent")
        ctx.String(http.StatusOK, "User-Agent: %s", userAgent)
    })
    engine.Run()
}

2. 绑定请求参数到结构体

Gin框架支持将请求参数自动绑定到结构体中,这样可以更方便地进行参数验证和处理。绑定参数的方法包括Bind、ShouldBind、BindJSON、BindQuery等。

(1)绑定URL Query参数到结构体

示例代码:

package main
import (
    "github.com/gin-gonic/gin"
    "net/http"
)
// User 定义结构体,使用form标签指定参数名,以便正确地绑定参数 get请求使用功能form标签
type User struct {
    Id    int64  `form:"id"`
    Name  string `form:"name"`
    Age   int    `form:"age"`
    Email string `form:"email"`
}
func main() {
    engine := gin.Default()
    engine.GET("/user/info", func(ctx *gin.Context) {
        var user User
        //将结构体对象指针传进去
        if err := ctx.ShouldBindQuery(&user); err != nil {
            ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
            return
        }
        //以json字符串的方式响应给客户端这个结构体对象
        ctx.JSON(http.StatusOK, user)
    })
    engine.Run()
}

(2)绑定HTTP Body参数到结构体(JSON格式)

当前端请求的数据通过JSON提交时,例如向/json发送一个POST请求

示例代码:

package main
import (
    "github.com/gin-gonic/gin"
    "net/http"
)
// User 绑定HTTP Body参数到结构体 ,创建结构体时需要用json标签
type User struct {
    Id    int64  `json:"id"`
    Name  string `json:"name"`
    Age   int    `json:"age"`
    Email string `json:"email"`
}
func main() {
    engine := gin.Default()
    engine.POST("/user/add", func(ctx *gin.Context) {
        var user User
        // ctx.ShouldBindJSON(&user) 将结构体指针传进去
        if err := ctx.ShouldBindJSON(&user); err != nil {
            ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
            return
        }
        //响应给客户端结构体
        ctx.JSON(http.StatusOK, user)
    })
    engine.Run()
}

也可以直接获取原生json数据处理

package main
import (
    "encoding/json"
    "github.com/gin-gonic/gin"
    "net/http"
)
func main() {
    engine := gin.Default()
    engine.POST("/json", func(ctx *gin.Context) {
        // GetRawData : 从c.Request.Body读取请求数据, 返回 []byte
        // func (c *Context) GetRawData() ([]byte, error)
        b, _ := ctx.GetRawData()
        // 定义map或结构体接收
        var m map[string]interface{}
        // 将接收的b json反序列化为map数据
        _ = json.Unmarshal(b, &m)
        ctx.JSON(http.StatusOK, m)
    })
    engine.Run()
}

到此这篇关于Golang 关于Gin框架请求参数的获取的文章就介绍到这了,更多相关Golang Gin框架请求参数内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 一文教你如何用好GO语言变长参数

    一文教你如何用好GO语言变长参数

    对于函数重载相信编码过的 xdm 肯定不会陌生,那么我们一起分别来看看 C 语言,C++ 语言,GO 语言 如何去模拟和使用重载,感兴趣的可以学习一下
    2023-09-09
  • Go语言并发之Sync包的6个关键概念总结

    Go语言并发之Sync包的6个关键概念总结

    这篇文章主要为大家详细介绍了Go语言并发中Sync包的6个关键概念,文中的示例代码讲解详细,对我们深入学习Go语言有一定的帮助,需要的可以参考一下
    2023-05-05
  • golang API开发过程的中的自动重启方式(基于gin框架)

    golang API开发过程的中的自动重启方式(基于gin框架)

    这篇文章主要介绍了golang API开发过程的中的自动重启方式(基于gin框架),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • golang获取客户端ip的实现

    golang获取客户端ip的实现

    本文主要介绍了golang获取客户端ip的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-07-07
  • go语言多线程操作实现

    go语言多线程操作实现

    多线程是一种使程序能够并行处理多个任务的技术,Go语言通过goroutine和channel提供了一种相比传统线程更轻量级、易于管理的并发实现方式,本文就来介绍一下go语言多线程操作实现,感兴趣的可以了解一下
    2024-11-11
  • go语言实现接口查询

    go语言实现接口查询

    这篇文章主要介绍了go语言实现接口查询,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • golang线程安全的map实现

    golang线程安全的map实现

    这篇文章主要介绍了golang线程安全的map实现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • golang中定时器cpu使用率高的现象详析

    golang中定时器cpu使用率高的现象详析

    这篇文章主要给大家介绍了关于golang中定时器cpu使用率高的现象的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2018-04-04
  • GoPath模式和GoMoudle模式的相爱相杀

    GoPath模式和GoMoudle模式的相爱相杀

    这篇文章主要介绍了GoPath模式和GoMoudle模式的相爱相杀,本文通过实例图文相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-03-03
  • go语言实现同步操作项目示例

    go语言实现同步操作项目示例

    本文主要介绍了go语言实现同步操作项目示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-05-05

最新评论