Gin获取querystring参数的几种方式

古城微笑少年丶 2022-09-02 00:51 314阅读 0赞

> 参考资料：[李文周的博客 - Gin框架介绍及使用][- Gin]  
> Bilibili链接：[【最新Go Web开发教程】基于gin框架和gorm的web开发实战 (七米出品)][Go Web_gin_gorm_web_]

### 目录 ###

*  Gin
 *  编写一个Gin实例
 *   *  方式1 - Query()
     *  方式2 - GetQuery()
     *  方式3 - DefaultQuery()

# Gin #

Gin是Golang最流行的Web框架，GitHub上有32K+ Star，是基于httprouter开发的简单易用的轻量级Web框架。  
首先新建一个Go modules项目，在Environment中添加`GOPROXY=http://goproxy.cn`。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NTU0MDEw_size_16_color_FFFFFF_t_70]  
新建项目完成之后，右键单击左侧的文件夹，选择“Open In”→“Terminal”在终端中打开，输入命令`go get -u github.com/gin-gonic/gin`下载并导入Gin的依赖。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NTU0MDEw_size_16_color_FFFFFF_t_70 1]  
在项目的go.mod文件中可以看到导入的依赖：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NTU0MDEw_size_16_color_FFFFFF_t_70 2]

# 编写一个Gin实例 #

新建main.go文件，写入如下代码创建一个Gin实例：

package main
    
    import (
    	"github.com/gin-gonic/gin"
    )
    
    func main() { 
    	// 创建一个默认的路由引擎
    	engine := gin.Default()
    
    	engine.GET("/web", func(context *gin.Context) { 
    		// TODO 获取浏览器发送请求携带的querystring
    	})
    
    	err := engine.Run()    // 默认端口号为8080
    	if err != nil { 
    		return
    	}
    }

Querystring指的是URL中`?`后面携带的参数。下面介绍获取querystring参数的几种方式。

## 方式1 - Query() ##

`Query()`的函数原型为`func (c *Context) Query(key string) string`，函数返回的字符串即为querystring。

name := context.Query("query")
    context.JSON(http.StatusOK, gin.H{ 
    	"name": name,
    })

## 方式2 - GetQuery() ##

`GetQuery()`的函数原型为`func (c *Context) GetQuery(key string) (string, bool)`，可以看出它与`Query()`的不同是它返回了querystring和一个布尔值，即如果没有成功获取到querystring，第二个返回值为`false`。  
实际上如果查看`Query()`的源码，我们可以发现`Query()`就是调用了`GetQuery()`，只是忽略了返回的布尔值。

func (c *Context) Query(key string) string { 
    	value, _ := c.GetQuery(key)
    	return value
    }

下面编写Gin实例。如果获取不到querystring，即`ok`为`false`时，就将querystring设置为`somebody`。

name, ok := context.GetQuery("query")
    if !ok { 
    	name = "somebody"
    }
    context.JSON(http.StatusOK, gin.H{ 
    	"name": name,
    })

## 方式3 - DefaultQuery() ##

`DefaultQuery()`的函数原型为`func (c *Context) DefaultQuery(key string, defaultValue string) string`，它有两个参数，当获取不到`key`作为querystring时，则采用`defaultValue`作为querystring。`DefaultQuery()`可以看作是简化版的`GetQuery()`，其源码如下：

func (c *Context) DefaultQuery(key, defaultValue string) string { 
    	if value, ok := c.GetQuery(key); ok { 
    		return value
    	}
    	return defaultValue
    }

下面编写Gin实例。如果获取不到querystring，就将querystring设置为`somebody`（即设置`defaultValue`参数为`somebody`）。

name := context.DefaultQuery("query", "somebody")
    context.JSON(http.StatusOK, gin.H{ 
    	"name": name,
    })

除此之外还有很多方法，在此不一一列举。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NTU0MDEw_size_16_color_FFFFFF_t_70 3]

[- Gin]: https://www.liwenzhou.com/posts/Go/Gin_framework/
[Go Web_gin_gorm_web_]: https://www.bilibili.com/video/BV1gJ411p7xC?p=10
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NTU0MDEw_size_16_color_FFFFFF_t_70]: /images/20220829/a96c957cbfc24af2b29b9f022a0747c7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NTU0MDEw_size_16_color_FFFFFF_t_70 1]: /images/20220829/3a47db6eaa054fe5ab66e940365be729.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NTU0MDEw_size_16_color_FFFFFF_t_70 2]: /images/20220829/db6c3fc45e8c42259c07287c7501ba46.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NTU0MDEw_size_16_color_FFFFFF_t_70 3]: /images/20220829/5638fe88cb3d4cc9870fc394df0f0704.png