0
0

golang，gin框架的请求参数（一）--推荐

golang，gin框架的请求参数（一）

gin框架的重要性不过多的强调，重点就gin使用中的参数传递，获取进行梳理文件，满足使用需求。

获取前端请求参数的几种方法：

一、获取参数【浏览器地址获取参数】

1.浏览器地址栏获取参数

1.获取 URL (query)参数

例如：/user/search?username=zhangsan&address=北京。 获取请求的query参数的方法如下：
URL 参数可以通过DefaultQuery() 和 Query() 两个参数获取

这两个【DefaultQuery() 和 Query() 】的区别就是，DefaultQuery()可以放个默认参数，如果没有存参数那么就是使用默认参数，

Query()如果不给参数，就是默认为“”

示例：

1.1后端代码：
  1. package main
  3. import (
  4.     "github.com/gin-gonic/gin"
  5.     "net/http"
  6. )
  8. // /user/search?username=zhangsan&address=北京
  9. // urlQuery 获取 url中?后面携带的参数
  10. func urlQueryHandle(ctx *gin.Context) {
  11.     // 如果指定的key 没有对应的值就使用默认值
  12.     username1 := ctx.DefaultQuery("username", "lisi")
  14.     // 根据key 获取值
  15.     username2 := ctx.Query("username")
  17.     address := ctx.Query("address")
  19.     // 返回JSON 字符串
  20.     ctx.JSON(http.StatusOK, gin.H{
  21.         "message":   "ok",
  22.         "username1": username1,
  23.         "username2": username2,
  24.         "address":   address,
  25.     })
  26. }
  27. func main() {
  29.     // 创建默认路由
  30.     r := gin.Default()
  32.     // 绑定路由规则
  33.     r.GET("/user/search", urlQueryHandle)
  35.     // 监听端口
  36.     r.Run(":9000")
  37. }

1.2浏览器访问，从中可以看到我们没有给任何参数，后端Query查询的都是为“”

1.3带参数的访问

  1. http://127.0.0.1:9000/user/search?username=tom&address=xian&username=jerry

?username=tom&address=xian&username=jerry

1.3.1postman获取参数

2.获取参数【获取Path参数(RestFul风格)】

请求的参数通过URL路径传递，例如：/user/search/lisi/北京。 获取请求URL路径中的参数的方式如下。

以下代码是上述两种浏览器获取参数的办法，具体看代码品味下；

  1. package main
  3. import (
  4.     "github.com/gin-gonic/gin"
  5.     "net/http"
  6. )
  8. // /user/search?username=zhangsan&address=北京
  9. // urlQuery 获取 url中?后面携带的参数
  10. func urlQueryHandle(ctx *gin.Context) {
  11.     // 如果指定的key 没有对应的值就使用默认值
  12.     username1 := ctx.DefaultQuery("username", "lisi")
  14.     // 根据key 获取值
  15.     username2 := ctx.Query("username")
  17.     address := ctx.Query("address")
  19.     // 返回JSON 字符串
  20.     ctx.JSON(http.StatusOK, gin.H{
  21.         "message":   "ok",
  22.         "username1": username1,
  23.         "username2": username2,
  24.         "address":   address,
  25.     })
  26. }
  28. // /user/search/lisi/北京。 获取请求URL路径中的参数的方式如下
  29. // paramsPathHandle 获取url path中参数
  30. func paramsPathHandle(ctx *gin.Context) {
  32.     // 获取参数值
  33.     username := ctx.Param("username")
  34.     address := ctx.Param("address")
  36.     // 数据返回
  37.     ctx.JSON(http.StatusOK, gin.H{
  38.         "message":  "ok",
  39.         "username": username,
  40.         "address":  address,
  41.     })
  42. }
  44. func main() {
  46.     // 创建默认路由
  47.     r := gin.Default()
  48.     //两种浏览器地址获取参数的办法
  49.     // 绑定路由规则 /user/search?username=zhangsan&address=北京
  50.     r.GET("/user/search", urlQueryHandle)
  51.     // 2. 绑定路由规则/user/search/lisi/北京。 获取请求URL路径中的参数的方式如下
  52.     r.GET("/user/search/:username/:address", paramsPathHandle)
  54.     // 监听端口
  55.     r.Run(":9000")
  56. }

