來看看 http 自帶的路由功能摆尝。
閱讀前留幾個問題
- 如果要自己實現(xiàn)路由，該怎么做逻恐？
- 默認(rèn)路由的結(jié)構(gòu)像吻，搜索方式是什么？
例子
我們經(jīng)常在示例中看到如下兩種寫法复隆，示例來自于 stackoverflow
// 使用 DefaultServeMux
func main() {
http.HandleFunc("/page2", Page2)
http.HandleFunc("/", Index)
http.ListenAndServe(":3000", nil)
}
// 使用 ServeMux 路由
func main() {
mux := http.NewServeMux()
mux.HandleFunc("/page2", Page2)
mux.HandleFunc("/", Index)
http.ListenAndServe(":3000", mux)
}
其實通過代碼就可以發(fā)現(xiàn)拨匆，http 包直接調(diào)用 HandleFunc 使用的是DefaultServeMux，我們可以看到最后調(diào)用 ListenAndServe挽拂，后面一個參數(shù)傳遞的是 nil惭每，會讓 server 使用 DefaultServeMux，通過分析代碼可以知道亏栈，DefaultServeMux 和 ServeMux的結(jié)構(gòu)台腥，path解析都是一樣的。唯一的區(qū)別在于下面绒北，
// DefaultServeMux is the default ServeMux used by Serve.
var DefaultServeMux = &defaultServeMux
可以看到這個 DefaultServeMux 是一個全局變量黎侈，那么意味這有安全風(fēng)險，任何其他的第三方包都可以添加路由闷游。這個存在的意義據(jù)介紹是為了一些自定義功能峻汉，我們大部分場景都可以不使用這個方法贴汪。那么從這里可以看出，如果我們要實現(xiàn)一個路由休吠，得滿足下面的接口扳埂。然后傳遞到 ListenAndServe 函數(shù)的第二個參數(shù)就行了。
type Handler interface {
ServeHTTP(ResponseWriter, *Request)
}
結(jié)構(gòu)介紹
type ServeMux struct {
mu sync.RWMutex
m map[string]muxEntry
hosts bool // hostname 路由
}
type muxEntry struct {
explicit bool // 是否注冊過
h Handler // 處理函數(shù)
pattern string // 路由 path 和 key 一致
}
看到上面的結(jié)構(gòu)蛛碌，可以知道路由的節(jié)點是使用 hash 存儲的聂喇，key 為路由 path，value 為節(jié)點蔚携，其結(jié)構(gòu)為 muxEntry希太。
路由注冊
我們直接看路由注冊部分的代碼。
// Handle 為給定路由 path 注冊 handler酝蜒。
// 如果該路由 path 的 handler 已存在會在編譯時 panic誊辉。即 mux.m[pattern].explicit
func (mux *ServeMux) Handle(pattern string, handler Handler) {
mux.mu.Lock()
defer mux.mu.Unlock()
if pattern == "" {
panic("http: invalid pattern " + pattern)
}
if handler == nil {
panic("http: nil handler")
}
if mux.m[pattern].explicit {
panic("http: multiple registrations for " + pattern)
}
if mux.m == nil {
mux.m = make(map[string]muxEntry)
}
mux.m[pattern] = muxEntry{explicit: true, h: handler, pattern: pattern}
if pattern[0] != '/' {
mux.hosts = true
}
// 如果 pattern 是 /tree/，則為 /tree 插入隱式永久重定向亡脑。
// 這個規(guī)則可以被覆蓋堕澄。
n := len(pattern)
if n > 0 && pattern[n-1] == '/' && !mux.m[pattern[0:n-1]].explicit {
// If pattern contains a host name, strip it and use remaining
// path for redirect.
path := pattern
if pattern[0] != '/' {
// In pattern, at least the last character is a '/', so
// strings.Index can't be -1.
path = pattern[strings.Index(pattern, "/"):]
}
url := &url.URL{Path: path}
mux.m[pattern[0:n-1]] = muxEntry{h: RedirectHandler(url.String(), StatusMovedPermanently), pattern: pattern}
}
}
從代碼可以了解到，其實就是把路由信息放在了 hash 結(jié)構(gòu)里霉咨，最后對 /tree 這種方式做了一些小優(yōu)化蛙紫，使它重定向到 /tree/。
路由查找
從請求分析路徑可以知到路由的查找源頭途戒，如下
// ServeHTTP 調(diào)度請求給已注冊模式最匹配 URL 的 handler
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)
}
再往下找坑傅，我們可以知道最終的匹配規(guī)則，
// 通過給定的 path 從 handler hash 結(jié)構(gòu)中查找 handler
// 最長模式優(yōu)先
func (mux *ServeMux) match(path string) (h Handler, pattern string) {
var n = 0
// 遍歷
for k, v := range mux.m {
if !pathMatch(k, path) {
continue
}
// len(k) > n 即還能找到更長的 pattern喷斋，滿足最長模式優(yōu)先
if h == nil || len(k) > n {
n = len(k)
// 返回 handler
h = v.h
pattern = v.pattern
}
}
return
}
// 匹配
func pathMatch(pattern, path string) bool {
if len(pattern) == 0 {
// should not happen
return false
}
n := len(pattern)
if pattern[n-1] != '/' {
return pattern == path
}
// 是否匹配唁毒，mux 的 key（pattern）和給定的 path比較，按照最長原則
return len(path) >= n && path[0:n] == pattern
}
回顧問題
如果要自己實現(xiàn)路由星爪，該怎么做浆西？
我們得實現(xiàn) Handler 接口，即實現(xiàn)簽名為ServeHTTP(ResponseWriter, *Request)的方法顽腾。默認(rèn)路由的結(jié)構(gòu)近零，搜索方式是什么？
默認(rèn)路由用的ServeMux結(jié)構(gòu)崔泵，用 hash 存儲了 path 和 handler秒赤。查找的時候會遍歷這個 hash 結(jié)構(gòu)，采用最長匹配的原則去查找 handler憎瘸，當(dāng)出現(xiàn) /tree/ 和 /tree/sub/ 同時注冊時，/tree/sub/ 會用 /tree/sub/ 注冊的 handler 而不是 /tree/ 注冊的 handler陈瘦。同時幌甘，當(dāng) /tree/ 沒有子路由注冊時， /tree/ 的 handler 會匹配所有 /tree/sub/ 等這種子路由，一定程度滿足了 * 這樣的匹配模式锅风。
