Go語言Handler詳細說明
Multiplexer根據(jù)URL將請求路由給指定的Handler。Handler用于處理請求并給予響應(yīng)。更嚴格地說,用來讀取請求體、并將請求對應(yīng)的響應(yīng)字段(respones header)寫入ResponseWriter中,然后返回。
什么是Handler
什么是Handler。它是一個接口,定義在net/http/server.go中:
type Handler interface { ServeHTTP(ResponseWriter, *Request) }
也就是說,實現(xiàn)了ServerHTTP方法的都是Handler。注意ServerHTTP方法的參數(shù):http.ResponesWriter接口和Request指針。
在Handler的注釋中,給出了幾點主要的說明:
- Handler用于響應(yīng)一個HTTP request
- 接口方法ServerHTTP應(yīng)該用來將response header和需要響應(yīng)的數(shù)據(jù)寫入到ResponseWriter中,然后返回。返回意味著這個請求已經(jīng)處理結(jié)束,不能再使用這個ResponseWriter、不能再從Request.Body中讀取數(shù)據(jù),不能并發(fā)調(diào)用已完成的ServerHTTP方法
- handler應(yīng)該先讀取Request.Body,然后再寫ResponseWriter。只要開始向ResponseWriter寫數(shù)據(jù)后,就不能再從Request.Body中讀取數(shù)據(jù)
- handler只能用來讀取request的body,不能修改已取得的Request(因為它的參數(shù)Request是指針類型的)
ResponseWriter接口說明
再看看ResponseWriter接口的定義:
// A ResponseWriter interface is used by an HTTP handler to // construct an HTTP response. // // A ResponseWriter may not be used after the Handler.ServeHTTP method // has returned. type ResponseWriter interface { Header() Header Write([]byte) (int, error) WriteHeader(statusCode int) }
注釋中已經(jīng)說明,ResponseWriter接口的作用是用于構(gòu)造HTTP response。且明確指定了Handler.ServerHTTP方法返回以后就不能再使用ResponseWriter了。
這個接口有3個方法:
- Header()方法用來構(gòu)造響應(yīng)Header,它返回一個Header對象,這個Header對象稍后將被WriterHeader()響應(yīng)出去。Header類型是一個map類型的結(jié)構(gòu),字段名為key、字段值為value:
type Header map[string][]string
- Write()方法用于向網(wǎng)絡(luò)連接中寫響應(yīng)數(shù)據(jù)。
- WriteHeader()方法將給定的響應(yīng)狀態(tài)碼和響應(yīng)Header一起發(fā)送出去。
很顯然,ResponseWriter的作用是構(gòu)造響應(yīng)header,并將響應(yīng)header和響應(yīng)數(shù)據(jù)通過網(wǎng)絡(luò)鏈接發(fā)送給客戶端。
再看ListenAndServe()
在啟動go http自帶的web服務(wù)時,調(diào)用了函數(shù)ListenAndServe()。這個函數(shù)的定義如下:
func ListenAndServe(addr string, handler Handler) error
該函數(shù)有兩個參數(shù),第一個參數(shù)是自帶的web監(jiān)聽地址和端口,第二個參數(shù)是Handler,用來處理每個接進來的http request,但一般第二個參數(shù)設(shè)置為nil,表示調(diào)用默認的Multiplexer:DefaultServeMux。這個默認的ServeMux唯一的作用,是將請求根據(jù)URL路由給對應(yīng)的handler進行處理。
var DefaultServeMux = &defaultServeMux
這里有兩個問題:
- (1).第二個參數(shù)為什么建議設(shè)置為nil
- (2).設(shè)置為nil后,DefaultServeMux是請求的路由器,它為什么可以充當一個handler
先看第二個問題,很簡單,因為ServeMux類型定義了ServeHTTP()方法,它實現(xiàn)了Handler接口:
type ServeMux struct { // Has unexported fields. } func NewServeMux() *ServeMux func (mux *ServeMux) Handle(pattern string, handler Handler) func (mux *ServeMux) HandleFunc(pattern string, handler func(ResponseWriter, *Request)) func (mux *ServeMux) Handler(r *Request) (h Handler, pattern string) func (mux *ServeMux) ServeHTTP(w ResponseWriter, r *Request)
前面說過,只要實現(xiàn)了ServerHTTP()方法的類型,就是一個Handler。而DefaultServeMux是默認的ServeMux,所以它是一個Handler。
關(guān)于第一個問題,看一個示例就知道了。
package main import ( "fmt" "net/http" ) // MyHandler實現(xiàn)Handler接口 type MyHandler struct{} func (h *MyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "Hello World!\n") } func main() { handler := MyHandler{} server := http.Server{ Addr: "127.0.0.1:8080", Handler: &handler, // 以&handler作為第二個參數(shù) } server.ListenAndServe() }
上面的示例中定義了一個handler,它實現(xiàn)的ServeHTTP()方法只有一個作用,輸出Hello World!
。并且將這個handler作為ListenAndServe()的第二個參數(shù)。
注意,上面以&handler
作為參數(shù)而非handler
,因為此處MyHandler中實現(xiàn)的ServerHTTP()方法的receiver是指針類型的,所以MyHandler的實例對象也必須是指針類型的,如此才能實現(xiàn)Handler接口。
啟動這個web服務(wù)后,以不同的URL去訪問它,將總是得到完全相同的響應(yīng)結(jié)果:
很顯然,當handler作為ListenAndServe()的第二個參數(shù)時,任意請求都會使用這個唯一的handler進行處理。
所以,建議將第二個參數(shù)設(shè)置為nil(或者上面的Serve Struct不指定Handler字段),它表示調(diào)用默認的DefaultServeMux作為handler,使得每個訪問請求都會調(diào)用這個特殊的handler,而這個handler的作用是將請求根據(jù)url路由給不同的handler。
另外需要注意的是,http包中提供的Handle()和HandleFunc()函數(shù)其實是DefaultServeMux.XXX的封裝,所以直接調(diào)用http.Handle()和http.HandleFunc()實際上是在調(diào)用DefaultServeMux.Handle()和DefaultServeMux.HandleFunc()。
func Handle(pattern string, handler Handler) { DefaultServeMux.Handle(pattern, handler) } func HandleFunc(pattern string, handler func(ResponseWriter, *Request)) { DefaultServeMux.HandleFunc(pattern, handler) }
使用DefaultServeMux后的Handler示例
下面是使用了DefaultServeMux的示例。
創(chuàng)建了兩個handler,一個handler用于對應(yīng)/hello
,該handler用于輸出Hello
,另一個handler用于對應(yīng)world
,該handler用于輸出World
:
package main import ( "fmt" "net/http" ) type HelloHandler struct{} type WorldHandler struct{} func (h *HelloHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "Hello\n") } func (h *WorldHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "World\n") } func main() { helloHandler := HelloHandler{} worldHandler := WorldHandler{} server := http.Server{ Addr: "127.0.0.1:8080", } http.Handle("/hello",&helloHandler) http.Handle("/world",&worldHandler) server.ListenAndServe() }
下面是訪問的結(jié)果:
HandleFunc是什么
除了使用Handle處理http請求,也能使用HandleFunc()處理。
先看一個使用HandleFunc()處理請求的示例,示例的效果和前文是一樣的。
package main import ( "fmt" "net/http" ) func hello(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "Hello\n") } func world(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "World\n") } func main() { server := http.Server{ Addr: "127.0.0.1:8080", } http.HandleFunc("/hello", hello) http.HandleFunc("/world", world) server.ListenAndServe() }
下面是訪問的結(jié)果:
Go有一個函數(shù)HandleFunc(),它表示使用第二個參數(shù)的函數(shù)作為handler,處理匹配到的url路徑請求。
func HandleFunc(pattern string, handler func(ResponseWriter, *Request))
不難看出,HandleFunc()使得我們可以直接使用一個函數(shù)作為handler,而不需要自定義一個實現(xiàn)Handler接口的類型。正如上面的示例中,我們沒有定義Handler類型,也沒有去實現(xiàn)ServeHTTP()方法,而是直接定義函數(shù),并將其作為handler。
換句話說,HandleFunc()使得我們可以更簡便地為某些url路徑注冊handler。但是,使用HandleFunc()畢竟是圖簡便,有時候不得不使用Handle(),比如我們確定要定義一個type。
Handle()、HandleFunc()和Handler、HandlerFunc的關(guān)系
說實話,一開始感覺挺亂的。
Handle()和HandleFunc()是函數(shù),用來給url綁定handler。Handler和HandlerFunc類型,用來處理請求。
看Handle()、HandleFunc()以及Handler、HandlerFunc的定義就已經(jīng)很清晰了:
func Handle(pattern string, handler Handler) {} func HandleFunc(pattern string, handler func(ResponseWriter, *Request)) {} type Handler interface { ServeHTTP(ResponseWriter, *Request) } type HandlerFunc func(ResponseWriter, *Request) func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request)
Handle()和HandleFunc()都是為某個url路徑模式綁定一個對應(yīng)的handler,只不過HandleFunc()是直接使用函數(shù)作為handler,而Handle()是使用Handler類型的實例作為handler。
Handler接口的實例都實現(xiàn)了ServeHTTP()方法,都用來處理請求并響應(yīng)給客戶端。
HandlerFunc類型不是接口,但它有一個方法ServeHTTP(),也就是說HandlerFunc其實也是一種Handler。
因為HandlerFunc是類型,只要某個函數(shù)的簽名是func(ResponseWriter, *Request)
,它就是HandlerFunc類型的一個實例。另一方面,這個類型的實例(可能是參數(shù)、可能是返回值類型)可以和某個簽名為func(ResponseWriter, *Request)
的函數(shù)進行互相賦值。這個過程可能很隱式,但確實經(jīng)常出現(xiàn)相關(guān)的用法。
例如:
// 一個函數(shù)類型的handler func myhf(ResponseWriter, *Request){} // 以HandlerFunc類型作為參數(shù)類型 func a(hf HandlerFunc){} // 所以,可以將myhf作為a()的參數(shù) a(myhf)
實際上,可以使用HandlerFunc()進行轉(zhuǎn)換。例如有一個函數(shù)world(),它的參數(shù)是合理的,使用HandlerFunc(world)表示將其轉(zhuǎn)換為一個Handler。這個轉(zhuǎn)換、適應(yīng)在后面會經(jīng)常用到。
例如:
// 兩個函數(shù) func hello(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "Hello\n") } func world(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "World\n") } func main() { server := http.Server{ Addr: "127.0.0.1:8080", } // 第一個使用HandleFunc()為路徑注冊hello()函數(shù)handler // 第二個使用Handle()為路徑注冊轉(zhuǎn)換后的handler http.HandleFunc("/hello", hello) http.Handle("/world", http.HandlerFunc(world)) server.ListenAndServe() }
上面的示例中,Handle()函數(shù)的第二個參數(shù)要求的是Handler類型,使用http.HandlerFunc(world)
就將函數(shù)world()轉(zhuǎn)換成了Handler類型的一個實例。
鏈式handler
handler是用來處理http請求的,處理過程可能會很簡單,也可能會很復(fù)雜。復(fù)雜的情況下,可能無法使用一個單獨的handler來完成工作,畢竟handler只是一個函數(shù)。盡管我們可以直接在這個函數(shù)中調(diào)用其它函數(shù)。
很經(jīng)常地,可能handler中需要嵌套其它handler,甚至多層嵌套,這就是鏈式handler。
由于Handle()或HandleFunc()注冊的時候需要指定參數(shù)類型,所以handler嵌套的時候,也要關(guān)注handler的參數(shù)類型以及返回類型。看下面示例就會明白參數(shù)類型和返回類型是怎么要求的。
HandleFunc()的嵌套示例
代碼如下:
package main import ( "fmt" "net/http" ) func hello(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "Hello World!\n") } func log(hf http.HandlerFunc) http.HandlerFunc { count := 0 return func(w http.ResponseWriter, r *http.Request) { count++ fmt.Printf("Handler Function called %d times\n", count) hf(w, r) } } func main() { server := http.Server{ Addr: "127.0.0.1:8080", } http.HandleFunc("/hello", log(hello)) server.ListenAndServe() }
多次訪問http://127.0.0.1:8080/hello
,將在瀏覽器中輸出"Hello World!",但同時會在運行這個go程序的終端上多次輸出以下內(nèi)容:
$ go run test.go Handler Function called 1 times Handler Function called 2 times Handler Function called 3 times Handler Function called 4 times Handler Function called 5 times
上面的示例中,主要看下面兩段代碼:
func hello(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "Hello World!\n") } func log(hf http.HandlerFunc) http.HandlerFunc { count := 0 return func(w http.ResponseWriter, r *http.Request) { count++ fmt.Printf("Handler Function called %d times\n", count) hf(w, r) } }
hello()是一個普通的HandlerFunc類型函數(shù),因為它的簽名符合HandlerFunc類型,所以它是HandlerFunc類型的一個實例。而log()函數(shù)正是以HandlerFunc類型作為參數(shù)的,所以前面的示例代碼中,將hello函數(shù)作為了log函數(shù)的參數(shù):
http.HandleFunc("/hello", log(hello))
HandleFunc()的第二個參數(shù)要求是HandlerFunc類型的,所以log()的返回值是HandlerFunc類型。在log()中,使用匿名函數(shù)作為它的返回值,這里的這個匿名函數(shù)是一個閉包(因為引用了外層函數(shù)的變量hf和count)。這個匿名函數(shù)最后調(diào)用hf(w,r)
,由于hf是HandlerFunc類型的一個實例,所以可以如此調(diào)用。
上面體現(xiàn)了HandlerFunc嵌套時候關(guān)于參數(shù)以及返回值的一些細節(jié)。
上面的示例中還有一個細節(jié)需要引起注意:為什么每次訪問時,上面的count都會記住之前的值并自增,而不是重置為0后自增。
之所以有這個疑問,可能是認為每次訪問時,請求處理完成后handler就退出了,閉包雖然會記住外層函數(shù)的自由變量count,但也會因為處理完成后退出,導(dǎo)致每次訪問都重置為0后自增。但實際上,handler是注冊在給定路徑上的,只要web服務(wù)沒有退出,這個handler就一直不會退出,不會因為每次訪問都重新注冊handler。所以,閉包handler一直引用著hf和count這兩個自由變量。
HandlerFunc嵌套Handler
將上面的HandlerFunc嵌套HandlerFunc修改一下,變成Handler嵌套HandlerFunc。
package main import ( "fmt" "net/http" ) type MyHandler struct{} func (wh *MyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { fmt.Fprintf(w, "Hello World!\n") } func log(h http.Handler) http.Handler { count := 0 f := func(w http.ResponseWriter, r *http.Request) { count++ fmt.Printf("Handler Function called %d times\n", count) h.ServeHTTP(w, r) } return http.HandlerFunc(f) } func main() { myHandler := MyHandler{} server := http.Server{ Addr: "127.0.0.1:8080", } http.Handle("/hello", log(&myHandler)) server.ListenAndServe() }
邏輯也很簡單,無非是將HandlerFunc轉(zhuǎn)換成Handler。
思考一下,Handler是否可以嵌套Handler,或者Handler嵌套HandlerFunc??梢?,但是很不方便,因為ServeHTTP()方法限制了沒法調(diào)用其它的Handler,除非定義的某個Handler是嵌套在某個Handler類型中的類型。
更多關(guān)于Go語言Handler詳細說明請查看下面的相關(guān)鏈接
相關(guān)文章
詳解Go語言如何熱重載和優(yōu)雅地關(guān)閉程序
我們有時會因不同的目的去關(guān)閉服務(wù),一種關(guān)閉服務(wù)是終止操作系統(tǒng),一種關(guān)閉服務(wù)是用來更新配置,本文就來和大家簡單講講這兩種方法的實現(xiàn)吧2023-07-07使用go語言實現(xiàn)查找兩個數(shù)組的異同操作
這篇文章主要介紹了使用go語言實現(xiàn)查找兩個數(shù)組的異同操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12Golang使用反射的動態(tài)方法調(diào)用詳解
Go是一種靜態(tài)類型的語言,提供了大量的安全性和性能。這篇文章主要和大家介紹一下Golang使用反射的動態(tài)方法調(diào)用,感興趣的小伙伴可以了解一下2023-03-03