Gin源码分析-接口请求返回过程分析

• • Render
  • ResponseWriter

Render

Gin的Render模块主要是针对各种格式的返回数据进行兼容，比如Text，JSON，XML等。
Gin支持JSON，XML，String，Object，Data，HTML，YML。ProtoBuf等多种数据格式的返回，这里我们只看我们常用的数据格式。
Gin兼容了ProtoBuf格式的数据渲染，使得我们可以用Gin实现任何一个框架的网关层服务，本系列文档的最后，也会去用Gin做这件事情。
下面是Gin再JSON结果的一个简单处理过程，实际上就是调用了Go原生的Json转换库实现。

func WriteJSON(w http.ResponseWriter, obj any) error {writeContentType(w, jsonContentType)jsonBytes, err := json.Marshal(obj)if err != nil {return err}_, err = w.Write(jsonBytes)return err
}

Gin作为一个框架其能力是非常全面的，通过Json的Render方法我们可以看到，不仅仅支持原生的Json转换，还支持各种特殊情况的Json，比如asciiJson，SecureJson等，基本可以应对所有的日常开发情况了。
ProtoBuf是一个十分特殊的格式，一般在rpc级别的系统中比较常见，gin这里也简单做了兼容。

func (r ProtoBuf) Render(w http.ResponseWriter) error {r.WriteContentType(w)// 协议jie xibytes, err := proto.Marshal(r.Data.(proto.Message))if err != nil {return err}_, err = w.Write(bytes)return err
}
func (r ProtoBuf) WriteContentType(w http.ResponseWriter) {writeContentType(w, protobufContentType)
}

在一个handler处理完成之后，使用c.JSON()将结果返回给客户端其链路为：Render → ResponseWriter

func (c *Context) JSON(code int, obj any) {// 触发返回结果渲染c.Render(code, render.JSON{Data: obj})
}

渲染函数
Render 这里的Render入参数为接口类型，这里就涉及到，Render目录下的各种实现了，大部分的开发基本都是局限于JSON了，我们这里的分析就以JSON为例，具体流程如下。
1.设置返回编码，直接设置的http status_code。
2.执行渲染并返回。

func (c *Context) Render(code int, r render.Render) {// 1.设置http请求编码，成功或者失败写到httpcode里面去c.Status(code)if !bodyAllowedForStatus(code) {r.WriteContentType(c.Writer)c.Writer.WriteHeaderNow()return}// 2.执行渲染if err := r.Render(c.Writer); err != nil {// Pushing error to c.Errors_ = c.Error(err)c.Abort()}
}

这里我们就看Render的Json类型实现，具体流程如下所示。
1.设置ContentType，这玩意儿就是http请求的response header里面的类型，提供给浏览器解析结果。
2.JSON parse数据，写入ResponseWriter，这个就和我们第二节所分析ResponseWriter有关了。

func WriteJSON(w http.ResponseWriter, obj any) error {writeContentType(w, jsonContentType)jsonBytes, err := json.Marshal(obj)if err != nil {return err}_, err = w.Write(jsonBytes)return err
}

ResponseWriter

我们接上一章节，在HTTP请求的底层就涉及了此类，主要是对请求结果的封装，返回结果，抽象的接口依赖的是http/net和io库。

// Write 写入数据流字节格式
func (w *responseWriter) Write(data []byte) (n int, err error) {w.WriteHeaderNow()n, err = w.ResponseWriter.Write(data)w.size += nreturn
}
// Write 写入数据流字符串格式
func (w *responseWriter) WriteString(s string) (n int, err error) {w.WriteHeaderNow()n, err = io.WriteString(w.ResponseWriter, s)w.size += nreturn
}

上面为gin实现的2种数据写入格式，具体流程如下所示。
1.设置请求编码。
2.写入响应结果，调用了Go原生的net库写入。
finishRequest
处理完请求回到基类的serve，触发finishRequest完成请求处理。

func (w *response) finishRequest() {// 标记为处理w.handlerDone.setTrue()if !w.wroteHeader {w.WriteHeader(StatusOK)}// 刷数据，返回包w.w.Flush()putBufioWriter(w.w)w.cw.close()w.conn.bufw.Flush()w.conn.r.abortPendingRead()// Close the body (regardless of w.closeAfterReply) so we can// re-use its bufio.Reader later safely./// 关闭链接w.reqBody.Close()if w.req.MultipartForm != nil {w.req.MultipartForm.RemoveAll()}
}

至此一个完整的Gin请求就分析完了，其实细细探究，其实就是对基础库的丰富扩展使得其具体更多的能力，开发更加便捷，只要我们懂得原生库就可以快速掌握此框架原理了。