http ww

HTTP路由器）負(fù)責(zé)偵聽HTTP請求并根據(jù)匹配條件（例如HTTP方法或URL）調(diào)用適當(dāng)?shù)奶幚沓绦颉?/p>

Golang提供了一個非常簡單的路由器ServeMux。但它太基礎(chǔ)簡單，所以大家一般都會選擇第三方路由模塊，比如gorilla/mux。

今天我們來學(xué)習(xí)下如何從零自己構(gòu)建一個HTTP路由。

概述

一個HTTP路由器主要負(fù)責(zé)以下幾件事：

404處理程序：為不匹配的請求提供404響應(yīng)

匹配：匹配URL路徑和HTTP方法并調(diào)用路由處理程序

參數(shù)：提取動態(tài)網(wǎng)址參數(shù)，例如/users/(?Pd )

緊急恢復(fù)：趕上緊急情況并回復(fù)500

下面是一個代碼片段，展示了上述的所有功能：

r := NewRouter()r.Route("GET", "/", homeRoute)r.Route("POST", "/users", createUserRoute)r.Route("GET", "/users/(?Pd )", getUserRoute)r.Route("GET", "/panic", panicRoute)http.ListenAndServe("localhost:8000", r)基本路由

首先，我們構(gòu)建一個路由，該路由負(fù)責(zé)響應(yīng)無效請求，并返回404響應(yīng)。

路由器處理進(jìn)入Web服務(wù)器的每個HTTP請求，可以通過將其傳遞到Golang的http.ListenAndServe方法中來完成。ListenAndServe的第二個參數(shù)是http.Handler，它負(fù)責(zé)處理每個傳入的請求。為了實(shí)現(xiàn)這一點(diǎn)，我們的路由器將需要實(shí)現(xiàn)該Handler接口。

Handler只聲明一個方法，ServeHTTP所以我們創(chuàng)建一個結(jié)構(gòu)來匹配它。

type Router struct {}func (sr *Router) ServeHTTP(w http.ResponseWriter, r *http.Request) {http.NotFound(w, r)}

這樣就有一種可以在任何http.Handler接受的地方使用的路由類型。把加入到可運(yùn)行的程序中httper.go。

package httperimport "net/http"func main() {r := &Router{}http.ListenAndServe(":8000", r)}type Router struct{}func (sr *Router) ServeHTTP(w http.ResponseWriter, r *http.Request) {http.NotFound(w, r)

從命令行運(yùn)行該程序go run httper.go，然后就可以通過Web瀏覽器中打開127.0.0.1:8000，驗(yàn)證其是否響應(yīng)"404頁面未找到"。

路由匹配

一個總是返回404請求的路由并什么太多用處。我們繼續(xù)修改路由以便可以匹配的列表。

對于每個傳入請求，需要執(zhí)行以下操作：

從請求中提取HTTP方法和URL路徑；

檢查是否存在與方法和路徑匹配的路由；

匹配時調(diào)用它；

如果找不到匹配項(xiàng)，則返回404。

為此，為每條路由需要保存這些信息：路由的HTTP方法，路由的路徑以及如果找到匹配項(xiàng)，則調(diào)用的處理函數(shù)。我們創(chuàng)建一個結(jié)構(gòu)RouteEntry來將存儲在他們。

type RouteEntry struct {Path stringMethod stringHandler http.HandlerFunc}

還需要更新Router以存儲的列表RouteEntry。為了改善使用路由的體驗(yàn)，我們添加一個名為helper的輔助功能Route來完成這項(xiàng)工作。路由功能將創(chuàng)建一個新路由RouteEntry并將其添加到路由列表中。

type RouteEntry struct {Path stringMethod stringHandler http.HandlerFunc}type Router struct {routes []RouteEntry}func (rtr *Router) Route(method, path string, handlerFunc http.HandlerFunc) {e := RouteEntry{Method: method,Path: path,HandlerFunc: handlerFunc,}rtr.routes = append(rtr.routes, e)}

最后，編寫邏輯以檢查傳入的請求并找到匹配的路由。

匹配邏輯有兩個明顯的地方：Router本身還是RouteEntry。這些位置中的任何一個都可以使用，但是使用RouteEntry匹配負(fù)責(zé)是明智的，因?yàn)樗鎯α艘ヅ涞臈l件。

我們給RouteEntry結(jié)構(gòu)添加一個Match方法。由于基于請求的信息進(jìn)行匹配，因此將request作為參數(shù)。為了表明匹配成功，將讓它返回一個布爾值。

func (re *RouteEntry) Match(r *http.Request) bool {if r.Method != re.Method {return false }if r.URL.Path != re.Path {return false }

return true

}

現(xiàn)在，路由器所需要做的就是遍歷所有路由，并檢查其中是否有匹配請求。

func (rtr *Router) ServeHTTP(w http.ResponseWriter, r *http.Request) {for _, e := range rtr.routes {match := e.Match(r)if !match {continue}e.HandlerFunc.ServeHTTP(w, r)return}http.NotFound(w, r)}

為了確保所有操作都能正常進(jìn)行，新添加一條簡單的路由來處理。

r := &Router{}r.Route("GET", "/", func(w http.ResponseWriter, r *http.Request) {w.Write([]byte("Hello，Chongchong!"))})

