gin框架学习笔记(三) ——路由请求与相关参数-阿里云开发者社区

参数种类与参数处理

查询参数

在讲解查询参数的定义之前，我们先来看一个例子，当我打开了CSDN，我现在想查看我的博客浏览量，那么我就需要点击我的头像来打开我的个人主页,像下面这样:

我们现在把浏览器的网址取下来，它是下面这样的:

https://blog.csdn.net/qq_73924465?spm=1011.2415.3001.5343

我们尝试来分析一下这个网址：

https:表明这个是使用https网络协议来通讯
blog.csdn.net：这个指明了它的服务器地址
qq_73924465：这个是路径，也是我的id
那么?spm=1011.2415.3001.5343这一部分内容是什么含义呢？我们要想一下，我点击了我的头像，服务器是怎么知道我是谁进而寻找到我的主页，这就是查询参数的作用了。

查询参数（Query Parameters）通常指的是在网址（URL）中以问号（?）后跟着的一系列键值对，用于向服务器传递特定的信息或请求。这些参数以键值对的形式出现，每个键值对之间用"&"符号分隔。在Web开发中，查询参数常用于向服务器发送请求，例如在搜索引擎中输入关键词时，这些关键词通常会以查询参数的形式附加在URL中，以便服务器根据这些参数返回相应的搜索结果。

而在Gin我们也有专门的方法去获取查询参数,我们来看下面这个例子:

package main
import (
  "fmt"
  "github.com/gin-gonic/gin"
)
func getQuery(c *gin.Context) {
  fmt.Println(c.Query("name"))                   //获取指定参数的值
  fmt.Println(c.QueryArray("name"))              //获取指定参数
  fmt.Println(c.DefaultQuery("name", "default")) //获取指定参数，如果参数不存在，则返回默认值
}
func main() {
  r := gin.Default()
  r.GET("/query", getQuery)
  r.Run(":8080")
}

这里我们以http://127.0.0.1:8080/query?name=id&name=user为例，输出结果：

动态参数

在我们请求中不止有查询参数，还有一些其他的参数，其中就有动态参数，我们来看一下动态参数的定义:

动态参数是指在程序运行时可以接受并处理不同的参数，以影响其行为或输出结果的机制。在 URL 中，动态参数通常作为 URL 的一部分，直接跟在路径后面，以占位符的形式嵌入其中，例如 example.com/users/:userId 中的 :userId 就是动态参数。

它的作用在于使应用程序更加灵活和可配置。通过在 URL 中传递参数，可以动态地改变应用程序的行为或输出结果，而无需修改代码或重新部署应用程序。

下面我们将演示如何利用Gin框架来获取动态参数:

package main
import (
  "fmt"
  "github.com/gin-gonic/gin"
)
func _param(c *gin.Context) {
  fmt.Println(c.Param("user_name"))
}
func main() {
  r := gin.Default()
  r.GET("/param/:user_name/", _param)
  r.Run(":8080")
}

这里我们尝试发送请求：

备注:这里使用的是Postman来模拟的请求

表单参数

在我们上网的过程中,我们有时候需要完善个人资料需要填写下面这样的资料表：

当我们填写信息提交给服务端的时候，服务端就会从我们提交的表单中获取相关信息，接下来我们将演示如何利用Gin框架来获取表单参数:

package main
import (
  "fmt"
  "github.com/gin-gonic/gin"
)
func _PostForms(c *gin.Context) {
  fmt.Println(c.PostForm("name"))
  fmt.Println(c.PostForm("age"))
  fmt.Println(c.DefaultPostForm("sex", "男"))
}
func main() {
  r := gin.Default()
  r.POST("postforms", _PostForms)
  r.Run(":8080")
}

运行结果如下:

路由请求

Restful风格

RESTful风格是一种基于HTTP协议设计Web API的软件架构风格，由Roy Fielding在2000年提出。它强调使用HTTP动词来表示对资源的操作（GET、POST、PUT、PATCH、DELETE等），并通过URI表示资源的唯一标识符。

RESTful API的设计原则RESTful API的设计遵循以下几个原则：

基于资源：将数据和功能抽象成资源，并通过URI来唯一标识资源。例如，一个用户资源可以通过URL“/users/{id}”来访问，其中“{id}”表示该用户的唯一标识符。
使用HTTP动词：使用HTTP动词来表示对资源的操作，如GET（获取资源）、POST（创建资源）、PUT（更新资源）和DELETE（删除资源）等。
无状态：每个请求都包含足够的信息来完成请求，服务器不需要保存任何上下文信息。
统一接口：使用统一的接口来简化客户端与服务器之间的交互，包括资源标识符、资源操作和响应消息的格式。
可缓存性：客户端可以缓存响应，以提高性能和减少网络流量。
分层系统：将系统分为多个层次，每个层次处理特定的功能。

RESTful风格的API设计具有良好的可读性、易用性和可扩展性，广泛应用于Web应用程序和移动应用程序的API设计中。

四大请求方式

