golang context初探

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

什麼是context

從go1.7開始，golang.org/x/net/context包正式作為context包進入了標準庫。那麼，這個包到底是做什麼的呢？根據官方的文檔說明：

Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.

也就是說，通過context，我們可以方便地對同一個請求所產生地goroutine進行約束管理，可以設定逾時、deadline，甚至是取消這個請求相關的所有goroutine。形象地說，假如一個請求過來，需要A去做事情，而A讓B去做一些事情，B讓C去做一些事情，A、B、C是三個有關聯的goroutine，那麼問題來了：假如在A、B、C還在處理事情的時候請求被取消了，那麼該如何優雅地同時關閉goroutine A、B、C呢？這個時候就輪到context包上場了。

如何使用context

在開始說明如何使用context之前，先來看看context有什麼相關的方法定義。
先來看看context的程式碼範例：

package mainimport (    "context"    "log"    "net/http"    _ "net/http/pprof"    "time")func main() {    go http.ListenAndServe(":8989", nil)    ctx, cancel := context.WithCancel(context.Background())    go func() {        time.Sleep(3 * time.Second)        cancel()    }()    log.Println(Add(ctx))    select {}}func C(ctx context.Context) string {    select {    case <-ctx.Done():        return "C Done"    }    return ""}func B(ctx context.Context) string {    ctx, _ = context.WithCancel(ctx)    go log.Println(C(ctx))    select {    case <-ctx.Done():        return "B Done"    }    return ""}func A(ctx context.Context) string {    go log.Println(B(ctx))    select {    case <-ctx.Done():        return "A Done"    }    return ""}

運行結果：

2016/12/25 22:27:00 A Done
2016/12/25 22:27:00 C Done
2016/12/25 22:27:00 B Done

pprof，剛開始的時候：

剛開始.png

A、B、C結束後：

結束後.png

在這裡，我們用http的pprof來查看運行時有多少個goroutine正在執行，
go http.ListenAndServe(":8989", nil)
這一句是啟動一個http伺服器，用來查看程式的一些運行資訊。
我們用context.Background()來執行個體化一個context，然後調用WithCancel()方法來返回一個context和一個取消的方法，並在3秒後調用這個cancel方法關閉goroutine A、B、C。從程式的運行結果看，我們調用了一次cancel方法，子goroutine的ctx.Done()都收到了關閉訊號。從pprof的也可以看到，從一開始有5個goroutine，到關閉後剩下兩個，也就是A、B、C三個goroutine都已經關閉了。
這裡的例子是直接調用了context.WithCancel()，我們也可以使用context.WithTimeout()和context.WithDeadline()來設定goroutine的逾時時間和最終的已耗用時間。具體的用法可以看一下官方文檔，這裡就不細說了。另外有一個方法在例子中沒有用到，那就是context.WithValue()。這個方法是用來傳遞在這次的請求處理中相關goroutine的共用變數，這與全域變數是有所區別的，因為它只在這次的請求範圍內有效。

context的使用規範

在最新的1.8 beta版本中，很多相關的包都加入了context，比如database包。那麼，在使用context的時候有哪些需要注意呢？

• 不要把context儲存在結構體中，而是要顯式地進行傳遞
• 把context作為第一個參數，並且一般都把變數命名為ctx
• 就算是程式允許，也不要傳入一個nil的context，如果不知道是否要用context的話，用context.TODO()來替代
• context.WithValue()只用來傳遞請求範圍的值，不要用它來傳遞選擇性參數
• 就算是被多個不同的goroutine使用，context也是安全的

context的初步瞭解暫時就先說這麼多了，以後有空可以研究一下源碼看看context是如何?的。

聖誕快樂！

參考文章：
Golang之Context的使用
Golang context