這篇文章主要介紹了使用Golang的Context管理上下文的方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨着小編來一起學習學習吧
golang 1.7版本中context庫被很多標準庫的模塊所使用,比如net/http和os的一些模塊中,利用這些原生模塊,我們就不需要自己再寫上下文的管理器了,直接調用函數接口即可實現,利用context我們可以實現一些比如請求的聲明週期內的變量管理,執行一些操作的超時等等。
保存上下文對象
這裏我們通過一個簡單的例子來看一下如何使用context的特性來實現上下文的對象保存,這裏我們寫了一個簡單的http server,具有登錄和退出,狀態檢查路由(檢查用戶是否登錄)
func main(){ mux:=http.NewServeMux() mux.HandleFunc("/",StatusHandler) mux.HandleFunc("/login",LoginHandler) mux.HandleFunc("/logout",LogoutHandler) contextedMux:=AddContextSupport(mux) log.Fatal(http.ListenAndServe(":8080",contextedMux)) }
其中的AddContextSupport是一箇中間件,用來綁定一個context到原來的handler中,所有的請求都必須先經過該中間件後才能進入各自的路由處理中。具體的實現代碼如下:
func AddContextSupport(next http.Handler)http.Handler{ return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { log.Println(r.Method, "-", r.RequestURI) cookie, _ := r.Cookie("username") if cookie != nil { ctx := context.WithValue(r.Context(), "username", cookie.Value) // WithContext returns a shallow copy of r with its context changed // to ctx. The provided ctx must be non-nil. next.ServeHTTP(w, r.WithContext(ctx)) } else { next.ServeHTTP(w, r) } }) }
該中間件可以打印每次請求的方法和請求的url,然後獲得請求的cookie值,如果cookie爲空的話則繼續傳遞到對應的路由處理函數中,否則保存cookie的值到Context, 注意這裏的Context()是request對象的方法, 將創建一個新的上下文對象(如果context爲空),context.WithValue()函數將key和value保存在新的上下文對象中並返回該對象。
其餘的路由處理函數代碼如下, 分別用來保存cookie的登錄路由LoginHandler(),還有刪除cookie的退出路由處理函數LogoutHandler()。
func LoginHandler(w http.ResponseWriter,r *http.Request){ expitation := time.Now().Add(24*time.Hour) var username string if username=r.URL.Query().Get("username");username==""{ username = "guest" } cookie:=http.Cookie{Name:"username",Value:username,Expires:expitation} http.SetCookie(w,&cookie) } func LogoutHandler(w http.ResponseWriter, r *http.Request) { expiration := time.Now().AddDate(0, 0, -1) cookie := http.Cookie{Name: "username", Value: "[email protected]", Expires: expiration} http.SetCookie(w, &cookie) }
這裏我們在請求/login的時候,可以傳遞一個參數username到函數中,比如/login?username=alice , 默認爲”guest”用戶. 設置的cookie有效期爲1天,刪除的時候我們只需要設置cookie爲之前的日期即可。
另外一個關鍵的部分是讀取上下文保存內容的 StatusHandler() 路由處理函數,該函數將調用r.Context()獲得request的上下文,如果我們執行了login後,那我們在中間件中已經設置了該對象,所以請求將查看是否上下文對象中保存了一個名爲username的對象,如果有的話則迴應一個歡迎頁面。否則告知用戶沒有登錄。
func StatusHandler(w http.ResponseWriter,r *http.Request){ if username:=r.Context().Value("username"); username!=nil{ w.WriteHeader(http.StatusOK) w.Write([]byte("Hi username:"+username.(string)+"\n")) }else{ w.WriteHeader(http.StatusNotFound) w.Write([]byte("Not Logged in")) } }
我們不僅僅可以在上下文中保存簡單的類型,我們可以保存任何類型的數據,因爲Value() 返回的對象是一個interface{}對象,所以我們需要轉換一下才能使用。
超時處理
對於簡單的保存和傳遞對象,使用context的確很方便,但是該庫的使用不僅僅是保存變量,還可以創建一個超時和取消的行爲,比如說我們web端去請求了其他的資源,但是該資源的處理比較耗時,我們無法預見什麼時候能夠返回,如果讓用戶超時的話,實在是不太好,所以我們需要創建一個超時的操作,主動判斷是否超時,然後傳遞一個合適的行爲給用戶。
這裏我們現在路由中增加一個長期運行的job路由
mux.HandleFunc("/longjob",jobWithCancelHandler)
具體的處理如下,我們的handler會利用WithCancel() 返回一個新的(如果沒有創建)或者原來已保存的上下文,還有一個cancel對象,這個對象可以用來手動執行取消操作。另外我們的url中可以指定這個任務模擬執行的長度,比如/longjob?jobtime=10則代表模擬的任務將會執行超過10秒。 執行任務的函數longRunningCalculation()返回一個chan該chan會在執行時間到期後寫入一個Done字符串。
handler中我們就可以使用select語句監聽兩個非緩存的channel,阻塞直到有數據寫到任何一個channel中。比如代碼中我們設置了超時是5秒,而任務執行10秒的話則5秒到期後ctx.Done()會因爲cancel()的調用而寫入數據,這樣該handler就會因爲超時退出。否則的話則執行正常的job處理後獲得傳遞的“Done”退出。
func longRunningCalculation(timeCost int)chan string{ result:=make(chan string) go func (){ time.Sleep(time.Second*(time.Duration(timeCost))) result<-"Done" }() return result } func jobWithCancelHandler(w http.ResponseWriter, r * http.Request){ var ctx context.Context var cancel context.CancelFunc var jobtime string if jobtime=r.URL.Query().Get("jobtime");jobtime==""{ jobtime = "10" } timecost,err:=strconv.Atoi(jobtime) if err!=nil{ timecost=10 } log.Println("Job will cost : "+jobtime+"s") ctx,cancel = context.WithCancel(r.Context()) defer cancel() go func(){ time.Sleep(5*time.Second) cancel() }() select{ case <-ctx.Done(): log.Println(ctx.Err()) return case result:=<-longRunningCalculation(timecost): io.WriteString(w,result) } return }
這就是使用context的一些基本方式,其實context還有很多函數這裏沒有涉及,比如WithTimeout和WithDeadline等,但是使用上都比較相似,這裏就不在舉例。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持神馬文庫。