在上面有挂你参数的讲解时我们就介绍了相关请求方式GET与PUT，而其实除了它们以外，还有很多其他的对数据的操作方式，而今天我们主要介绍的就是四个比较常见的操作方式:

Get：从服务器取出资源（一项或多项）
Post:在服务器上新建一个资源
Put：在服务器上更新资源
Delete：从服务上删除资源

接下来我们将以一个事例的方式来演示我们如何俩处理不同的需求:

package main
import (
  "encoding/json"
  "fmt"
  "github.com/gin-gonic/gin"
)
type ArticleModel struct {
  Title   string `json:"title"`
  Content string `json:"content"`
}
type Response struct {
  Code    int    `json:"code"`
  Data    any    `json:"data"`
  Message string `json:"message"`
}
func _bindJson(c *gin.Context, obj any) (err error) { //从请求中获取 JSON 数据并将其绑定到指定的对象
  body, _ := c.GetRawData()
  contnttype := c.GetHeader("Content-Type")
  switch contnttype {
  case "application/json":
    err := json.Unmarshal(body, &obj)
    if err != nil {
      fmt.Println("err:", err)
      return err
    }
  }
  return nil
}
// 文章列表页面
func _getList(c *gin.Context) {
  aricleList := []ArticleModel{
    {"Go语言入门", "这本书是《Go语言入门》"},
    {"100天从0精通python", "这本书是《100天从0精通python》"},
    {"C++ Primer", "这本书是《C++ Primer》"},
  }
  c.JSON(200, Response{0, aricleList, "成功"})
}
// 获取文章详情
func _getDetail(c *gin.Context) {
  fmt.Println(c.Param("id"))
  article := ArticleModel{
    "Go语言入门",
    "这本书是《Go语言入门》",
  }
  c.JSON(200, Response{0, article, "成功"})
}
// 创建一篇文章
func _create(c *gin.Context) {
  var article ArticleModel
  err := _bindJson(c, &article)
  if err != nil {
    fmt.Println(err)
    return
  }
  c.JSON(200, Response{0, article, "成功"})
}
// 更新文章内容
func _update(c *gin.Context) {
  var article ArticleModel
  err := _bindJson(c, &article)
  if err != nil {
    fmt.Println(err)
    return
  }
  c.JSON(200, Response{0, article, "成功"})
}
func _delete(c *gin.Context) {
  fmt.Println(c.Param("id"))
  c.JSON(200, Response{0, map[string]string{}, "成功"})
}
func main() {
  r := gin.Default()
  r.GET("/articles", _getList)
  r.GET("/articles/:id", _getDetail)
  r.POST("/articles", _create)
  r.PUT("/articles/:id", _update)
  r.DELETE("/articles/:id", _delete)
  r.Run(":8080")
}

运行这个程序，我们利用Postman来尝试模拟一下这些请求：

这里就不一一展示了，大家有兴趣的话可以自己来试试。

请求头与响应头

什么是请求头与响应头

请求头和响应头都是HTTP消息头的一部分，它们是在HTTP通信过程中用于传递元数据的重要组成部分。

请求头（Request Headers）：

请求头包含了客户端（例如浏览器、移动应用等）向服务器发送的请求的元数据信息。
请求头通常包括了诸如客户端的User-Agent、Accept、Content-Type等信息，用于告知服务器请求的相关信息。例如，浏览器发送HTTP请求时，请求头中可能包含了用户代理信息、所能接受的数据类型、请求的方法（GET、POST等）等。

响应头（Response Headers）：

响应头包含了服务器响应客户端请求时发送的元数据信息。
响应头通常包括了诸如服务器类型、响应的数据类型、响应的状态码等信息，用于告知客户端关于响应的详细信息。例如，当服务器响应浏览器的HTTP请求时，响应头中可能包含了服务器类型、响应的数据类型、响应的状态码等。

获取请求头与响应头

在Gin框架中，定义了它自己的方法区获取请求头与响应头,接下来我们演示一下我们如何基于Gin框架来获取请求头与响应头：

import (
  "fmt"
  "github.com/gin-gonic/gin"
)
// 获取响应头
func Request(c *gin.Context) {
  fmt.Println(c.Request.Header.Get("user-agent")) //这里不需要考虑大小写的问题，Get函数会做相关处理
  c.JSON(200, gin.H{"msg": "ok"})
}
// 设置响应头
func Response(c *gin.Context) {
  c.Header("token", "test")
  c.JSON(200, gin.H{"msg": "ok"})
}
func main() {
  r := gin.Default()
  r.GET("/request", Request)
  r.GET("/response", Response)
  r.Run(":8080")
}

运行结果如下:

结语

好了，本次的内容就到此为止了，下一篇我们将介绍的就是参数绑定与中间件的使用了，博主平时其实主要还是写cpp，学go其实主要也是想通过这个学习Web开发与云服务,所以对一些常见的知识点比如参数的定义，请求的方式，不对之处还请大家斧正，大家下篇见！

gin框架学习笔记(三) ——路由请求与相关参数