簡(jiǎn)易HTTP服務(wù)器的實(shí)現(xiàn)
先看一個(gè)使用net/http包實(shí)現(xiàn)的簡(jiǎn)單服務(wù)器程序示例。
package main
import (
"io"
"log"
"net/http"
)
type myHandler struct{}
func (*myHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "I'm home page")
}
func sayHello(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "hello world!")
}
func main() {
// 設(shè)置路由
http.Handle("/", &myHandler{})
http.HandleFunc("/hello", sayHello)
err := http.ListenAndServe(":8080", nil)
if err != nil {
log.Fatal(err)
}
}
運(yùn)行程序，打開瀏覽器，訪問http://localhost:8080，可以看到瀏覽器上顯示I'm home page，訪問http://localhost:8080/hello，可以看到hello world!。就是如此簡(jiǎn)單，但是程序背后做了哪些事呢？
分析
http.Handle主要是設(shè)置路由規(guī)則，先看它的具體實(shí)現(xiàn)吧：
// Handle registers the handler for the given pattern
// in the DefaultServeMux.
// The documentation for ServeMux explains how patterns are matched.
func Handle(pattern string, handler Handler) {
DefaultServeMux.Handle(pattern, handler)
}
可以看到兩個(gè)不認(rèn)識(shí)的東西，Handler和DefaultServeMux。繼續(xù)查看定義：
// Handler是一個(gè)接口
type Handler interface {
ServeHTTP(ResponseWriter, *Request)
}
// ServeMux是一個(gè)自定義類型
// ServeMux also takes care of sanitizing the URL request path,
// redirecting any request containing . or .. elements or repeated slashes
// to an equivalent, cleaner URL.
type ServeMux struct {
mu sync.RWMutex
m map[string]muxEntry //模式字符串與處理器的映射關(guān)系
hosts bool // whether any patterns contain hostnames
}
// muxEntry 是一個(gè)自定義類型，包括一個(gè)模式字符串和對(duì)應(yīng)的Handler接口
type muxEntry struct {
h Handler
pattern string
}
var defaultServeMux ServeMux
// DefaultServeMux is the default ServeMux used by Serve.
var DefaultServeMux = &defaultServeMux
DefaultServeMux是*ServeMux類型，指向defaultServeMux這個(gè)內(nèi)部變量。ServeMux結(jié)構(gòu)體的含義是路由器，它的成員m比較重要，存儲(chǔ)的是模式字符串與處理器的映射關(guān)系。*ServeMux實(shí)現(xiàn)了Handle函數(shù)，主要用途就是填充成員m的，具體代碼如下：
// Handle registers the handler for the given pattern.
// If a handler already exists for pattern, Handle panics.
func (mux *ServeMux) Handle(pattern string, handler Handler) {
mux.mu.Lock()
defer mux.mu.Unlock()
// 錯(cuò)誤判斷，模式字符串為空、處理起handler為空、對(duì)應(yīng)的模式字符串的處理器已經(jīng)存在
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)
}
// 如果沒有實(shí)例化，就make一下
if mux.m == nil {
mux.m = make(map[string]muxEntry)
}
mux.m[pattern] = muxEntry{h: handler, pattern: pattern}
if pattern[0] != '/' {
mux.hosts = true
}
}
可以看到前面有三個(gè)錯(cuò)誤判斷，這個(gè)不影響理解，重要的是mux.m[pattern] = muxEntry{h: handler, pattern: pattern}，將傳遞進(jìn)來的處理器handler和模式字符串pattern組合成muxEntry結(jié)構(gòu)體，使用map結(jié)構(gòu)綁定pattern和muxEntry之間的關(guān)系。
綜上所述，http.Handle干了什么呢？主要就是操作DefaultServeMux這個(gè)結(jié)構(gòu)體變量，填充它的成員m(map[string]muxEntry類型)，建立路由規(guī)則。通俗一點(diǎn)，就是為每個(gè)url模式串注冊(cè)了一個(gè)回調(diào)函數(shù)(go語言中稱之為處理器Handler)！
接下來的http.ListenAndServe函數(shù)，具體實(shí)現(xiàn)如下：
// ListenAndServe always returns a non-nil error.
func ListenAndServe(addr string, handler Handler) error {
server := &Server{Addr: addr, Handler: handler}
return server.ListenAndServe()
}
這一段代碼不追究細(xì)節(jié)還是很好理解的，第一個(gè)參數(shù)是端口號(hào)，第二個(gè)參數(shù)是具體的處理器(該示例中傳入nil)，這個(gè)函數(shù)就是先創(chuàng)建一個(gè)具體的Server對(duì)象，然后調(diào)用ListenAndServe()，不看具體實(shí)現(xiàn)，也能猜到，就是先listen(監(jiān)聽)，再建立一個(gè)事件循環(huán)，監(jiān)聽到了連接事件或者讀寫事件發(fā)生，就啟動(dòng)一個(gè)協(xié)程進(jìn)行處理。
問題是，傳遞進(jìn)去的handler的ServeHTTP方法再什么時(shí)候調(diào)用的呢？繼續(xù)翻源碼，server.ListenAndServe()主要分為兩個(gè)步驟，1.處理新連接，即調(diào)用Accpet函數(shù)。2.處理其他事件，代碼中主要體現(xiàn)在go c.serve(ctx)。而在c.serve函數(shù)中找到了這句話：serverHandler{c.server}.ServeHTTP(w, w.req)。serverHandler類型其實(shí)就是重新包裝了*Server類型，如下：
// serverHandler delegates to either the server's Handler or
// DefaultServeMux and also handles "OPTIONS *" requests.
type serverHandler struct {
srv *Server
}
func (sh serverHandler) ServeHTTP(rw ResponseWriter, req *Request) {
// 重點(diǎn)， 取出內(nèi)部的Handler接口變量
handler := sh.srv.Handler
// 如果是空，就是用默認(rèn)的Handler
if handler == nil {
handler = DefaultServeMux
}
if req.RequestURI == "*" && req.Method == "OPTIONS" {
handler = globalOptionsHandler{}
}
// 調(diào)用 ServeHTTP 方法！
handler.ServeHTTP(rw, req)
}
serverHandler的ServeHTTP方法中調(diào)用了它的成員Handler(最開始由你傳遞進(jìn)來的)的ServeHTTP方法（這就是你自定義的處理器實(shí)現(xiàn)的ServeHTTP的作用所在了）。本示例中的傳入的Handler是nil，所以最后使用的是DefaultServeMux的ServeHTTP方法，而DefaultServeMux是*ServeMux類型，它的ServeHTTP方法實(shí)現(xiàn)如下：
// 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)
}
// handler is the main implementation of Handler.
// The path is known to be in canonical form, except for CONNECT methods.
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
}
mux.Handler函數(shù)中調(diào)用了mux.match函數(shù)，mux.match函數(shù)主要是在mux.m這個(gè)之前注冊(cè)好的map(字典)中查找url的對(duì)應(yīng)處理器。根據(jù)之前定義的路由規(guī)則找到了對(duì)應(yīng)的處理器之后，就調(diào)用處理器的ServeHTTP方法。
所以，在訪問http://localhost:8080時(shí)，執(zhí)行的是myHandler自定義類型的ServeHTTP方法，返回瀏覽器I'm home page字符串，并在瀏覽器上顯示出來。
http.HandleFunc的用法和http.Handle一樣，但是第二個(gè)參數(shù)是func(ResponseWriter, *Request)這個(gè)函數(shù)類型而不是Handler接口，由上面的分析可知，ServeMux的成員m存儲(chǔ)要求是個(gè)Handler接口，那么傳入個(gè)函數(shù)怎么處理呢？見源碼：
// HandleFunc registers the handler function for the given pattern
// in the DefaultServeMux.
// The documentation for ServeMux explains how patterns are matched.
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)) {
mux.Handle(pattern, HandlerFunc(handler))
}
// The HandlerFunc type is an adapter to allow the use of
// ordinary functions as HTTP handlers. If f is a function
// with the appropriate signature, HandlerFunc(f) is a
// Handler that calls f.
type HandlerFunc func(ResponseWriter, *Request)
// ServeHTTP calls f(w, r).
func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request) {
f(w, r)
}
DefaultServeMux使用了HandleFunc方法，該方法將函數(shù)類型的handler強(qiáng)行轉(zhuǎn)換成了自定義類型HandlerFunc類型，該類型實(shí)現(xiàn)了Handler接口，也就使得傳入的函數(shù)也實(shí)現(xiàn)了Handler接口，在ServeHTTP方法中，直接調(diào)用自身代表的函數(shù)。很是巧妙！
這些就是net/http包背后默默幫你做的事情。
自定義路由器
下一個(gè)問題，如果不使用DefaultServeMux呢，能否自己定義一個(gè)ServeMux(路由器)？答案是可以的，將簡(jiǎn)單的HTTP服務(wù)器修改一下：
package main
import (
"io"
"log"
"net/http"
)
type myHandler struct{}
func (*myHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "I'm home page")
}
func sayHello(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "hello world")
}
func main() {
mux := http.NewServeMux() // new出一個(gè)新的ServeMux對(duì)象
mux.Handle("/", &myHandler{})
mux.HandleFunc("/hello", sayHello)
err := http.ListenAndServe(":8080", mux) //傳入自定義的路由器(mux)
if err != nil {
log.Fatal(err)
}
}
與文章開頭不同的地方在于，使用http.NewServeMux()創(chuàng)建了一個(gè)ServeMux對(duì)象，然后調(diào)用mux.Handle注冊(cè)路由，最后在http.ListenAndServe中傳入自定義的路由器。
更進(jìn)一步，能否不使用ServeMux結(jié)構(gòu)體呢？我們可以直接使用http.ListenAndServe中使用的Server結(jié)構(gòu)，并且自己處理路由分發(fā)(自己定義字典存儲(chǔ)路由規(guī)則)。
package main
import (
"io"
"log"
"net/http"
"time"
)
// 用字典實(shí)現(xiàn)路由器
var mux map[string]func(http.ResponseWriter, *http.Request)
// 自己實(shí)現(xiàn)的Handler
type myHandler struct{}
func (*myHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
// 根據(jù)url選擇對(duì)應(yīng)的處理函數(shù)
if h, ok := mux[r.URL.String()]; ok {
h(w, r)
return
}
io.WriteString(w, "sorry, error happened!")
}
func sayHello(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "hello world")
}
func sayHome(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "I'm home page")
}
func main() {
server := http.Server{
Addr: ":8080",
Handler: &myHandler{},
ReadTimeout: 5 * time.Second, //設(shè)置超時(shí)時(shí)間
}
mux = make(map[string]func(http.ResponseWriter, *http.Request))
mux["/"] = sayHome
mux["/hello"] = sayHello
err := server.ListenAndServe()
if err != nil {
log.Fatal(err)
}
}
