Gin源码解析-深圳市維司達科技有限公司

结构

Engine的结构为

typeEnginestruct{RouterGroup routeTreesUpdated sync.Once RedirectTrailingSlashboolRedirectFixedPathboolHandleMethodNotAllowedboolForwardedByClientIPboolAppEngineboolUseRawPathboolUseEscapedPathboolUnescapePathValuesboolRemoveExtraSlashboolRemoteIPHeaders[]stringTrustedPlatformstringMaxMultipartMemoryint64UseH2CboolContextWithFallbackbooldelims render.Delims secureJSONPrefixstringHTMLRender render.HTMLRender FuncMap template.FuncMap allNoRoute HandlersChain allNoMethod HandlersChain noRoute HandlersChain noMethod HandlersChain pool sync.Pool trees methodTrees maxParamsuint16maxSectionsuint16trustedProxies[]stringtrustedCIDRs[]*net.IPNet}

allNoRoute：没有找到路由时的处理链
allNoMethod：方法没有找到时的处理链
RouterGroup结构为

typeRouterGroupstruct{Handlers HandlersChain basePathstringengine*Engine rootbool}

HandlersChain为函数切片

typeHandlerFuncfunc(*Context)typeHandlersChain[]HandlerFunc

Context为处理中的关键数据结构

typeContextstruct{writermem responseWriter Request*http.Request Writer ResponseWriter Params Params handlers HandlersChain indexint8fullPathstringengine*Engine params*Params skippedNodes*[]skippedNode// This mutex protects Keys map.mu sync.RWMutex// Keys is a key/value pair exclusively for the context of each request.Keysmap[any]any// Errors is a list of errors attached to all the handlers/middlewares who used this context.Errors errorMsgs// Accepted defines a list of manually accepted formats for content negotiation.Accepted[]string// queryCache caches the query result from c.Request.URL.Query().queryCache url.Values// formCache caches c.Request.PostForm, which contains the parsed form data from POST, PATCH,// or PUT body parameters.formCache url.Values// SameSite allows a server to define a cookie attribute making it impossible for// the browser to send this cookie along with cross-site requests.sameSite http.SameSite}

创建

创建Engine是通过Default方法

先使用New()创建Engine
使用OptionFunc函数来配置Engine

funcDefault(opts...OptionFunc)*Engine{debugPrintWARNINGDefault()engine:=New()engine.Use(Logger(),Recovery())returnengine.With(opts...)}funcNew(opts...OptionFunc)*Engine{debugPrintWARNINGNew()engine:=&Engine{RouterGroup:RouterGroup{Handlers:nil,basePath:"/",root:true,},FuncMap:template.FuncMap{},RedirectTrailingSlash:true,RedirectFixedPath:false,HandleMethodNotAllowed:false,ForwardedByClientIP:true,RemoteIPHeaders:[]string{"X-Forwarded-For","X-Real-IP"},TrustedPlatform:defaultPlatform,UseRawPath:false,UseEscapedPath:false,RemoveExtraSlash:false,UnescapePathValues:true,MaxMultipartMemory:defaultMultipartMemory,trees:make(methodTrees,0,9),delims:render.Delims{Left:"{{",Right:"}}"},secureJSONPrefix:"while(1);",trustedProxies:[]string{"0.0.0.0/0","::/0"},trustedCIDRs:defaultTrustedCIDRs,}engine.engine=engine engine.pool.New=func()any{returnengine.allocateContext(engine.maxParams)}returnengine.With(opts...)}func(engine*Engine)With(opts...OptionFunc)*Engine{for_,opt:=rangeopts{opt(engine)}returnengine}

OptionFunc为函数别名

typeOptionFuncfunc(*Engine)

运行

是通过Run来执行

在没有指定地址信息时，读取环境变量PORT端口号，没有则默认使用端口号8080
内部创建http.Server,handler为engine.Handler()，执行http.Server的方法ListenAndServe，其中Engine是实现了http.Handler接口

func(engine*Engine)Run(addr...string)(errerror){deferfunc(){debugPrintError(err)}()ifengine.isUnsafeTrustedProxies(){debugPrint("[WARNING] You trusted all proxies, this is NOT safe. We recommend you to set a value.\n"+"Please check https://github.com/gin-gonic/gin/blob/master/docs/doc.md#dont-trust-all-proxies for details.")}engine.updateRouteTrees()address:=resolveAddress(addr)debugPrint("Listening and serving HTTP on %s\n",address)server:=&http.Server{// #nosec G112Addr:address,Handler:engine.Handler(),}err=server.ListenAndServe()return}

Engine实现了http.Handler接口方法ServeHTTP，内部调用handleHTTPRequest，根据请求方法和请求url,找到对应的HandlersChain，执行Context的Next()方法，遍历处理链执行处理

func(engine*Engine)ServeHTTP(w http.ResponseWriter,req*http.Request){engine.routeTreesUpdated.Do(func(){engine.updateRouteTrees()})c:=engine.pool.Get().(*Context)c.writermem.reset(w)c.Request=req c.reset()engine.handleHTTPRequest(c)engine.pool.Put(c)}func(engine*Engine)handleHTTPRequest(c*Context){httpMethod:=c.Request.Method rPath:=c.Request.URL.Path unescape:=falseifengine.UseEscapedPath{rPath=c.Request.URL.EscapedPath()unescape=engine.UnescapePathValues}elseifengine.UseRawPath&&len(c.Request.URL.RawPath)>0{rPath=c.Request.URL.RawPath unescape=engine.UnescapePathValues}ifengine.RemoveExtraSlash{rPath=cleanPath(rPath)}// Find root of the tree for the given HTTP methodt:=engine.treesfori,tl:=0,len(t);i<tl;i++{ift[i].method!=httpMethod{continue}root:=t[i].root// Find route in treevalue:=root.getValue(rPath,c.params,c.skippedNodes,unescape)ifvalue.params!=nil{c.Params=*value.params}ifvalue.handlers!=nil{c.handlers=value.handlers c.fullPath=value.fullPath c.Next()c.writermem.WriteHeaderNow()return}ifhttpMethod!=http.MethodConnect&&rPath!="/"{ifvalue.tsr&&engine.RedirectTrailingSlash{redirectTrailingSlash(c)return}ifengine.RedirectFixedPath&&redirectFixedPath(c,root,engine.RedirectFixedPath){return}}break}ifengine.HandleMethodNotAllowed&&len(t)>0{// According to RFC 7231 section 6.5.5, MUST generate an Allow header field in response// containing a list of the target resource's currently supported methods.allowed:=make([]string,0,len(t)-1)for_,tree:=rangeengine.trees{iftree.method==httpMethod{continue}ifvalue:=tree.root.getValue(rPath,nil,c.skippedNodes,unescape);value.handlers!=nil{allowed=append(allowed,tree.method)}}iflen(allowed)>0{c.handlers=engine.allNoMethod c.writermem.Header().Set("Allow",strings.Join(allowed,", "))serveError(c,http.StatusMethodNotAllowed,default405Body)return}}c.handlers=engine.allNoRouteserveError(c,http.StatusNotFound,default404Body)}func(c*Context)Next(){c.index++forc.index<safeInt8(len(c.handlers)){ifc.handlers[c.index]!=nil{c.handlers[c.index](c)}c.index++}}