快捷導(dǎo)航

如何編寫Go語(yǔ)言中間件的實(shí)例教程

更新時(shí)間：2018年04月05日 08:45:11 作者：HULK一線技術(shù)雜談

不知道大家有沒(méi)有寫過(guò)中間件呢，它是怎么寫的呢？下面這篇文中就來(lái)給大家分享一下使用Go，如何編寫中間件，文中通過(guò)示例代碼介紹的非常詳細(xì)，供大家參考學(xué)習(xí)，下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧。

引言

web開發(fā)的背景下，“中間件”通常意思是“包裝原始應(yīng)用并添加一些額外的功能的應(yīng)用的一部分”。這個(gè)概念似乎總是不被人理解，但是我認(rèn)為中間件非常棒。

首先，一個(gè)好的中間件有一個(gè)責(zé)任就是可插拔并且自足。這就意味著你可以在接口級(jí)別嵌入你的中間件他就能直接運(yùn)行。它不會(huì)影響你編碼方式，不是框架，僅僅是你請(qǐng)求處理里面的一層而已。完全沒(méi)必要重寫你的代碼，如果你想使用中間件的一個(gè)功能，你就幫他插入到那里，如果不想使用了，就可以直接移除。

縱觀Go語(yǔ)言，中間件是非常普遍的，即使在標(biāo)準(zhǔn)庫(kù)中。雖然開始的時(shí)候不會(huì)那么明顯，在標(biāo)準(zhǔn)庫(kù)net/http中的函數(shù)StripText或者TimeoutHandler就是我們要定義和的中間件的樣子，處理請(qǐng)求和相應(yīng)的時(shí)候他們包裝你的handler，并處理一些額外的步驟。

一開始，我們認(rèn)為編寫中間件似乎很容易，但是我們實(shí)際編寫的時(shí)候也會(huì)遇到各種各樣的坑。讓我們來(lái)看看一些例子。

1、讀取請(qǐng)求

在我們的示例中，所有的中間件都將接受http。處理程序作為一個(gè)參數(shù)，并返回一個(gè)http.Handler。這使得人們很容易就能把中間產(chǎn)品串起來(lái)。我們所有的中間產(chǎn)品的基本模式是這樣的：

func X(h http.Handler) http.Handler {
 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 // Something here...
 h.ServeHTTP(w, r)
 })
}

我們想要將所有的請(qǐng)求重定向到一個(gè)斜杠——比方說(shuō)/message/，到它們的非斜杠等效，比如/message。我們可以這樣寫：

func TrailingSlashRedirect(h http.Handler) http.Handler {
 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 if r.URL.Path != "/" && r.URL.Path[len(r.URL.Path)-1] == '/' {
 http.Redirect(w, r, r.URL.Path[:len(r.URL.Path)-1], http.StatusMovedPermanently)
 return
 }
 h.ServeHTTP(w, r)
 })
}

有沒(méi)有很簡(jiǎn)單。

2、修改請(qǐng)求

比方說(shuō)，我們想要向請(qǐng)求添加一個(gè)標(biāo)題，或者修改它。http.Handler文檔中指明：

除了讀取主體之外，處理程序不應(yīng)該修改所提供的請(qǐng)求。

Go標(biāo)準(zhǔn)庫(kù)復(fù)制http.Request。請(qǐng)求對(duì)象在將其傳遞到響應(yīng)鏈之前，我們也應(yīng)該這樣做。假設(shè)我們想在每個(gè)請(qǐng)求上設(shè)置Request-Id頭，以便內(nèi)部跟蹤。創(chuàng)建*Request的淺副本，并在代理之前修改標(biāo)題。

func RequestID(h http.Handler) http.Handler {
 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 r2 := new(http.Request)
 *r2 = *r
 r2.Header.Set("X-Request-Id", uuid.NewV4().String())
 h.ServeHTTP(w, r2)
 })
}

3、編寫響應(yīng)頭

如果你想設(shè)置響應(yīng)頭，你可以只寫它們，然后代理請(qǐng)求。

func Server(h http.Handler, servername string) http.Handler {
 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 w.Header().Set("Server", servername)
 h.ServeHTTP(w, r)
 })
}

上面的問(wèn)題是，如果內(nèi)部處理器也設(shè)置了服務(wù)器頭，那么你的頭將被覆蓋。如果不想公開內(nèi)部軟件的服務(wù)器頭，或者如果想在發(fā)送響應(yīng)給客戶端之前去掉頭部，這可能會(huì)帶來(lái)問(wèn)題。

要做到這一點(diǎn)，我們必須自己實(shí)現(xiàn)ResponseWriter接口。大多數(shù)時(shí)候，我們只會(huì)代理到底層的ResponseWriter，但是如果用戶試圖寫一個(gè)響應(yīng)，我們就會(huì)潛入并添加我們的標(biāo)題。

type serverWriter struct {
 w http.ResponseWriter
 name string
 wroteHeaders bool
}

func (s *serverWriter) Header() http.Header {
 return s.w.Header()
}

func (s *serverWriter) WriteHeader(code int) http.Header {
 if s.wroteHeader == false {
 s.w.Header().Set("Server", s.name)
 s.wroteHeader = true
 }
 s.w.WriteHeader(code)
}

func (s *serverWriter) Write(b []byte) (int, error) {
 if s.wroteHeader == false {
 // We hit this case if user never calls WriteHeader (default 200)
 s.w.Header().Set("Server", s.name)
 s.wroteHeader = true
 } return s.w.Write(b)
}

要在我們的中間件中使用它，我們會(huì)寫：

func Server(h http.Handler, servername string) http.Handler {
 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 sw := &serverWriter{
 w: w,
 name: servername,
 }
 h.ServeHTTP(sw, r)
 })
}

問(wèn)題

如果用戶從不調(diào)用Write或WriteHeader呢？例如，有一個(gè)200狀態(tài)并且是空body，或者對(duì)選項(xiàng)請(qǐng)求的響應(yīng)——我們的攔截函數(shù)都不會(huì)運(yùn)行。因此，我們應(yīng)該在ServeHTTP調(diào)用之后再添加校驗(yàn)。

func Server(h http.Handler, servername string) http.Handler {
 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 sw := &serverWriter{
 w: w,
 name: servername,
 }
 h.ServeHTTP(sw, r)
 if sw.wroteHeaders == false {
 s.w.Header().Set("Server", s.name)
 s.wroteHeader = true
 }
 })
}

其他ResponseWriter接口

ResponseWriter接口只需要有三種方法。但在實(shí)踐中，它也可以對(duì)其他接口作出響應(yīng)，例如http.Pusher。你的中間件可能會(huì)意外地禁用HTTP/2支持，這是不好的。

// Push implements the http.Pusher interface.
func (s *serverWriter) Push(target string, opts *http.PushOptions) error {
 if pusher, ok := s.w.(http.Pusher); ok {
 return pusher.Push(target, opts)
 }
 return http.ErrNotSupported
}

// Flush implements the http.Flusher interface.
func (s *serverWriter) Flush() {
 f, ok := s.w.(http.Flusher)
 if ok {
 f.Flush()
 }
}

總結(jié)

通過(guò)以上的學(xué)習(xí)，不知道大家對(duì)Go編寫中間件有沒(méi)有一個(gè)完整的認(rèn)識(shí)。大家也可以嘗試著用Go去編寫一個(gè)中間件。

好了，以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。