Gin
封装的最好的地方就是context
和对response的处理。本篇文章主要解释context的使用方法, 以及其设计原理
在阅读gin的源码时, 请求的处理是使用type HandlerFunc func(*Context)
来处理的. 也就是
func(context *gin.Context) { context.String(http.StatusOK, "some post") }
参数是gin.Context
, 但是查看源码发现其实gin.Context
在整个框架处理的地方只有下面这段
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中Set Key-Value, 以及各种个样的Get方法, 如GetBool
, GetString
等
实现这些功能也很简单, 其实就是一个map
// Keys is a key/value pair exclusively for the context of each request. Keys map[string]interface{}
这个模块相当重要了, gin的README
基本上都在介绍这个模块的用法
gin的标准叫法是Parameters in path. restful风格api如/user/john
, 这个路由在gin里面是/user/:name
, 要获取john
就需要使用Param函数
name := c.Param("name")
这个方法实现也很简单, 就是在tree.go
里面根据路由相关规则解析出来然后赋值给gin.Context
的Params
.
handlers, params, tsr := root.getValue(path, c.Params, unescape)
/welcome?firstname=Jane&lastname=Doe
这样一个路由, first
, last
即是Querystring parameters
, 要获取他们就需要使用Query
相关函数.c.Query("first") // Jane c.Query("last") // Doe
当然还有其他相关函数:
这些方法是的实现是利用net/http
的Request
的方法实现的
对于POST
, PUT
等这些能够传递参数Body的请求, 要获取其参数, 需要使用PostForm
POST /user/1 { "name":manu, "message":this_is_great }
name := c.PostForm("name") message := c.PostForm("message")
其他相关函数
这些相关的方法是实现还是利用net/http
的Request
的方法实现的
对于文件相关的操作, 一般生产情况下不建议这样使用, 因为把文件上传到服务器磁盘, 还得磁盘相关的监控. 我觉得最好利用云服务商相关的对象存储
, 如:阿里云OSS, 七牛云对象存储, AWS的对象存储等来做文件的相关操作.
内置的有json
, xml
, protobuf
, form
, query
, yaml
. 这些Bind极大的减少我们自己去解析各种个样的数据格式, 提高我们的开发速度
Bind的实现都在gin/binding
里面. 这些内置的Bind都实现了Binding
接口, 主要是Bind()
函数.
这里的Header是写到Response里面的Header. 对于客户端发的请求的Header可以通过context.Request.Header.Get("Content-Type")
获取
提供对session, cookie的支持
做api常用到的其实就是gin封装的各种render. 目前支持的有:
当然我们可以自定义渲染, 只要实现func (c *Context) Render(code int, r render.Render)
即可.
这里我们常用的是一个方法是: gin.H{"error": 111}
. 这个结构相当实用, 各种render都支持. 其实这个结构很简单就是type H map[string]interface{}
, 当我们要从map转换各种各样结构时, 不妨参考gin这里的代码
原文:https://www.cnblogs.com/peteremperor/p/14033453.html