當(dāng)加入這些代碼，然后go run httper.go?？梢酝ㄟ^瀏覽器訪問127.0.0.1:8000/來驗(yàn)證其是否有效。應(yīng)該看到它以"Hello，Chongchong!"回應(yīng)。任何其路徑會返回404響應(yīng)。

提取路由參數(shù)

現(xiàn)在，有了一個基本實(shí)用的HTTP路由器。我們進(jìn)一步添加功能充實(shí)它。常用的系統(tǒng)處理API中都會涉及增刪改查（CRUD）的動態(tài)參數(shù)的定義的路由。例如，URL通過ID獲取用戶的路由，可能的路徑為/users/10 ，其中10為用戶ID。在當(dāng)前的路由器中，如果一個一個的為每個可能的用戶ID都定義一個路由顯然是冗雜和不必要的。實(shí)際上需要的是一種定義帶有動態(tài)路徑的方法/users/?。

為了執(zhí)行動態(tài)匹配，需要使用利器——正則表達(dá)式。

訪問參數(shù)

不過，在深入探討正則表達(dá)式之前，先討論一下路由處理程序?qū)⑷绾卧L問提取的參數(shù)。一個fetchUserRoute將需要能夠從URL中提取ID來獲取正確的用戶。

幸運(yùn)的是，Golang提供了一種機(jī)制，可以將短暫的數(shù)據(jù)存儲在稱為context的請求對象上。用這種機(jī)制，路由器可以將參數(shù)添加到請求上下文中，以供處理程序在調(diào)用時讀取。

下面是處理程序如何訪問參數(shù)的示例。注意，由于訪問請求上下文中的內(nèi)容有點(diǎn)麻煩，因此又創(chuàng)建一個了輔助函數(shù)來減少重復(fù)。

r.Route("GET", `/hello/(?Pw )`, func(w http.ResponseWriter, r *http.Request) {message := URLParam(r, "Message")w.Write([]byte("Hello " message))})func URLParam(r *http.Request, name string) string {ctx := r.Context()params := ctx.Value("params").(map[string]string)return params[name]}用正則匹配

將把參數(shù)存儲在中map[string]string，其中映射中的每個鍵都是參數(shù)名稱，而值是從URL中提取的值。正則表達(dá)式已命名了適合此用例的組。在Golang中，可以使用FindStringSubmatch方法匹配這些命名組。

r := regexp.MustCompile(`/books/(?Pd )/(?Pd )`,)match := r.FindStringSubmatch("/books/123/456")if match == nil {return}fmt.Println(match) // [123, 456]fmt.Println(r.SubexpNames()) // [AuthorID, BookID]保存網(wǎng)址參數(shù)

知道如何匹配正則表達(dá)式組，我們將可以更新RouteEntry結(jié)構(gòu)的匹配邏輯以使用它們。為此，需要將Path屬性從字符串更改為Regexp類型。然后，需要更新Match方法邏輯。

type RouteEntry struct {Path *regexp.RegexpMethod stringHandlerFunc http.HandlerFunc}func (ent *RouteEntry) Match(r *http.Request) map[string]string {match := ent.Path.FindStringSubmatch(r.URL.Path)if match == nil {return nil }params := make(map[string]string)groupNames := ent.Path.SubexpNames()for i, group := range match {params[groupNames[i]] = group}return params}

注意，上面還更改了的簽名Match以返回參數(shù)映射，而非布爾值。

最后需要做的一件事是更新路由器邏輯，以在找到匹配項(xiàng)后將參數(shù)添加到請求上下文中。

for _, e := range rtr.routes {params := e.Match(r)if params == nil {continue }ctx := context.WithValue(r.Context(), "params", params)e.HandlerFunc.ServeHTTP(w, r.WithContext(ctx))return}

我們在程序中添加這些部分，然后測試：

Panic恢復(fù)

添加動態(tài)URL參數(shù)極大地提高了路由器的實(shí)用性?，F(xiàn)在可以將其在一些項(xiàng)目中使用。為了防止生產(chǎn)中發(fā)生壞事，應(yīng)該增加另外一件事，那就是緊急恢復(fù)。

當(dāng)前，如果路由處理程序之一出現(xiàn)緊急情況，服務(wù)器將返回一個空響應(yīng)，而不是默認(rèn)頁面。將添加以下幾行代碼來捕獲這些緊急情況并返回適當(dāng)?shù)?00（內(nèi)部服務(wù)器錯誤）狀態(tài)代碼。

func (rtr *Router) ServeHTTP(w http.ResponseWriter, r *http.Request) {defer func() {if r := recover(); r != nil {log.Println("ERROR:", r) http.Error(w, "發(fā)生錯誤…", http.StatusInternalServerError)}}()// ...}

為了測試它是否有效，我們添加一條特殊的/panic路由來觸發(fā)該恢復(fù)邏輯。

r.Route("GET", "/panic", func(w http.ResponseWriter, r *http.Request) {panic("something bad happened!")})

測試訪問 127.0.0.1:8000/panic，就會返回 Uh oh!

總結(jié)

本我們實(shí)例介紹了如何使用Golang語言的標(biāo)準(zhǔn)庫，從頭開始構(gòu)建一個路由器，當(dāng)然我們構(gòu)建的路由器僅僅為HTTP路由原理說明、練手和好玩，不建議在生產(chǎn)環(huán)境使用！在生產(chǎn)中使用建議使用成熟的類庫，比如gorilla/mux。