以下研究?jī)?nèi)容源于1.4.0版本源碼
Context扮演的角色
每個(gè)HTTP請(qǐng)求都會(huì)包含一個(gè)Context對(duì)象迫皱，Context應(yīng)貫穿整個(gè)HTTP請(qǐng)求，包含所有上下文信息
Context對(duì)象池
為了減少GC和敬，gin使用了對(duì)象池管理Context
//gin.go
// ServeHTTP conforms to the http.Handler interface.
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在goroutine中的并發(fā)安全
gin沒有對(duì)Context并發(fā)安全的處理戏阅，應(yīng)避免多goroutine同時(shí)訪問同一個(gè)Context。如可能存在goroutine同時(shí)訪問Context的情況舱痘，應(yīng)用事先用Copy方法進(jìn)行拷貝，如下：
// Copy returns a copy of the current context that can be safely used outside the request's scope.
// This has to be used when the context has to be passed to a goroutine.
func (c *Context) Copy() *Context {
var cp = *c
cp.writermem.ResponseWriter = nil
cp.Writer = &cp.writermem
cp.index = abortIndex
cp.handlers = nil
cp.Keys = map[string]interface{}{}
for k, v := range c.Keys {
cp.Keys[k] = v
}
return &cp
}
可以看到拷貝之后，ResponseWriter其實(shí)是一個(gè)空的對(duì)象铝耻，所以說蹬刷，即使拷貝了，也要在主Context中才能返回響應(yīng)結(jié)果泡态。
這樣設(shè)計(jì)是好的迂卢，如果在Context中處理了并發(fā)安全而克，會(huì)代碼降低執(zhí)行效率不說，使用者濫用goroutine的話腾降，響應(yīng)流程就處理混亂了碎绎。
整理后決定連Copy方法也刪了。
Context之Bind
Bind奸晴、ShouldBind相關(guān)方法用于請(qǐng)求參數(shù)綁定幕随，區(qū)別是Bind綁定過程中出現(xiàn)error會(huì)直接返回HTTP異常碼赘淮。
關(guān)于ShouldBindBodyWith
// ShouldBindBodyWith is similar with ShouldBindWith, but it stores the request
// body into the context, and reuse when it is called again.
//
// NOTE: This method reads the body before binding. So you should use
// ShouldBindWith for better performance if you need to call only once.
func (c *Context) ShouldBindBodyWith(obj interface{}, bb binding.BindingBody) (err error) {
var body []byte
if cb, ok := c.Get(BodyBytesKey); ok {
if cbb, ok := cb.([]byte); ok {
body = cbb
}
}
if body == nil {
body, err = ioutil.ReadAll(c.Request.Body)
if err != nil {
return err
}
c.Set(BodyBytesKey, body)
}
return bb.BindBody(body, obj)
}
這個(gè)方法沒有用到，作用是先把Body備份一份到Context走诞，下次數(shù)據(jù)綁定直接從Context中取蛤高。沒有意義，重新解析一次和直接用Bind沒有區(qū)別塞绿，刪掉异吻。
Context之Negotiate
設(shè)計(jì)的初衷是根據(jù)客戶端請(qǐng)求，返回客戶端需要的數(shù)據(jù)格式棋返，如果不能提供雷猪，就返回默認(rèn)格式
// Negotiate contains all negotiations data.
type Negotiate struct {
Offered []string
HTMLName string
HTMLData interface{}
JSONData interface{}
XMLData interface{}
Data interface{}
}
特殊場(chǎng)景會(huì)用到，實(shí)際不如直接switch來得快射沟。其實(shí)支持多返回結(jié)果月帝，實(shí)際用的也是單單Data字段，否則就要在內(nèi)存中生成多份數(shù)據(jù)簿姨，影響效率簸搞。比如同時(shí)支持JSON和XML趁俊，Negotiate里就要同時(shí)包含JSONData和XMLData，實(shí)際上只包含一個(gè)Data就可以了暇务。這里是過度設(shè)計(jì)怔软，可刪除。
Context之響應(yīng)（以json格式為例）
// JSON serializes the given struct as JSON into the response body.
// It also sets the Content-Type as "application/json".
func (c *Context) JSON(code int, obj interface{}) {
c.Render(code, render.JSON{Data: obj})
}
// AbortWithStatusJSON calls `Abort()` and then `JSON` internally.
// This method stops the chain, writes the status code and return a JSON body.
// It also sets the Content-Type as "application/json".
func (c *Context) AbortWithStatusJSON(code int, jsonObj interface{}) {
c.Abort()//停止下一個(gè)路由方法的訪問挡逼，返回當(dāng)前寫入的請(qǐng)求結(jié)果括改。這行代碼放在下行代碼后結(jié)果是一樣的
c.JSON(code, jsonObj)
}
如上，只有調(diào)用Abort()之后家坎，HTTP請(qǐng)求才會(huì)馬上返回響應(yīng)結(jié)果嘱能，否則吝梅，會(huì)執(zhí)行下一個(gè)路由方法。
既然都傳入http返回狀態(tài)碼了惹骂，常規(guī)情況就應(yīng)該是直接Abort()苏携。而且正常返回流程HTTP狀態(tài)碼就是200。
而且一個(gè)有意思的情況是兜叨，如果你這樣調(diào)用
c.JSON(200,...)
c.JSON(200,...)
c.Abort()
會(huì)打印一個(gè)[重復(fù)寫入HTTP狀態(tài)碼]的警告:[WARNING] Headers were already written. Wanted to override status code 我們來看警告的源碼
func (w *responseWriter) WriteHeader(code int) {
if code > 0 && w.status != code {
if w.Written() {
debugPrint("[WARNING] Headers were already written. Wanted to override status code %d with %d", w.status, code)
}
w.status = code
}
}
然后再看gin自帶的logger里做了這種事情
//logger.go 169行
// ErrorLoggerT returns a handlerfunc for a given error type.
func ErrorLoggerT(typ ErrorType) HandlerFunc {
return func(c *Context) {
c.Next()
errors := c.Errors.ByType(typ)
if len(errors) > 0 {
c.JSON(-1, errors)
}
}
}
驚不驚喜，意不意外衩侥？也就是說用到gin自帶的logger的時(shí)候，還可能給你帶來個(gè)彩蛋矛物∶Ｋ溃可能會(huì)返回這樣的數(shù)據(jù)給前端：[一串JSON的錯(cuò)誤信息]+[正常返回?cái)?shù)據(jù)]。
c.JSON(-1, errors)//這里因?yàn)閏ode<0履羞，不會(huì)引發(fā)[WARNING] Headers were already written的后臺(tái)錯(cuò)誤
c.JSON(200,gin.H{"code":500,"message":"用戶名不能為空"})
c.Abort()
//這里因?yàn)檫B續(xù)兩次寫入JSON數(shù)據(jù)峦萎，前端收到HTTP狀態(tài)碼是200，但是無法識(shí)別正常數(shù)據(jù)忆首。
程序設(shè)計(jì)應(yīng)避免這種模棱兩可的情況爱榔。還有自帶logger最好不用吧、想辦法清理掉換上自己的日志庫糙及。
所以說详幽，考慮通常情況，簡(jiǎn)化調(diào)用流程浸锨，改良后代碼：
func (c *Context) JSON(obj interface{}) {
c.Abort()
c.JSONWithStatus(http.StatusOK, jsonObj)
}
func (c *Context) JSONWithStatus(code int, jsonObj interface{}) {
c.Render(code, render.JSON{Data: obj})
c.Abort()
}
相比原來舒服多了唇聘。這樣就夠了嗎？還不夠柱搜。因?yàn)槌薐SON還有好多種數(shù)據(jù)格式返回迟郎，那樣每種數(shù)據(jù)格式，就要開放兩個(gè)方法聪蘸。然后繼續(xù)研究代碼宪肖。
如下，發(fā)現(xiàn)最后面都會(huì)調(diào)用到此方法健爬，這個(gè)方法還是public的
// Status sets the HTTP response code.（設(shè)置HTTP返回狀態(tài)碼）
func (c *Context) Status(code int) {
c.writermem.WriteHeader(code)
}
那如果不設(shè)置的話控乾，默認(rèn)狀態(tài)碼是多少呢？沒錯(cuò)浑劳，下面這個(gè)defaultStatus就是200
func (w *responseWriter) reset(writer http.ResponseWriter) {
w.ResponseWriter = writer
w.size = noWritten
w.status = defaultStatus
}
那么就好辦了阱持，只保留一個(gè)方法即可
func (c *Context) JSON(obj interface{}) {
c.Render(c.writermem.status, render.JSON{Data: obj})
c.Abort()
}
//調(diào)用示例1--常規(guī)返回（200）
c.JSON("{}")
//調(diào)用示例2--指定狀態(tài)碼返回
c.Status(500)
c.JSON("{}")
總結(jié)
1.gin使用對(duì)象池高效地管理Context。
2.gin的Context不是并發(fā)安全的魔熏，應(yīng)注意避免衷咽。
3.Bind鸽扁、ShouldBind相關(guān)方法用于請(qǐng)求參數(shù)綁定，區(qū)別是Bind綁定過程中出現(xiàn)error會(huì)直接返回HTTP異常碼镶骗。
4.Negotiate為過度設(shè)計(jì)桶现，可刪除。
5.Context的響應(yīng)方法可以加上Abort和默認(rèn)HTTP狀態(tài)碼鼎姊，用得更舒服點(diǎn)骡和。還能避免踩坑。
另附一份修改過的context.go文件的代碼代碼鏈接
