对于Golang来讲,实现一个简单的http server
很是容易,只须要短短几行代码。同时有了协程的加持,Go实现的http server
可以取得很是优秀的性能。这篇文章将会对go标准库net/http
实现http服务的原理进行较为深刻的探究,以此来学习了解网络编程的常见范式以及设计思路。html
基于HTTP构建的网络应用包括两个端,即客户端(Client
)和服务端(Server
)。两个端的交互行为包括从客户端发出request
、服务端接受request
进行处理并返回response
以及客户端处理response
。因此http服务器的工做就在于如何接受来自客户端的request
,并向客户端返回response
。golang
典型的http服务端的处理流程能够用下图表示:web
服务器在接收到请求时,首先会进入路由(router
),这是一个Multiplexer
,路由的工做在于为这个request
找到对应的处理器(handler
),处理器对request
进行处理,并构建response
。Golang实现的http server
一样遵循这样的处理流程。编程
咱们先看看Golang如何实现一个简单的http server
:浏览器
package main
import (
"fmt"
"net/http"
)
func indexHandler(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "hello world")
}
func main() {
http.HandleFunc("/", indexHandler)
http.ListenAndServe(":8000", nil)
}
复制代码
运行代码以后,在浏览器中打开localhost:8000
就能够看到hello world
。这段代码先利用http.HandleFunc
在根路由/
上注册了一个indexHandler
, 而后利用http.ListenAndServe
开启监听。当有请求过来时,则根据路由执行对应的handler
函数。服务器
咱们再来看一下另一种常见的http server
实现方式:网络
package main
import (
"fmt"
"net/http"
)
type indexHandler struct {
content string
}
func (ih *indexHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, ih.content)
}
func main() {
http.Handle("/", &indexHandler{content: "hello world!"})
http.ListenAndServe(":8001", nil)
}
复制代码
Go实现的http
服务步骤很是简单,首先注册路由,而后建立服务并开启监听便可。下文咱们将从注册路由、开启服务、处理请求这几个步骤了解Golang如何实现http
服务。app
http.HandleFunc
和http.Handle
都是用于注册路由,能够发现二者的区别在于第二个参数,前者是一个具备func(w http.ResponseWriter, r *http.Requests)
签名的函数,然后者是一个结构体,该结构体实现了func(w http.ResponseWriter, r *http.Requests)
签名的方法。http.HandleFunc
和http.Handle
的源码以下:框架
func 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))
}
复制代码
func Handle(pattern string, handler Handler) {
DefaultServeMux.Handle(pattern, handler)
}
复制代码
能够看到这两个函数最终都由DefaultServeMux
调用Handle
方法来完成路由的注册。
这里咱们遇到两种类型的对象:ServeMux
和Handler
,咱们先说Handler
。tcp
Handler
是一个接口:
type Handler interface {
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
的定义:
type HandlerFunc func(ResponseWriter, *Request)
// ServeHTTP calls f(w, r).
func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request) {
f(w, r)
}
复制代码
HandlerFunc
是一个类型,只不过表示的是一个具备func(ResponseWriter, *Request)
签名的函数类型,而且这种类型实现了ServeHTTP
方法(在ServeHTTP
方法中又调用了自身),也就是说这个类型的函数其实就是一个Handler
类型的对象。利用这种类型转换,咱们能够将一个handler
函数转换为一个Handler
对象,而不须要定义一个结构体,再让这个结构实现ServeHTTP
方法。读者能够体会一下这种技巧。
Golang中的路由(即Multiplexer
)基于ServeMux
结构,先看一下ServeMux
的定义:
type ServeMux struct {
mu sync.RWMutex
m map[string]muxEntry
es []muxEntry // slice of entries sorted from longest to shortest.
hosts bool // whether any patterns contain hostnames
}
type muxEntry struct {
h Handler
pattern string
}
复制代码
这里重点关注ServeMux
中的字段m
,这是一个map
,key
是路由表达式,value
是一个muxEntry
结构,muxEntry
结构体存储了对应的路由表达式和handler
。
值得注意的是,ServeMux
也实现了ServeHTTP
方法:
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)
}
复制代码
也就是说ServeMux
结构体也是Handler
对象,只不过ServeMux
的ServeHTTP
方法不是用来处理具体的request
和构建response
,而是用来肯定路由注册的handler
。
搞明白Handler
和ServeMux
以后,咱们再回到以前的代码:
DefaultServeMux.Handle(pattern, handler)
复制代码
这里的DefaultServeMux
表示一个默认的Multiplexer
,当咱们没有建立自定义的Multiplexer
,则会自动使用一个默认的Multiplexer
。
而后再看一下ServeMux
的Handle
方法具体作了什么:
func (mux *ServeMux) Handle(pattern string, handler Handler) {
mux.mu.Lock()
defer mux.mu.Unlock()
if pattern == "" {
panic("http: invalid pattern")
}
if handler == nil {
panic("http: nil handler")
}
if _, exist := mux.m[pattern]; exist {
panic("http: multiple registrations for " + pattern)
}
if mux.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中,按照路由表达式长度排序
if pattern[len(pattern)-1] == '/' {
mux.es = appendSorted(mux.es, e)
}
if pattern[0] != '/' {
mux.hosts = true
}
}
复制代码
Handle
方法主要作了两件事情:一个就是向ServeMux
的map[string]muxEntry
增长给定的路由匹配规则;而后若是路由表达式以'/'
结尾,则将对应的muxEntry
对象加入到[]muxEntry
中,按照路由表达式长度排序。前者很好理解,但后者可能不太容易看出来有什么做用,这个问题后面再做分析。
咱们也能够建立自定义的ServeMux
取代默认的DefaultServeMux
:
package main
import (
"fmt"
"net/http"
)
func indexHandler(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "hello world")
}
func htmlHandler(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/html")
html := `<!doctype html>
<META http-equiv="Content-Type" content="text/html" charset="utf-8">
<html lang="zh-CN">
<head>
<title>Golang</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0;" />
</head>
<body>
<div id="app">Welcome!</div>
</body>
</html>`
fmt.Fprintf(w, html)
}
func main() {
mux := http.NewServeMux()
mux.Handle("/", http.HandlerFunc(indexHandler))
mux.HandleFunc("/welcome", htmlHandler)
http.ListenAndServe(":8001", mux)
}
复制代码
NewServeMux()
能够建立一个ServeMux
实例,以前提到ServeMux
也实现了ServeHTTP
方法,所以mux
也是一个Handler
对象。对于ListenAndServe()
方法,若是传入的handler
参数是自定义ServeMux
实例mux
,那么Server
实例接收到的路由对象将再也不是DefaultServeMux
而是mux
。
首先从http.ListenAndServe
这个方法开始:
func ListenAndServe(addr string, handler Handler) error {
server := &Server{Addr: addr, Handler: handler}
return server.ListenAndServe()
}
func (srv *Server) ListenAndServe() error {
if srv.shuttingDown() {
return ErrServerClosed
}
addr := srv.Addr
if addr == "" {
addr = ":http"
}
ln, err := net.Listen("tcp", addr)
if err != nil {
return err
}
return srv.Serve(tcpKeepAliveListener{ln.(*net.TCPListener)})
}
复制代码
这里先建立了一个Server
对象,传入了地址和handler
参数,而后调用Server
对象ListenAndServe()
方法。
看一下Server
这个结构体,Server
结构体中字段比较多,能够先大体了解一下:
type 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
方法:
func (srv *Server) Serve(l net.Listener) error {
...
baseCtx := context.Background() // base is always background, per Issue 16220
ctx := context.WithValue(baseCtx, ServerContextKey, srv)
for {
rw, e := l.Accept() // 等待新的链接创建
...
c := srv.newConn(rw)
c.setState(c.rwc, StateNew) // before Serve can return
go c.serve(ctx) // 建立新的协程处理请求
}
}
复制代码
这里隐去了一些细节,以便了解Serve
方法的主要逻辑。首先建立一个上下文对象,而后调用Listener
的Accept()
等待新的链接创建;一旦有新的链接创建,则调用Server
的newConn()
建立新的链接对象,并将链接的状态标志为StateNew
,而后开启一个新的goroutine
处理链接请求。
咱们继续探索conn
的serve()
方法,这个方法一样很长,咱们一样只看关键逻辑。坚持一下,立刻就要看见大海了。
func (c *conn) serve(ctx context.Context) {
...
for {
w, err := c.readRequest(ctx)
if c.r.remain != c.server.initialReadLimitSize() {
// If we read any bytes off the wire, we're active.
c.setState(c.rwc, StateActive)
}
...
// HTTP cannot have multiple simultaneous active requests.[*]
// Until the server replies to this request, it can't read another,
// so we might as well run the handler in this goroutine.
// [*] Not strictly true: HTTP pipelining. We could let them all process
// in parallel even if their responses need to be serialized.
// But we're not going to implement HTTP pipelining because it
// was never deployed in the wild and the answer is HTTP/2.
serverHandler{c.server}.ServeHTTP(w, w.req)
w.cancelCtx()
if c.hijacked() {
return
}
w.finishRequest()
if !w.shouldReuseConnection() {
if w.requestBodyLimitHit || w.closedRequestBodyEarly() {
c.closeWriteAndWait()
}
return
}
c.setState(c.rwc, StateIdle) // 请求处理结束后,将链接状态置为空闲
c.curReq.Store((*response)(nil))// 将当前请求置为空
...
}
}
复制代码
当一个链接创建以后,该链接中全部的请求都将在这个协程中进行处理,直到链接被关闭。在serve()
方法中会循环调用readRequest()
方法读取下一个请求进行处理,其中最关键的逻辑就是一行代码:
serverHandler{c.server}.ServeHTTP(w, w.req)
复制代码
进一步解释serverHandler
:
type serverHandler struct {
srv *Server
}
func (sh serverHandler) ServeHTTP(rw ResponseWriter, req *Request) {
handler := sh.srv.Handler
if handler == nil {
handler = DefaultServeMux
}
if req.RequestURI == "*" && req.Method == "OPTIONS" {
handler = globalOptionsHandler{}
}
handler.ServeHTTP(rw, req)
}
复制代码
在serverHandler
的ServeHTTP()
方法里的sh.srv.Handler
其实就是咱们最初在http.ListenAndServe()
中传入的Handler
对象,也就是咱们自定义的ServeMux
对象。若是该Handler
对象为nil
,则会使用默认的DefaultServeMux
。最后调用ServeMux
的ServeHTTP()
方法匹配当前路由对应的handler
方法。
后面的逻辑就相对简单清晰了,主要在于调用ServeMux
的match
方法匹配到对应的已注册的路由表达式和handler
。
// 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
方法里咱们看到以前提到的mux的m
字段(类型为map[string]muxEntry
)和es
(类型为[]muxEntry
)。这个方法里首先会利用进行精确匹配,在map[string]muxEntry
中查找是否有对应的路由规则存在;若是没有匹配的路由规则,则会利用es
进行近似匹配。
以前提到在注册路由时会把以'/'
结尾的路由(可称为节点路由)加入到es
字段的[]muxEntry
中。对于相似/path1/path2/path3
这样的路由,若是不能找到精确匹配的路由规则,那么则会去匹配和当前路由最接近的已注册的父节点路由,因此若是路由/path1/path2/
已注册,那么该路由会被匹配,不然继续匹配下一个父节点路由,直到根路由/
。
因为[]muxEntry
中的muxEntry
按照路由表达式从长到短排序,因此进行近似匹配时匹配到的节点路由必定是已注册父节点路由中最相近的。
至此,Go实现的http server
的大体原理介绍完毕!
Golang经过ServeMux
定义了一个多路器来管理路由,并经过Handler
接口定义了路由处理函数的统一规范,即Handler
都须实现ServeHTTP
方法;同时Handler
接口提供了强大的扩展性,方便开发者经过Handler
接口实现各类中间件。相信你们阅读下来也能感觉到Handler
对象在server
服务的实现中真的无处不在。理解了server
实现的基本原理,你们就能够在此基础上阅读一些第三方的http server
框架,以及编写特定功能的中间件。
以上。