在 上一篇 Golang Gin 实战(四)| URL查询参数的获取和原理分析 文章中,因为文章篇幅问题,QueryArrayQueryMap没有介绍,这篇文章继续。

QueryArray

在实际的业务开发中,我们有些业务多选的,比如一个活动有多个人参加,一个问题有多个答案等等,对于这类业务功能来说,如果是通过查询参数提交的,它们的URL大概这样?a=b&a=c&a=d,key值都一样,但是对应的value不一样。

这类URL查询参数,就是一个数组,那么在Gin中我们如何获取它们呢?

这里举个例子,比如有一份调查问卷,问我有哪些自媒体,我选择个人博客和微信公众号

1
2
3
4
5
6
7
8
func main() {
	r := gin.Default()

	r.GET("/", func(c *gin.Context) {
		c.JSON(200, c.QueryArray("media"))
	})
	r.Run(":8080")
}

运行代码,在浏览器里访问http://localhost:8080/?media=blog&media=wechat,会看到如下信息:

["blog","wechat"]

我们的自媒体信息,已经作为一个数组被输出了,非常简单,这样我们就可以很方便的处理多选的业务。

QueryArray方法也有对应的GetQueryArray方法,区别在于返回对应的key是否存在,这里不再举例。

QueryArrayGetQueryArray源代码实现已经在上一篇Golang Gin 实战(四)| URL查询参数的获取和原理分析分析了,这里不再赘述,大家可以再看下上一篇文章。

QueryMap

QueryMap其实就是把满足一定格式的URL查询参数,转换为一个map,假设有a,b,c三个人,他们对应的id是123,456,789.那么用map的方式表示,这种格式类似于:

?ids[a]=123&ids[b]=456&ids[c]=789

从以上URL看,关键在于key,这个key必须符合map的定义,[]外面的必须相同,也就是ids这个map变量名,[]里面的,也就是map的key不能相同,这样就满足了Gin定义的把URL查询参数转换为map的格式定义。

1
2
3
	r.GET("/map", func(c *gin.Context) {
		c.JSON(200, c.QueryMap("ids"))
	})

获取map的方法很简单,把ids作为key即可。现在运行代码,访问http://localhost:8080/map?ids[a]=123&ids[b]=456&ids[c]=789,就会看到如下信息:

{"a":"123","b":"456","c":"789"}

我们输入的信息,正好被我们打印出来了。

GetQueryMapQueryMap是一样的,只是返回了对应的key是否存在。

QueryMap 的原理

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

func (c *Context) QueryMap(key string) map[string]string {
	dicts, _ := c.GetQueryMap(key)
	return dicts
}

func (c *Context) GetQueryMap(key string) (map[string]string, bool) {
	c.getQueryCache()
	return c.get(c.queryCache, key)
}

QueryMap是通过GetQueryMap,最终都是c.get这个方法实现,我们只需要分析c.get就可以了。注意这里同样用到了getQueryCache进行缓存提高性能。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
func (c *Context) get(m map[string][]string, key string) (map[string]string, bool) {
	dicts := make(map[string]string)
	exist := false
	for k, v := range m {
		if i := strings.IndexByte(k, '['); i >= 1 && k[0:i] == key {
			if j := strings.IndexByte(k[i+1:], ']'); j >= 1 {
				exist = true
				dicts[k[i+1:][:j]] = v[0]
			}
		}
	}
	return dicts, exist
}

这段实现代码看着比较绕,其实挺简单,它有两个参数,一个m其实就是缓存的所有查询参数键值对queryCache,另外一个就是我们要找的key

因为Gin定义的map的URL特殊格式化,所以这里需要判断是否有[],如果有的话,并且key匹配,那么这个键值对就是我们需要找的,把它存在dicts即可,最终返回的是这个dicts

这里等于是,Gin帮我们做了包装,可以更好的把特殊格式的URL转为map,提升了我们使用的效率,不过这种方法不常用,如果有特别的需要可以使用。

小结

接收数组是比较常用的,但是map不常用。其实对于接收参数来说,不光我们可以从URL查询参数中获得,还可以从提交的表单(Form)中获得,它们的原理是大同小异的,使用方式也非常像,下一篇我们就介绍表单的使用和原理分析。

更多关于Gin的讨论可以加入我的星球Golang Gin 实战,有更深入的讨论,一对一的答疑,公众号和博客没有的源代码分析。

扫码加入Golang Gin 实战星球

精彩文章推荐

Golang Gin 实战(四)| URL查询参数的获取和原理分析

Golang Gin 实战(三)| 路由参数

Golang Gin 实战(二)| 简便的Restful API 实现

Golang Gin 实战(一)| 快速安装入门

为了答谢新老朋友的转发、阅读和点赞支持,我给大家包了个现金红包,关注我的公众号,即可参与抽奖。在看到50,下次抽奖增加金额!

我有几个的Go语言交流微信群,可以扫码关注公众号flysnow_org或者网站 https://www.flysnow.org/,加我好友,我拉你进来。

扫码关注