深入理解Golang之http server的实现
前言
对于Golang来说,实现一个简单的httpserver非常容易,只需要短短几行代码。同时有了协程的加持,Go实现的httpserver能够取得非常优秀的性能。这篇文章将会对go标准库net/http实现http服务的原理进行较为深入的探究,以此来学习了解网络编程的常见范式以及设计思路。
HTTP服务
基于HTTP构建的网络应用包括两个端,即客户端(Client)和服务端(Server)。两个端的交互行为包括从客户端发出request、服务端接受request进行处理并返回response以及客户端处理response。所以http服务器的工作就在于如何接受来自客户端的request,并向客户端返回response。
典型的http服务端的处理流程可以用下图表示:
服务器在接收到请求时,首先会进入路由(router),这是一个Multiplexer,路由的工作在于为这个request找到对应的处理器(handler),处理器对request进行处理,并构建response。Golang实现的httpserver同样遵循这样的处理流程。
我们先看看Golang如何实现一个简单的httpserver:
packagemain import( "fmt" "net/http" ) funcindexHandler(whttp.ResponseWriter,r*http.Request){ fmt.Fprintf(w,"helloworld") } funcmain(){ http.HandleFunc("/",indexHandler) http.ListenAndServe(":8000",nil) }
运行代码之后,在浏览器中打开localhost:8000就可以看到helloworld。这段代码先利用http.HandleFunc在根路由/上注册了一个indexHandler,然后利用http.ListenAndServe开启监听。当有请求过来时,则根据路由执行对应的handler函数。
我们再来看一下另外一种常见的httpserver实现方式:
packagemain import( "fmt" "net/http" ) typeindexHandlerstruct{ contentstring } func(ih*indexHandler)ServeHTTP(whttp.ResponseWriter,r*http.Request){ fmt.Fprintf(w,ih.content) } funcmain(){ http.Handle("/",&indexHandler{content:"helloworld!"}) http.ListenAndServe(":8001",nil) }
Go实现的http服务步骤非常简单,首先注册路由,然后创建服务并开启监听即可。下文我们将从注册路由、开启服务、处理请求这几个步骤了解Golang如何实现http服务。
注册路由
http.HandleFunc和http.Handle都是用于注册路由,可以发现两者的区别在于第二个参数,前者是一个具有func(whttp.ResponseWriter,r*http.Requests)签名的函数,而后者是一个结构体,该结构体实现了func(whttp.ResponseWriter,r*http.Requests)签名的方法。
http.HandleFunc和http.Handle的源码如下:
funcHandleFunc(patternstring,handlerfunc(ResponseWriter,*Request)){ DefaultServeMux.HandleFunc(pattern,handler) } //HandleFuncregistersthehandlerfunctionforthegivenpattern. func(mux*ServeMux)HandleFunc(patternstring,handlerfunc(ResponseWriter,*Request)){ ifhandler==nil{ panic("http:nilhandler") } mux.Handle(pattern,HandlerFunc(handler)) }
funcHandle(patternstring,handlerHandler){ DefaultServeMux.Handle(pattern,handler) }
可以看到这两个函数最终都由DefaultServeMux调用Handle方法来完成路由的注册。
这里我们遇到两种类型的对象:ServeMux和Handler,我们先说Handler。
Handler
Handler是一个接口:
typeHandlerinterface{ ServeHTTP(ResponseWriter,*Request) }
Handler接口中声明了名为ServeHTTP的函数签名,也就是说任何结构只要实现了这个ServeHTTP方法,那么这个结构体就是一个Handler对象。其实go的http服务都是基于Handler进行处理,而Handler对象的ServeHTTP方法也正是用以处理request并构建response的核心逻辑所在。
回到上面的HandleFunc函数,注意一下这行代码:
mux.Handle(pattern,HandlerFunc(handler))
可能有人认为HandlerFunc是一个函数,包装了传入的handler函数,返回了一个Handler对象。然而这里HandlerFunc实际上是将handler函数做了一个类型转换,看一下HandlerFunc的定义:
typeHandlerFuncfunc(ResponseWriter,*Request) //ServeHTTPcallsf(w,r). func(fHandlerFunc)ServeHTTP(wResponseWriter,r*Request){ f(w,r) }
HandlerFunc是一个类型,只不过表示的是一个具有func(ResponseWriter,*Request)签名的函数类型,并且这种类型实现了ServeHTTP方法(在ServeHTTP方法中又调用了自身),也就是说这个类型的函数其实就是一个Handler类型的对象。利用这种类型转换,我们可以将一个handler函数转换为一个
Handler对象,而不需要定义一个结构体,再让这个结构实现ServeHTTP方法。读者可以体会一下这种技巧。
ServeMux
Golang中的路由(即Multiplexer)基于ServeMux结构,先看一下ServeMux的定义:
typeServeMuxstruct{ musync.RWMutex mmap[string]muxEntry es[]muxEntry//sliceofentriessortedfromlongesttoshortest. hostsbool//whetheranypatternscontainhostnames } typemuxEntrystruct{ hHandler patternstring }
这里重点关注ServeMux中的字段m,这是一个map,key是路由表达式,value是一个muxEntry结构,muxEntry结构体存储了对应的路由表达式和handler。
值得注意的是,ServeMux也实现了ServeHTTP方法:
func(mux*ServeMux)ServeHTTP(wResponseWriter,r*Request){ ifr.RequestURI=="*"{ ifr.ProtoAtLeast(1,1){ w.Header().Set("Connection","close") } w.WriteHeader(StatusBadRequest) return } h,_:=mux.Handler(r) h.ServeHTTP(w,r) }
也就是说ServeMux结构体也是Handler对象,只不过ServeMux的ServeHTTP方法不是用来处理具体的request和构建response,而是用来确定路由注册的handler。
注册路由
搞明白Handler和ServeMux之后,我们再回到之前的代码:
DefaultServeMux.Handle(pattern,handler)
这里的DefaultServeMux表示一个默认的Multiplexer,当我们没有创建自定义的Multiplexer,则会自动使用一个默认的Multiplexer。
然后再看一下ServeMux的Handle方法具体做了什么:
func(mux*ServeMux)Handle(patternstring,handlerHandler){ mux.mu.Lock() defermux.mu.Unlock() ifpattern==""{ panic("http:invalidpattern") } ifhandler==nil{ panic("http:nilhandler") } if_,exist:=mux.m[pattern];exist{ panic("http:multipleregistrationsfor"+pattern) } ifmux.m==nil{ mux.m=make(map[string]muxEntry) } //利用当前的路由和handler创建muxEntry对象 e:=muxEntry{h:handler,pattern:pattern} //向ServeMux的map[string]muxEntry增加新的路由匹配规则 mux.m[pattern]=e //如果路由表达式以'/'结尾,则将对应的muxEntry对象加入到[]muxEntry中,按照路由表达式长度排序 ifpattern[len(pattern)-1]=='/'{ mux.es=appendSorted(mux.es,e) } ifpattern[0]!='/'{ mux.hosts=true } }
Handle方法主要做了两件事情:一个就是向ServeMux的map[string]muxEntry增加给定的路由匹配规则;然后如果路由表达式以'/'结尾,则将对应的muxEntry对象加入到[]muxEntry中,按照路由表达式长度排序。前者很好理解,但后者可能不太容易看出来有什么作用,这个问题后面再作分析。
自定义ServeMux
我们也可以创建自定义的ServeMux取代默认的DefaultServeMux:
packagemain import( "fmt" "net/http" ) funcindexHandler(whttp.ResponseWriter,r*http.Request){ fmt.Fprintf(w,"helloworld") } funchtmlHandler(whttp.ResponseWriter,r*http.Request){ w.Header().Set("Content-Type","text/html") html:=`Golang Welcome!