譯者 | 劉汪洋
Go 的標(biāo)準(zhǔn)庫(kù)中包含一個(gè)穩(wěn)定且成熟的 HTTP 服務(wù)器。然而,內(nèi)置的請(qǐng)求路由器http.ServeMux 功能較為簡(jiǎn)潔,因此你常常需要自己編寫路由代碼。
其主要短板是,它并未支持 HTTP 方法的匹配(如GET和POST的區(qū)別),同時(shí)也無(wú)法持/users/{user}/settings這種類型的通配符路徑。然而,這兩個(gè)功能幾乎是所有 REST 風(fēng)格的 API 服務(wù)器所必需的。
當(dāng)然,你可以選擇自行實(shí)現(xiàn)這些功能。在我以前的一篇文章 Go 中不同的 HTTP 路由方法中,提到過(guò)有一些優(yōu)秀的第三方包可以實(shí)現(xiàn)更高級(jí)的路由功能,并且只需 約 30 行代碼 就能夠在不借助任何第三方庫(kù)的情況下實(shí)現(xiàn)類似的功能。
但是,未來(lái)可能不再需要這些替代方案和第三方包,F(xiàn)在有一個(gè) 活躍的提案 - 還包括一個(gè)旨在改進(jìn) ServeMux 參考實(shí)現(xiàn) ,使其能夠匹配 HTTP 方法和通配符路徑。
Google 的 Go 團(tuán)隊(duì)成員 Jonathan Amsterdam 主導(dǎo)了這個(gè)提案以及之前的 討論。Jonathan 曾成功提出將結(jié)構(gòu)化日志添加到標(biāo)準(zhǔn)庫(kù)的提案 - Go 1.21 將包含他的log/slog包(預(yù)計(jì) 2023 年 8 月發(fā)布)。
現(xiàn)狀與變革
在目前的情況下,如果想將 GET 請(qǐng)求匹配到 /users/{user}/settings,你需要編寫以下的樣板代碼(盡管在實(shí)踐中你可能會(huì)使用第三方庫(kù)):
復(fù)制
mux.HandleFunc("/users/", func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
return
}
remainder := r.URL.Path[len("/users/"):]
userId, subPath, _ := strings.Cut(remainder, "/")
switch subPath {
case "settings":
fmt.Fprintf(w, "user %s", userId)
// 其他子路徑可以在這里添加
default:
http.NotFound(w, r)
}
})
如果接受了這個(gè)提議,你可以更加簡(jiǎn)單地實(shí)現(xiàn)一樣的功能:
復(fù)制
mux.HandleFunc("GET /users/{user}/settings", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "user %s", r.PathValue("user"))
})
這樣的寫法明顯更為簡(jiǎn)潔!
這與其他流行路由器使用的語(yǔ)法非常相似:
復(fù)制
// github.com/go-chi/chi
router.Get("/users/{user}/settings", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "user %s", chi.URLParam(r, "slug"))
})
// github.com/gorilla/mux
router.HandleFunc("/users/{user}/settings", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "user %s", mux.Vars(r)["user"])
}).Methods("GET")
// github.com/bmizerany/pat
router.Get("/users/:user/settings", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "user %s", r.URL.Query().Get(":user"))
}))
// github.com/gin-gonic/gin
router.GET("/users/:user/settings", func(c *gin.Context) {
fmt.Fprintf(w, "user %s", c.Param("user"))
})
提案中的一個(gè)有趣決定是,并沒(méi)有為 ServeMux 添加新的方法;而是對(duì)現(xiàn)有的 Handle 和 HandleFunc 方法進(jìn)行了擴(kuò)展,以支持方法前綴和 {wildcard} 路徑段。
我理解他們避免添加新方法的想法,但我對(duì)這個(gè)決定持保留態(tài)度。遺憾的是,舊版的 ServeMux 接受如 Handle("GET /foo", h) 的模式。這意味著為增強(qiáng)版 ServeMux 編寫的代碼將在舊版 Go 上能正常編譯和運(yùn)行,但路由不會(huì)匹配到任何內(nèi)容,這容易導(dǎo)致錯(cuò)誤。我可能會(huì)添加新的方法,比如 HandleMatch / HandleMatchFunc 或 Route / RouteFunc。
該提議也詳細(xì)描述了處理兩個(gè)重疊模式的優(yōu)先級(jí),其核心規(guī)則簡(jiǎn)單明了:“如果兩個(gè)模式有重疊(有共同的請(qǐng)求),則更具體的模式優(yōu)先匹配”。
例如,如果你注冊(cè)了模式 /users/(匹配 /users/*)以及模式 /users/{user},當(dāng)一個(gè) /users/ben 的請(qǐng)求進(jìn)來(lái)時(shí),它將匹配第二個(gè),更具體的模式。這與現(xiàn)有的 ServeMux 中,特定主機(jī)的模式優(yōu)先于沒(méi)有主機(jī)名的模式的行為一致。
URL 末尾通配符匹配
此提案為我們帶來(lái)了一個(gè)新的"特殊通配符" {$},它專門用于匹配 URL 的末尾。對(duì)于那些僅希望匹配主頁(yè)路由的情況,這個(gè)新特性顯得非常實(shí)用。在此之前,要實(shí)現(xiàn)這一目標(biāo)頗為麻煩,因?yàn)橐?/ 結(jié)尾的模式會(huì)匹配所有 / 之下的內(nèi)容;這個(gè)規(guī)則對(duì)于只有 / 的模式同樣適用。
因此,以前若想匹配主頁(yè),你需要這樣操作:
復(fù)制
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/" { // 確保路徑就是 "/"
http.NotFound(w, r)
return
}
serveHomepage(w, r)
})
mux.HandleFunc("/users", serveUsers)
這一過(guò)程頗為繁瑣。若你忘記了路徑檢查,那么你最終可能會(huì)將主頁(yè)用于所有其他的 URL,而不是顯示一個(gè)未找到的頁(yè)面,因?yàn)樗械膬?nèi)容都在 / 之下。
而根據(jù)新的提案,這個(gè)過(guò)程將變得更加簡(jiǎn)潔:
復(fù)制
mux.HandleFunc("/{$}", serveHomepage)
mux.HandleFunc("/users", serveUsers)
實(shí)現(xiàn)參考
Jonathan 在 github.com/jba/muxpatterns 中發(fā)布了一個(gè) ServeMux 的增強(qiáng)版本的示例實(shí)現(xiàn)。唯一的區(qū)別在于,由于它是在單獨(dú)的包中,無(wú)法改變 http.Request 類型, 所以你需要用 mux.PathValue(request, "name") 來(lái)獲取路徑值,而非 request.PathValue("name")。
我在 我的 go-routing 倉(cāng)庫(kù) 中添加了一個(gè) PR,這個(gè) PR 提供了我自己的 widget API 的一種實(shí)現(xiàn),使用 muxpatterns。這個(gè)版本與 chi 版本 非常相似 —— 清晰且易讀:
復(fù)制
r.HandleFunc("GET /{$}", home)
r.HandleFunc("GET /contact", contact)
r.HandleFunc("GET /api/widgets", apiGetWidgets)
r.HandleFunc("POST /api/widgets", apiCreateWidget)
r.HandleFunc("POST /api/widgets/{slug}", apiUpdateWidget)
r.HandleFunc("POST /api/widgets/{slug}/parts", apiCreateWidgetPart)
r.HandleFunc("POST /api/widgets/{slug}/parts/{id}/update", apiUpdateWidgetPart)
r.HandleFunc("POST /api/widgets/{slug}/parts/{id}/delete", apiDeleteWidgetPart)
r.HandleFunc("GET /{slug}", widgetGet)
r.HandleFunc("GET /{slug}/admin", widgetAdmin)
r.HandleFunc("POST /{slug}/image", widgetImage)
當(dāng)我首次測(cè)試這個(gè)參考實(shí)現(xiàn)時(shí),我發(fā)現(xiàn)了一些小問(wèn)題,現(xiàn)已得到修復(fù)。
結(jié)論
盡管我對(duì)于擴(kuò)展現(xiàn)有的 Handle 和 HandleFunc 方法有一些保留,但我對(duì)這個(gè)提案的考慮感到欣慰。鑒于 Jonathan 在提案中的謹(jǐn)慎處理、他在 log/slog 上的良好表現(xiàn)以及社區(qū)的積極反饋,此提案被接受的可能性很高。
如果這個(gè)功能能進(jìn)入標(biāo)準(zhǔn)庫(kù),那將非常棒 —— 我開發(fā)的幾乎所有網(wǎng)站和 REST 風(fēng)格的 API 都將用到這個(gè)功能。Go 的標(biāo)準(zhǔn)庫(kù)已經(jīng)非常強(qiáng)大,但加入這個(gè)功能將進(jìn)一步減少對(duì)第三方路由器的依賴。
如果這個(gè)功能能夠集成在 2024 年 2 月發(fā)布的 Go 1.22 中,我并不會(huì)感到驚訝。讓我們拭目以待!
譯者介紹
劉汪洋,51CTO社區(qū)編輯,昵稱:明明如月,一個(gè)擁有 5 年開發(fā)經(jīng)驗(yàn)的某大廠高級(jí) Java 工程師,擁有多個(gè)主流技術(shù)博客平臺(tái)博客專家稱號(hào)。
文章內(nèi)容僅供閱讀,不構(gòu)成投資建議,請(qǐng)謹(jǐn)慎對(duì)待。投資者據(jù)此操作,風(fēng)險(xiǎn)自擔(dān)。
近日,德國(guó)柏林國(guó)際電子消費(fèi)品展覽會(huì)(IFA2024)隆重舉辦。憑借在核心技術(shù)、產(chǎn)品設(shè)計(jì)及應(yīng)用方面的創(chuàng)新變革,全球領(lǐng)先的智能終端企業(yè)TCL實(shí)業(yè)成功斬獲兩項(xiàng)“IFA全球產(chǎn)品設(shè)計(jì)創(chuàng)新大獎(jiǎng)”金獎(jiǎng),有力證明了其在全球市場(chǎng)的強(qiáng)大影響力。
近日,中國(guó)家電及消費(fèi)電子博覽會(huì)(AWE 2024)隆重開幕。全球領(lǐng)先的智能終端企業(yè)TCL實(shí)業(yè)攜多款創(chuàng)新技術(shù)和新品亮相,以敢為精神勇闖技術(shù)無(wú)人區(qū),斬獲四項(xiàng)AWE 2024艾普蘭大獎(jiǎng)。
“以前都要去窗口辦,一套流程下來(lái)都要半個(gè)月了,現(xiàn)在方便多了!”打開“重慶公積金”微信小程序,按照提示流程提交相關(guān)材料,僅幾秒鐘,重慶市民曾某的賬戶就打進(jìn)了21600元。
由世界人工智能大會(huì)組委會(huì)、上海市經(jīng)信委、徐匯區(qū)政府、臨港新片區(qū)管委會(huì)共同指導(dǎo),由上海市人工智能行業(yè)協(xié)會(huì)聯(lián)合上海人工智能實(shí)驗(yàn)室、上海臨港經(jīng)濟(jì)發(fā)展(集團(tuán))有限公司、開放原子開源基金會(huì)主辦的“2024全球開發(fā)者先鋒大會(huì)”,將于2024年3月23日至24日舉辦。