当前位置：首页 > golang > 正文内容

gin牛逼的context

3年前 (2022-08-01)golang681

`Gin`封装的最好的地方就是`context`和对`response`的处理. `github`的`README`的介绍,基本就是对这两个东西的解释. 本篇文章主要解释`context`的使用方法, 以及其设计原理

### 为什么要将`Request`的处理封装到`Context`中

在阅读`gin`的源码时, 请求的处理是使用`type HandlerFunc func(*Context)`来处理的. 也就是
```go
func(context *gin.Context) {
    context.String(http.StatusOK, "some post")
}
```
参数是`gin.Context`, 但是查看源码发现其实`gin.Context`在整个框架处理的地方只有下面这段:
```go
func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request) {
    c := engine.pool.Get().(*Context)
    c.writermem.reset(w)
    c.Request = req
    c.reset()
    engine.handleHTTPRequest(c)
    engine.pool.Put(c)
}
```
那为什么还要利用`Context`来处理呢. `gin`的`context`实现了的`context.Context Interface`.

经过查看`context.Context`相关资料, `Context`的最佳运用场景就是对`Http`的处理. 封装成`Conetxt`另外的好处就是`WithCancel`, `WithDeadline`, `WithTimeout`, `WithValue`这些`context`包衍生的子`Context`就可以直接来使用. 目前我能想到的地方就这么多, 以后发现`gin.Context`其他的优点再补充.

### `gin.Context`的设计

`gin.Context`主要由下面几部分组成(这里沿用源代码里面的注释)

### `Metadata Management` (我自己叫法:`Key-Value`)

这个模块比较简单, 就是从`gin.Context`中`Set Key-Value`, 以及各种个样的`Get`方法, 如`GetBool`, `GetString`等实现这些功能也很简单, 其实就是一个`map`
```go
// Keys is a key/value pair exclusively for the context of each request.
Keys map[string]interface{}
```
### `Input Data`

这个模块相当重要了, `gin`的`README`基本上都在介绍这个模块的用法.

### `Param` (我自己的叫法: 路由变量)

`gin`的标准叫法是`Parameters in path`. `restful`风格`api`如`/user/john`, 这个路由在`gin`里面是`/user/:name`, 要获取`john`就需要使用`Param`函数
```go
name := c.Param("name")
```
这个方法实现也很简单, 就是在`tree.go`里面根据路由相关规则解析出来然后赋值给`gin.Context`的`Params`.
```go
handlers, params, tsr := root.getValue(path, c.Params, unescape)
```
### `Query`

`/welcome?firstname=Jane&lastname=Doe`这样一个路由, `first`, `last`即是`Querystring parameters`, 要获取他们就需要使用`Query`相关函数.
```go
c.Query("first") // Jane
c.Query("last") // Doe
```
当然还有其他相关函数:

* `QueryMap`
* `DefaultQuery` 这个默认值的实现更加简单, 当`QueryString`中不包含这个值, 直接返回填入的值

这些方法是的实现是利用`net/http`的`Request`的方法实现的

### `PostForm`

对于`POST`, `PUT`等这些能够传递参数`Body`的请求, 要获取其参数, 需要使用`PostForm`
```go
POST /user/1

{
    "name":manu,
    "message":this_is_great
}
```
```go
name := c.PostForm("name")
message := c.PostForm("message")
```
其他相关函数

* DefaultPostForm

这些相关的方法是实现还是利用`net/http`的`Request`的方法实现的

### `FormFile`

对于文件相关的操作, 一般生产情况下不建议这样使用, 因为把文件上传到服务器磁盘, 还得磁盘相关的监控. 我觉得最好利用云服务商相关的对象存储, 如:阿里云OSS, 七牛云对象存储, AWS的对象存储等来做文件的相关操作

### `Bind`

内置的有`json`, `xml`, `protobuf`, `form`, `query`, `yaml`. 这些`Bind`极大的减少我们自己去解析各种个样的数据格式, 提高我们的开发速度

`Bind`的实现都在`gin/binding`里面. 这些内置的`Bind`都实现了`Binding`接口, 主要是`Bind()`函数.

* `context.BindJSON()` 支持MIME为`application/json`的解析
* `context.BindXML()` 支持MIME为`application/xml`的解析
* `context.BindYAML()` 支持MIME为`application/x-yaml`的解析
* `context.BindQuery()` 只支持`QueryString`的解析, 和`Query()`函数一样
* `context.BindUri()` 只支持路由变量的解析
* `Context.Bind()` 支持所有的类型的解析, 这个函数尽量还是少用(当`QueryString`, `PostForm`, 路由变量在一块同时使用时会产生意想不到的效果), 目前测试`Bind`不支持路由变量的解析, `Bind()`函数的解析比较复杂, 这部分代码后面再看

### `Response`

### 对`Header`的支持

* `Header`
* `GetHeader`

这里的`Header`是写到`Response`里面的`Header`. 对于客户端发的请求的`Header`可以通过`context.Request.Header.Get("Content-Type")`获取

### `Cookie`

提供对`session`, `cookie`的支持

### `render`

做`api`常用到的其实就是`gin`封装的各种`render`. 目前支持的有:

* `func (c *Context) JSON(code int, obj interface{})`
* `func (c *Context) Protobuf(code int, obj interface{})`
* `func (c *Context) YAML(code int, obj interface{}) ...`

当然我们可以自定义渲染, 只要实现`func (c *Context) Render(code int, r render.Render)`即可.

这里我们常用的是一个方法是: `gin.H{"error": 111}`. 这个结构相当实用, 各种`render`都支持. 其实这个结构很简单就是`type H map[string]interface{}`, 当我们要从map转换各种各样结构时, 不妨参考`gin`这里的代码

`Context`说到这里基本就说完了, 这里介绍的方法都是开发中特别实用的方法. `context`的代码实现也特别有条理, 建议可以看看这部分代码.

### 知识星球
#### 星球地址：https://t.zsxq.com/03MJM7YfI

### **关注公众号「程序员小乔」**

![程序员小乔](https://www.qsjob.fun/zb_users/upload/2022/07/202207041451541741109.jpg "程序员小乔")

随机文章
热门文章
热评文章

扫描二维码推送至手机访问。

本文链接：https://www.qsjob.fun/post/22.html

标签: go gin

分享给朋友：

返回列表

上一篇：Mac + Docker + K8S 本地搭建K8S集群

下一篇： 5 个 Docker 日志记录最佳实践

“gin牛逼的context” 的相关文章

Mac + Docker + K8S 本地搭建K8S集群3年前 (2022-07-28)

5 个 Docker 日志记录最佳实践3年前 (2022-08-02)

Go 语言快速入门指南：介绍及安装3年前 (2022-08-03)

Go 语言快速入门指南：基本类型3年前 (2022-08-05)

Go 语言快速入门指南：结构体3年前 (2022-08-06)

Go 语言快速入门指南：指针、Map3年前 (2022-08-07)

gin牛逼的context

“gin牛逼的context” 的相关文章

京ICP备2021021334号

Powered By Z-BlogPHP. Theme by TOYEAN.

gin牛逼的context

“gin牛逼的context” 的相关文章

京ICP备2021021334号var _hmt = _hmt || [];(function() { var hm = document.createElement("script"); hm.src = "https://hm.baidu.com/hm.js?b63854c12c937e8f0e109978f0f10b08"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(hm, s);})();

Powered By Z-BlogPHP. Theme by TOYEAN.

京ICP备2021021334号