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

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

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。

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

(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]

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

(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发请求

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

(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()
}

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

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()
}

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

(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()
}

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

也可以直接获取原生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框架请求参数的获取的文章就介绍到这了,更多相关Golang Gin框架请求参数内容请搜索恩蓝小号以前的文章或继续浏览下面的相关文章希望大家以后多多支持恩蓝小号!

原创文章,作者:IOODW,如若转载,请注明出处:http://www.wangzhanshi.com/n/5456.html

(0)
IOODW的头像IOODW
上一篇 2024年12月17日 19:27:34
下一篇 2024年12月17日 19:27:36

相关推荐

  • Go语言使用Zap轻松搞定结构化日志

    在开发现代应用程序时,日志记录是一个不可或缺的部分。它不仅能帮助我们跟踪程序的运行状态,还能在出现问题时提供宝贵的调试信息。 在 Go 语言中,有许多日志库可供选择,但在性能和灵活…

    Golang 2024年12月17日
  • Golang并发控制之errgroup使用详解

    errgroup 是 Go 官方库 x 中提供的一个非常实用的工具,用于并发执行多个 goroutine,并且方便的处理错误。 我们知道,Go 标准库中有个 s…

    Golang 2024年12月17日
  • Golang将Map的键值对调的实现示例

    一、Map是什么? map是一堆键值对的未排序集合,类似Python中字典的概念,它的格式为map[keyType]valueType,是一个key-value的hash结构。ma…

    2024年12月29日
  • GO中的时间操作总结(time&dateparse)

    〇、前言 日常开发过程中,对于时间的操作可谓是无处不在,但是想实现时间自由还是不简单的,多种时间格式容易混淆,那么本文将进行梳理,一起学习下。 官方提供的库是 time,功能很全面…

    2024年12月26日
  • go语言time.After()的作用

    time.After是一个非常实用的函数,它返回一个用于读取的单向通道(<-chan time.Time),这个通道会在指定的时间间隔之后发送当前时间。这个机制常被用于实现超…

    Golang 2024年12月17日
  • 关于Golang的Map的线程安全问题的解决方案

    前言 在 Golang 编程中,map 是一种常用的数据结构,用于存储键值对。然而,Golang 的 map 在并发访问时是线程不安全的。如果多个 goroutine 同时读写同一…

    Golang 2024年12月17日
  • go集成gorm数据库的操作代码

    一、什么是gorm GORM 是一个用于 Go 语言的 ORM(对象关系映射)库,它提供了一种简单而强大的方式来与数据库进行交互。GORM 支持多种数据库,包括 MySQL、Pos…

    Golang 2024年12月17日
  • 使用Go语言实现找出两个大文件中相同的记录

    在 Go 语言中找出两个大文件中相同的记录,可以采用以下策略: 思路 读文件:按行逐行读取两个文件中的记录,假设每个文件的每一行代表一条记录。 使用哈希集合(Set):因为哈希集合…

    Golang 2024年12月17日
  • 重学Go语言之基础数据类型详解

    前言 Go语言有非常强大的数据类型系统,其支持的数据类型大体上可分为四类:基础数据类型、引用数据类型、接口类型、复合类型。 基础数据类型有: 布尔型(bool) 整型(int) 浮…

    Golang 2024年12月29日
  • golang中gin框架接入jwt使用token验证身份

    jwt jwt的原理和session有点相像,其目的是为了解决rest api中无状态性 因为rest接口,需要权限校验。但是又不能每个请求都把用户名密码传入,因此产生了这个tok…

    Golang 2024年12月26日

发表回复

登录后才能评论