二、表单获取参数获取 Form参数

表单提交POST请求时，http常见的传输格式有四种application/json (json格式)

  • text/plain (text格式)
  • application/x-www-form-urlencode（表单默认提交格式）
  • application./xml (xml格式)
  • multipart/form-data( 文件上传)

可以通过 DefaultPostForm() 和 PostForm() 两个方法获取（默认解析的是 x-www-form-urlencode 和 form-data 格式的参数）

2.1获取form表单数据

2.1.1application/x-www-form-urlencode（表单默认提交格式）

因为发起post请求，前端只能用postman模拟了

返回结果

2.1.2form-data表单提交方式

2.2获取json参数【**ctx.GetRowData()**】

2.2.1请求数据application./json(json格式)

2.2.2 application./xml (xml格式)

2.3文件上传事项

2.3.1文件上传接收的文件格式要求：

格式是: multipart/form-data

2.3.2多文件上传

2.4表单数据获取的代码

  1. package main
  3. import (
  4.     "encoding/json"
  5.     "fmt"
  6.     "github.com/gin-gonic/gin"
  7.     "net/http"
  8. )
  10. // /user/search?username=zhangsan&address=北京
  11. // urlQuery 获取 url中?后面携带的参数
  12. func urlQueryHandle(ctx *gin.Context) {
  13.     // 如果指定的key 没有对应的值就使用默认值
  14.     username1 := ctx.DefaultQuery("username", "lisi")
  16.     // 根据key 获取值
  17.     username2 := ctx.Query("username")
  19.     address := ctx.Query("address")
  21.     // 返回JSON 字符串
  22.     ctx.JSON(http.StatusOK, gin.H{
  23.         "message":   "ok",
  24.         "username1": username1,
  25.         "username2": username2,
  26.         "address":   address,
  27.     })
  28. }
  30. // /user/search/lisi/北京。 获取请求URL路径中的参数的方式如下
  31. // paramsPathHandle 获取url path中参数
  32. func paramsPathHandle(ctx *gin.Context) {
  34.     // 获取参数值
  35.     username := ctx.Param("username")
  36.     address := ctx.Param("address")
  38.     // 数据返回
  39.     ctx.JSON(http.StatusOK, gin.H{
  40.         "message":  "ok",
  41.         "username": username,
  42.         "address":  address,
  43.     })
  44. }
  46. //=================================
  48. // formParamsHandle 获取form表单提交数据
  49. func formParamsHandle(ctx *gin.Context) {
  51.     // 获取不到值时就是用默认值
  52.     username1 := ctx.DefaultPostForm("username", "lisi")
  54.     username2 := ctx.PostForm("username")
  55.     address := ctx.PostForm("address")
  57.     // 以Json 字符串的形式返回
  58.     ctx.JSON(http.StatusOK, gin.H{
  59.         "message":   "ok",
  60.         "username1": username1,
  61.         "username2": username2,
  62.         "address":   address,
  63.     })
  64. }
  66. // json参数
  67. // paramsJsonHandle 获取json字符串相关的参数
  68. func paramsJsonHandle(ctx *gin.Context) {
  70.     // 获取request.Body() 中的数据(这里没有进行错误处理)
  71.     // 返回的是字节数组
  72.     dataBytes, _ := ctx.GetRawData()
  74.     // 定义一个map
  75.     var m map[string]interface{}
  77.     // 反序列化 别忘了&
  78.     _ = json.Unmarshal(dataBytes, &m)
  80.     // 数据返回
  81.     ctx.JSON(http.StatusOK, m)
  83. }
  85. //文件上传
  86. /*
  87.   单个文件上传
  88.     文件上传接收的文件格式是: multipart/form-data
  89. */
  91. // singleFileUploadHandle 当文件上传
  92. func singleFileUploadHandle(ctx *gin.Context) {
  94.     // 获取文件
  95.     // 根据上传时的参数名获取上传的文件内容 --> 返回对象为 *multipart.FileHeader
  96.     fileHeader, err := ctx.FormFile("file")
  97.     if err != nil {
  98.         ctx.JSON(http.StatusInternalServerError, gin.H{
  99.             "message": err.Error(),
  100.         })
  101.         return
  102.     }
  104.     // 保存文件内容
  105.     // 拼接文件名, 这里直接写死了
  106.     targetFileName := fmt.Sprintf("C:/Users/黑熊精/Pictures/%s", fileHeader.Filename)
  107.     //targetFileName := fmt.Sprintf("%s", fileHeader.Filename)
  109.     // 将文件保存到指定的目录
  110.     err = ctx.SaveUploadedFile(fileHeader, targetFileName)
  111.     if err != nil {
  112.         ctx.JSON(http.StatusInternalServerError, gin.H{
  113.             "message": err.Error(),
  114.         })
  115.     } else {
  116.         ctx.JSON(http.StatusOK, gin.H{
  117.             "message": fmt.Sprintf("%s upload success!", fileHeader.Filename),
  118.         })
  119.     }
  120. }
  122. //多文件上传
  124. /**
  125.   多文件上传
  126. */
  128. // multiFileUploadHandle 多文件上传
  129. func multiFileUploadHandle(ctx *gin.Context) {
  131.     // form 是一个存储文件信息的结构体
  132.     /**
  133.       type Form struct {
  134.         Value map[string][]string
  135.         File  map[string][]*FileHeader
  136.     */
  137.     form, err := ctx.MultipartForm()
  138.     if err != nil {
  139.         ctx.JSON(http.StatusInternalServerError, gin.H{
  140.             "message": err.Error(),
  141.         })
  142.         return
  143.     }
  145.     // 获取文件列表，并保存， 返回的是一个切片 []*FileHeader
  146.     files := form.File["file"]
  147.     for i, file := range files {
  148.         targetFileName := fmt.Sprintf("C:/Users/黑熊精/Pictures/%d_%s", i, file.Filename)
  149.         err = ctx.SaveUploadedFile(file, targetFileName)
  151.         if err != nil {
  152.             ctx.JSON(http.StatusInternalServerError, gin.H{
  153.                 "message": err.Error(),
  154.             })
  155.             return
  156.         }
  157.     }
  158.     ctx.JSON(http.StatusOK, gin.H{
  159.         "message": fmt.Sprintf("upload success!"),
  160.     })
  161. }
  163. func main() {
  165.     // 创建默认路由
  166.     r := gin.Default()
  167.     //两种浏览器地址获取参数的办法
  168.     // 绑定路由规则 /user/search?username=zhangsan&address=北京
  169.     r.GET("/user/search", urlQueryHandle)
  170.     // 2. 绑定路由规则/user/search/lisi/北京。 获取请求URL路径中的参数的方式如下
  171.     r.GET("/user/search/:username/:address", paramsPathHandle)
  173.     //========================表单提交方法======================
  174.     // 绑定路由规则
  175.     r.POST("/user/search", formParamsHandle)
  177.     //json
  178.     // 绑定路由规则
  179.     r.POST("/user/json", paramsJsonHandle)
  181.     //
  183.     // 绑定路由规则--文件上传
  184.     r.POST("/upload/single", singleFileUploadHandle)
  186.      绑定路由规则--多文件上传
  187.     r.POST("/upload/multi", multiFileUploadHandle)
  188.     // 监听端口
  189.     r.Run(":9000")
  190. }

