前言
对于Golang来说,实现一个简单的http server
非常容易,只需要短短几行代码。同时有了协程的加持,Go实现的http server
能够取得非常优秀的性能。这篇文章将会对go标准库net/http
实现http服务的原理进行较为深入的探究,以此来学习了解网络编程的常见范式以及设计思路。
HTTP服务
基于HTTP构建的网络应用包括两个端,即客户端(Client
)和服务端(Server
)。两个端的交互行为包括从客户端发出request
、服务端接受request
进行处理并返回response
以及客户端处理response
。所以http服务器的工作就在于如何接受来自客户端的request
,并向客户端返回response
。
典型的http服务端的处理流程可以用下图表示:
服务器在接收到请求时,首先会进入路由(router
),这是一个Multiplexer
,路由的工作在于为这个request
找到对应的处理器(handler
),处理器对request
进行处理,并构建response
。Golang实现的http server
同样遵循这样的处理流程。
我们先看看Golang如何实现一个简单的http server
:
1 | package main |
运行代码之后,在浏览器中打开localhost:8000
就可以看到hello world
。这段代码先利用http.HandleFunc
在根路由/
上注册了一个indexHandler
, 然后利用http.ListenAndServe
开启监听。当有请求过来时,则根据路由执行对应的handler
函数。
我们再来看一下另外一种常见的http server
实现方式:
1 | package main |
Go实现的http
服务步骤非常简单,首先注册路由,然后创建服务并开启监听即可。下文我们将从注册路由、开启服务、处理请求这几个步骤了解Golang如何实现http
服务。
注册路由
http.HandleFunc
和http.Handle
都是用于注册路由,可以发现两者的区别在于第二个参数,前者是一个具有func(w http.ResponseWriter, r *http.Requests)
签名的函数,而后者是一个结构体,该结构体实现了func(w http.ResponseWriter, r *http.Requests)
签名的方法。http.HandleFunc
和http.Handle
的源码如下:1
2
3
4
5
6
7
8
9
10
11func HandleFunc(pattern string, handler func(ResponseWriter, *Request)) {
DefaultServeMux.HandleFunc(pattern, handler)
}
// HandleFunc registers the handler function for the given pattern.
func (mux *ServeMux) HandleFunc(pattern string, handler func(ResponseWriter, *Request)) {
if handler == nil {
panic("http: nil handler")
}
mux.Handle(pattern, HandlerFunc(handler))
}
1 | func Handle(pattern string, handler Handler) { |
可以看到这两个函数最终都由DefaultServeMux
调用Handle
方法来完成路由的注册。
这里我们遇到两种类型的对象:ServeMux
和Handler
,我们先说Handler
。
Handler
Handler
是一个接口:
1 | type Handler interface { |
Handler
接口中声明了名为ServeHTTP
的函数签名,也就是说任何结构只要实现了这个ServeHTTP
方法,那么这个结构体就是一个Handler
对象。其实go的http
服务都是基于Handler
进行处理,而Handler
对象的ServeHTTP
方法也正是用以处理request
并构建response
的核心逻辑所在。
回到上面的HandleFunc
函数,注意一下这行代码:
1 | mux.Handle(pattern, HandlerFunc(handler)) |
可能有人认为HandlerFunc
是一个函数,包装了传入的handler
函数,返回了一个Handler
对象。然而这里HandlerFunc
实际上是将handler
函数做了一个类型转换,看一下HandlerFunc
的定义:
1 | type HandlerFunc func(ResponseWriter, *Request) |
HandlerFunc
是一个类型,只不过表示的是一个具有func(ResponseWriter, *Request)
签名的函数类型,并且这种类型实现了ServeHTTP
方法(在ServeHTTP
方法中又调用了自身),也就是说这个类型的函数其实就是一个Handler
类型的对象。利用这种类型转换,我们可以将一个handler
函数转换为一个Handler
对象,而不需要定义一个结构体,再让这个结构实现ServeHTTP
方法。读者可以体会一下这种技巧。
ServeMux
Golang中的路由(即Multiplexer
)基于ServeMux
结构,先看一下ServeMux
的定义:
1 | type ServeMux struct { |
这里重点关注ServeMux
中的字段m
,这是一个map
,key
是路由表达式,value
是一个muxEntry
结构,muxEntry
结构体存储了对应的路由表达式和handler
。
值得注意的是,ServeMux
也实现了ServeHTTP
方法:
1 | func (mux *ServeMux) ServeHTTP(w ResponseWriter, r *Request) { |
也就是说ServeMux
结构体也是Handler
对象,只不过ServeMux
的ServeHTTP
方法不是用来处理具体的request
和构建response
,而是用来确定路由注册的handler
。
注册路由
搞明白Handler
和ServeMux
之后,我们再回到之前的代码:1
DefaultServeMux.Handle(pattern, handler)
这里的DefaultServeMux
表示一个默认的Multiplexer
,当我们没有创建自定义的Multiplexer
,则会自动使用一个默认的Multiplexer
。
然后再看一下ServeMux
的Handle
方法具体做了什么:
1 | func (mux *ServeMux) Handle(pattern string, handler Handler) { |
Handle
方法主要做了两件事情:一个就是向ServeMux
的map[string]muxEntry
增加给定的路由匹配规则;然后如果路由表达式以'/'
结尾,则将对应的muxEntry
对象加入到[]muxEntry
中,按照路由表达式长度排序。前者很好理解,但后者可能不太容易看出来有什么作用,这个问题后面再作分析。
自定义ServeMux
我们也可以创建自定义的ServeMux
取代默认的DefaultServeMux
:
1 | package main |
NewServeMux()
可以创建一个ServeMux
实例,之前提到ServeMux
也实现了ServeHTTP
方法,因此mux
也是一个Handler
对象。对于ListenAndServe()
方法,如果传入的handler
参数是自定义ServeMux
实例mux
,那么Server
实例接收到的路由对象将不再是DefaultServeMux
而是mux
。
开启服务
首先从http.ListenAndServe
这个方法开始:
1 | func ListenAndServe(addr string, handler Handler) error { |
这里先创建了一个Server
对象,传入了地址和handler
参数,然后调用Server
对象ListenAndServe()
方法。
看一下Server
这个结构体,Server
结构体中字段比较多,可以先大致了解一下:1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24type Server struct {
Addr string // TCP address to listen on, ":http" if empty
Handler Handler // handler to invoke, http.DefaultServeMux if nil
TLSConfig *tls.Config
ReadTimeout time.Duration
ReadHeaderTimeout time.Duration
WriteTimeout time.Duration
IdleTimeout time.Duration
MaxHeaderBytes int
TLSNextProto map[string]func(*Server, *tls.Conn, Handler)
ConnState func(net.Conn, ConnState)
ErrorLog *log.Logger
disableKeepAlives int32 // accessed atomically.
inShutdown int32 // accessed atomically (non-zero means we're in Shutdown)
nextProtoOnce sync.Once // guards setupHTTP2_* init
nextProtoErr error // result of http2.ConfigureServer if used
mu sync.Mutex
listeners map[*net.Listener]struct{}
activeConn map[*conn]struct{}
doneChan chan struct{}
onShutdown []func()
}
在Server
的ListenAndServe
方法中,会初始化监听地址Addr
,同时调用Listen
方法设置监听。最后将监听的TCP对象传入Serve
方法:
1 | func (srv *Server) Serve(l net.Listener) error { |
这里隐去了一些细节,以便了解Serve
方法的主要逻辑。首先创建一个上下文对象,然后调用Listener
的Accept()
等待新的连接建立;一旦有新的连接建立,则调用Server
的newConn()
创建新的连接对象,并将连接的状态标志为StateNew
,然后开启一个新的goroutine
处理连接请求。
处理连接
我们继续探索conn
的serve()
方法,这个方法同样很长,我们同样只看关键逻辑。坚持一下,马上就要看见大海了。
1 | func (c *conn) serve(ctx context.Context) { |
当一个连接建立之后,该连接中所有的请求都将在这个协程中进行处理,直到连接被关闭。在serve()
方法中会循环调用readRequest()
方法读取下一个请求进行处理,其中最关键的逻辑就是一行代码:
1 | serverHandler{c.server}.ServeHTTP(w, w.req) |
进一步解释serverHandler
:
1 | type serverHandler struct { |
在serverHandler
的ServeHTTP()
方法里的sh.srv.Handler
其实就是我们最初在http.ListenAndServe()
中传入的Handler
对象,也就是我们自定义的ServeMux
对象。如果该Handler
对象为nil
,则会使用默认的DefaultServeMux
。最后调用ServeMux
的ServeHTTP()
方法匹配当前路由对应的handler
方法。
后面的逻辑就相对简单清晰了,主要在于调用ServeMux
的match
方法匹配到对应的已注册的路由表达式和handler
。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49// ServeHTTP dispatches the request to the handler whose
// pattern most closely matches the request URL.
func (mux *ServeMux) ServeHTTP(w ResponseWriter, r *Request) {
if r.RequestURI == "*" {
if r.ProtoAtLeast(1, 1) {
w.Header().Set("Connection", "close")
}
w.WriteHeader(StatusBadRequest)
return
}
h, _ := mux.Handler(r)
h.ServeHTTP(w, r)
}
func (mux *ServeMux) handler(host, path string) (h Handler, pattern string) {
mux.mu.RLock()
defer mux.mu.RUnlock()
// Host-specific pattern takes precedence over generic ones
if mux.hosts {
h, pattern = mux.match(host + path)
}
if h == nil {
h, pattern = mux.match(path)
}
if h == nil {
h, pattern = NotFoundHandler(), ""
}
return
}
// Find a handler on a handler map given a path string.
// Most-specific (longest) pattern wins.
func (mux *ServeMux) match(path string) (h Handler, pattern string) {
// Check for exact match first.
v, ok := mux.m[path]
if ok {
return v.h, v.pattern
}
// Check for longest valid match. mux.es contains all patterns
// that end in / sorted from longest to shortest.
for _, e := range mux.es {
if strings.HasPrefix(path, e.pattern) {
return e.h, e.pattern
}
}
return nil, ""
}
在match
方法里我们看到之前提到的map[string]muxEntry
和[]muxEntry
。这个方法里首先会利用进行精确匹配,在map[string]muxEntry
中查找是否有对应的路由规则存在;如果没有匹配的路由规则,则会进行近似匹配。
对于类似/path1/path2/path3
这样的路由,如果不能找到精确匹配的路由规则,那么则会去匹配和当前路由最接近的已注册的父路由,所以如果路由/path1/path2/
已注册,那么该路由会被匹配,否则继续匹配父路由,知道根路由/
。
由于[]muxEntry
中的muxEntry
按照路由表达是从长到短排序,所以进行近似匹配时匹配到的路由一定是已注册父路由中最接近的。
至此,Go实现的http server
的大致原理介绍完毕!
总结
Golang通过ServeMux
定义了一个多路器来管理路由,并通过Handler
接口定义了路由处理函数的统一规范,即Handler
都须实现ServeHTTP
方法;同时Handler
接口提供了强大的扩展性,方便开发者通过Handler
接口实现各种中间件。相信大家阅读下来也能感受到Handler
对象在server
服务的实现中真的无处不在。理解了server
实现的基本原理,大家就可以在此基础上阅读一些第三方的http server
框架,以及编写特定功能的中间件。
以上。