2.5参数绑定--优化数据方式

使用 ShouldBind() 方法, 根据请求方式，自动提取 JSON, form表单 和 Query 类型的参数，放入结构体中

2.5.1url query参数解析

2.5.2form表单参数解析

2.5.3json 数据解析

三、程序的所有代码

  1. package main
  3. import (
  4.     "encoding/json"
  5.     "fmt"
  6.     "github.com/gin-gonic/gin"
  7.     "net/http"
  8. )
  10. // /user/search?username=zhangsan&address=北京
  11. // urlQuery 获取 url中?后面携带的参数
  12. func urlQueryHandle(ctx *gin.Context) {
  13.     // 如果指定的key 没有对应的值就使用默认值
  14.     username1 := ctx.DefaultQuery("username", "lisi")
  16.     // 根据key 获取值
  17.     username2 := ctx.Query("username")
  19.     address := ctx.Query("address")
  21.     // 返回JSON 字符串
  22.     ctx.JSON(http.StatusOK, gin.H{
  23.         "message":   "ok",
  24.         "username1": username1,
  25.         "username2": username2,
  26.         "address":   address,
  27.     })
  28. }
  30. // /user/search/lisi/北京。 获取请求URL路径中的参数的方式如下
  31. // paramsPathHandle 获取url path中参数
  32. func paramsPathHandle(ctx *gin.Context) {
  34.     // 获取参数值
  35.     username := ctx.Param("username")
  36.     address := ctx.Param("address")
  38.     // 数据返回
  39.     ctx.JSON(http.StatusOK, gin.H{
  40.         "message":  "ok",
  41.         "username": username,
  42.         "address":  address,
  43.     })
  44. }
  46. //=================================
  48. // formParamsHandle 获取form表单提交数据
  49. func formParamsHandle(ctx *gin.Context) {
  51.     // 获取不到值时就是用默认值
  52.     username1 := ctx.DefaultPostForm("username", "lisi")
  54.     username2 := ctx.PostForm("username")
  55.     address := ctx.PostForm("address")
  57.     // 以Json 字符串的形式返回
  58.     ctx.JSON(http.StatusOK, gin.H{
  59.         "message":   "ok",
  60.         "username1": username1,
  61.         "username2": username2,
  62.         "address":   address,
  63.     })
  64. }
  66. // json参数
  67. // paramsJsonHandle 获取json字符串相关的参数
  68. func paramsJsonHandle(ctx *gin.Context) {
  70.     // 获取request.Body() 中的数据(这里没有进行错误处理)
  71.     // 返回的是字节数组
  72.     dataBytes, _ := ctx.GetRawData()
  74.     // 定义一个map
  75.     var m map[string]interface{}
  77.     // 反序列化 别忘了&
  78.     _ = json.Unmarshal(dataBytes, &m)
  80.     // 数据返回
  81.     ctx.JSON(http.StatusOK, m)
  83. }
  85. //文件上传
  86. /*
  87.   单个文件上传
  88.     文件上传接收的文件格式是: multipart/form-data
  89. */
  91. // singleFileUploadHandle 当文件上传
  92. func singleFileUploadHandle(ctx *gin.Context) {
  94.     // 获取文件
  95.     // 根据上传时的参数名获取上传的文件内容 --> 返回对象为 *multipart.FileHeader
  96.     fileHeader, err := ctx.FormFile("file")
  97.     if err != nil {
  98.         ctx.JSON(http.StatusInternalServerError, gin.H{
  99.             "message": err.Error(),
  100.         })
  101.         return
  102.     }
  104.     // 保存文件内容
  105.     // 拼接文件名, 这里直接写死了
  106.     targetFileName := fmt.Sprintf("C:/Users/黑熊精/Pictures/%s", fileHeader.Filename)
  107.     //targetFileName := fmt.Sprintf("%s", fileHeader.Filename)
  109.     // 将文件保存到指定的目录
  110.     err = ctx.SaveUploadedFile(fileHeader, targetFileName)
  111.     if err != nil {
  112.         ctx.JSON(http.StatusInternalServerError, gin.H{
  113.             "message": err.Error(),
  114.         })
  115.     } else {
  116.         ctx.JSON(http.StatusOK, gin.H{
  117.             "message": fmt.Sprintf("%s upload success!", fileHeader.Filename),
  118.         })
  119.     }
  120. }
  122. //多文件上传
  124. /**
  125.   多文件上传
  126. */
  128. // multiFileUploadHandle 多文件上传
  129. func multiFileUploadHandle(ctx *gin.Context) {
  131.     // form 是一个存储文件信息的结构体
  132.     /**
  133.       type Form struct {
  134.         Value map[string][]string
  135.         File  map[string][]*FileHeader
  136.     */
  137.     form, err := ctx.MultipartForm()
  138.     if err != nil {
  139.         ctx.JSON(http.StatusInternalServerError, gin.H{
  140.             "message": err.Error(),
  141.         })
  142.         return
  143.     }
  145.     // 获取文件列表，并保存， 返回的是一个切片 []*FileHeader
  146.     files := form.File["file"]
  147.     for i, file := range files {
  148.         targetFileName := fmt.Sprintf("C:/Users/黑熊精/Pictures/%d_%s", i, file.Filename)
  149.         err = ctx.SaveUploadedFile(file, targetFileName)
  151.         if err != nil {
  152.             ctx.JSON(http.StatusInternalServerError, gin.H{
  153.                 "message": err.Error(),
  154.             })
  155.             return
  156.         }
  157.     }
  158.     ctx.JSON(http.StatusOK, gin.H{
  159.         "message": fmt.Sprintf("upload success!"),
  160.     })
  161. }
  163. // shuldbind数据的绑定的办法
  164. // 使用 ShouldBind() 方法, 根据请求方式，自动提取 JSON, form表单 和 Query 类型的参数，放入结构体中
  165. // 用户信息信息结构体
  166. // 加上 binding:"required" 标签，说明该参数是必填的，如果不填就会报错
  167. type UserInfo struct {
  168.     Username string `json:"username" form:"username" binding:"required"`
  169.     Address  string `json:"address" form:"address" binding:"required"`
  170. }
  172. // 获取query参数
  173. func queryHandle(ctx *gin.Context) {
  174.     var userInfo UserInfo
  176.     // 获取数据
  177.     err := ctx.ShouldBind(&userInfo)
  178.     if err == nil {
  179.         ctx.JSON(http.StatusOK, gin.H{
  180.             "message":  "ok",
  181.             "username": userInfo.Username,
  182.             "address":  userInfo.Address,
  183.         })
  184.     } else {
  185.         ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  186.     }
  187. }
  189. func jsonHandle(ctx *gin.Context) {
  190.     var userInfo UserInfo
  192.     // 获取数据
  193.     err := ctx.ShouldBind(&userInfo)
  194.     if err == nil {
  195.         ctx.JSON(http.StatusOK, gin.H{
  196.             "message":  "ok",
  197.             "username": userInfo.Username,
  198.             "address":  userInfo.Address,
  199.         })
  200.     } else {
  201.         ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  202.     }
  203. }
  205. func fromHandle(ctx *gin.Context) {
  206.     var userInfo UserInfo
  208.     // 获取数据
  209.     err := ctx.ShouldBind(&userInfo)
  210.     if err == nil {
  211.         ctx.JSON(http.StatusOK, gin.H{
  212.             "message":  "ok",
  213.             "username": userInfo.Username,
  214.             "address":  userInfo.Address,
  215.         })
  216.     } else {
  217.         ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  218.     }
  219. }
  221. func main() {
  223.     // 创建默认路由
  224.     r := gin.Default()
  225.     //两种浏览器地址获取参数的办法
  226.     // 绑定路由规则 /user/search?username=zhangsan&address=北京
  227.     r.GET("/user/search", urlQueryHandle)
  228.     // 2. 绑定路由规则/user/search/lisi/北京。 获取请求URL路径中的参数的方式如下
  229.     r.GET("/user/search/:username/:address", paramsPathHandle)
  231.     //========================表单提交方法======================
  232.     // 绑定路由规则
  233.     r.POST("/user/search", formParamsHandle)
  235.     //json
  236.     // 绑定路由规则
  237.     r.POST("/user/json", paramsJsonHandle)
  239.     //
  241.     // 绑定路由规则--文件上传
  242.     r.POST("/upload/single", singleFileUploadHandle)
  244.      绑定路由规则--多文件上传
  245.     r.POST("/upload/multi", multiFileUploadHandle)
  247.     //使用 ShouldBind() 方法, 根据请求方式，自动提取 JSON, form表单 和 Query 类型的参数，放入结构体中
  248.     // 绑定路由规则
  249.     r.GET("/user/query", queryHandle)
  250.     r.POST("/user/form", fromHandle)
  251.     r.POST("/user/jsons", jsonHandle)
  252.     // 监听端口
  253.     r.Run(":9000")
  254. }
标签： golang gin 开发语言
本文转载自: https://blog.csdn.net/wtt234/article/details/131953861
版权归原作者 雨师@ 所有， 如有侵权，请联系我们删除。
登录后发布评论

“golang，gin框架的请求参数（一）--推荐”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

网络安全法-网络运行安全

使用selenium/drissionpage时如何阻止chrome自动跳转http到https

docker desktop 里部署的Open WebUI 管理员密码忘记了的处理方法

在ubuntu20.04中搭建onsite比赛运行环境

利用开源的低代码表单设计器FcDesigner高效管理和渲染复杂表单结构

Kafka学习笔记

【前端】浏览器输入url到页面呈现发生了什么？

文章导航
没有找到文章内容分段。。。