關(guān)于GO CONTEXT機制實現(xiàn)原則

1 什么是Context

最近在公司分析gRPC源碼，proto文件生成的代碼，接口函數(shù)第一個參數(shù)統(tǒng)一是ctx context.Context接口，公司不少同事都不了解這樣設(shè)計的出發(fā)點是什么，其實我也不了解其背后的原理。今天趁著妮妲臺風(fēng)妹子正面登陸深圳，全市停工、停課、停業(yè)，在家休息找了一些資料研究把玩一把。

Context通常被譯作上下文，它是一個比較抽象的概念。在公司技術(shù)討論時也經(jīng)常會提到上下文。一般理解為程序單元的一個運行狀態(tài)、現(xiàn)場、快照，而翻譯中上下又很好地詮釋了其本質(zhì)，上下上下則是存在上下層的傳遞，上會把內(nèi)容傳遞給下。在Go語言中，程序單元也就指的是Goroutine。

每個Goroutine在執(zhí)行之前，都要先知道程序當(dāng)前的執(zhí)行狀態(tài)，通常將這些執(zhí)行狀態(tài)封裝在一個Context變量中，傳遞給要執(zhí)行的Goroutine中。上下文則幾乎已經(jīng)成為傳遞與請求同生存周期變量的標(biāo)準(zhǔn)方法。在網(wǎng)絡(luò)編程下，當(dāng)接收到一個網(wǎng)絡(luò)請求Request，處理Request時，我們可能需要開啟不同的Goroutine來獲取數(shù)據(jù)與邏輯處理，即一個請求Request，會在多個Goroutine中處理。而這些Goroutine可能需要共享Request的一些信息；同時當(dāng)Request被取消或者超時的時候，所有從這個Request創(chuàng)建的所有Goroutine也應(yīng)該被結(jié)束。

2 context包

Go的設(shè)計者早考慮多個Goroutine共享數(shù)據(jù)，以及多Goroutine管理機制。Context介紹請參考Go Concurrency Patterns: Context，golang.org/x/net/context包就是這種機制的實現(xiàn)。

context包不僅實現(xiàn)了在程序單元之間共享狀態(tài)變量的方法，同時能通過簡單的方法，使我們在被調(diào)用程序單元的外部，通過設(shè)置ctx變量值，將過期或撤銷這些信號傳遞給被調(diào)用的程序單元。在網(wǎng)絡(luò)編程中，若存在A調(diào)用B的API, B再調(diào)用C的API，若A調(diào)用B取消，那也要取消B調(diào)用C，通過在A,B,C的API調(diào)用之間傳遞Context，以及判斷其狀態(tài)，就能解決此問題，這是為什么gRPC的接口中帶上ctx context.Context參數(shù)的原因之一。

Go1.7(當(dāng)前是RC2版本)已將原來的golang.org/x/net/context包挪入了標(biāo)準(zhǔn)庫中，放在$GOROOT/src/context下面。標(biāo)準(zhǔn)庫中net、net/http、os/exec都用到了context。同時為了考慮兼容，在原golang.org/x/net/context包下存在兩個文件，go17.go是調(diào)用標(biāo)準(zhǔn)庫的context包，而pre_go17.go則是之前的默認實現(xiàn)，其介紹請參考go程序包源碼解讀。

context包的核心就是Context接口，其定義如下：

type Context interface {
    Deadline() (deadline time.Time, ok bool)
    Done() <-chan struct{}
    Err() error
    Value(key interface{}) interface{}
}

Deadline會返回一個超時時間，Goroutine獲得了超時時間后，例如可以對某些io操作設(shè)定超時時間。

Done方法返回一個信道（channel），當(dāng)Context被撤銷或過期時，該信道是關(guān)閉的，即它是一個表示Context是否已關(guān)閉的信號。

當(dāng)Done信道關(guān)閉后，Err方法表明Context被撤的原因。

Value可以讓Goroutine共享一些數(shù)據(jù)，當(dāng)然獲得數(shù)據(jù)是協(xié)程安全的。但使用這些數(shù)據(jù)的時候要注意同步，比如返回了一個map，而這個map的讀寫則要加鎖。

Context接口沒有提供方法來設(shè)置其值和過期時間，也沒有提供方法直接將其自身撤銷。也就是說，Context不能改變和撤銷其自身。那么該怎么通過Context傳遞改變后的狀態(tài)呢？

3 context使用

無論是Goroutine，他們的創(chuàng)建和調(diào)用關(guān)系總是像層層調(diào)用進行的，就像人的輩分一樣，而更靠頂部的Goroutine應(yīng)有辦法主動關(guān)閉其下屬的Goroutine的執(zhí)行（不然程序可能就失控了）。為了實現(xiàn)這種關(guān)系，Context結(jié)構(gòu)也應(yīng)該像一棵樹，葉子節(jié)點須總是由根節(jié)點衍生出來的。

要創(chuàng)建Context樹，第一步就是要得到根節(jié)點，context.Background函數(shù)的返回值就是根節(jié)點：

func Background() Context

該函數(shù)返回空的Context，該Context一般由接收請求的第一個Goroutine創(chuàng)建，是與進入請求對應(yīng)的Context根節(jié)點，它不能被取消、沒有值、也沒有過期時間。它常常作為處理Request的頂層context存在。

有了根節(jié)點，又該怎么創(chuàng)建其它的子節(jié)點，孫節(jié)點呢？context包為我們提供了多個函數(shù)來創(chuàng)建他們：

func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
func WithDeadline(parent Context, deadline time.Time) (Context, CancelFunc)
func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
func WithValue(parent Context, key interface{}, val interface{}) Context

函數(shù)都接收一個Context類型的參數(shù)parent，并返回一個Context類型的值，這樣就層層創(chuàng)建出不同的節(jié)點。子節(jié)點是從復(fù)制父節(jié)點得到的，并且根據(jù)接收參數(shù)設(shè)定子節(jié)點的一些狀態(tài)值，接著就可以將子節(jié)點傳遞給下層的Goroutine了。

再回到之前的問題：該怎么通過Context傳遞改變后的狀態(tài)呢？使用Context的Goroutine無法取消某個操作，其實這也是符合常理的，因為這些Goroutine是被某個父Goroutine創(chuàng)建的，而理應(yīng)只有父Goroutine可以取消操作。在父Goroutine中可以通過WithCancel方法獲得一個cancel方法，從而獲得cancel的權(quán)利。

第一個WithCancel函數(shù)，它是將父節(jié)點復(fù)制到子節(jié)點，并且還返回一個額外的CancelFunc函數(shù)類型變量，該函數(shù)類型的定義為：

type CancelFunc func()

調(diào)用CancelFunc對象將撤銷對應(yīng)的Context對象，這就是主動撤銷Context的方法。在父節(jié)點的Context所對應(yīng)的環(huán)境中，通過WithCancel函數(shù)不僅可創(chuàng)建子節(jié)點的Context，同時也獲得了該節(jié)點Context的控制權(quán)，一旦執(zhí)行該函數(shù)，則該節(jié)點Context就結(jié)束了，則子節(jié)點需要類似如下代碼來判斷是否已結(jié)束，并退出該Goroutine：

select {
    case <-cxt.Done():
        // do some clean...
}

WithDeadline函數(shù)的作用也差不多，它返回的Context類型值同樣是parent的副本，但其過期時間由deadline和parent的過期時間共同決定。當(dāng)parent的過期時間早于傳入的deadline時間時，返回的過期時間應(yīng)與parent相同。父節(jié)點過期時，其所有的子孫節(jié)點必須同時關(guān)閉；反之，返回的父節(jié)點的過期時間則為deadline。

WithTimeout函數(shù)與WithDeadline類似，只不過它傳入的是從現(xiàn)在開始Context剩余的生命時長。他們都同樣也都返回了所創(chuàng)建的子Context的控制權(quán)，一個CancelFunc類型的函數(shù)變量。

當(dāng)頂層的Request請求函數(shù)結(jié)束后，我們就可以cancel掉某個context，從而層層Goroutine根據(jù)判斷cxt.Done()來結(jié)束。

WithValue函數(shù)，它返回parent的一個副本，調(diào)用該副本的Value(key)方法將得到val。這樣我們不光將根節(jié)點原有的值保留了，還在子孫節(jié)點中加入了新的值，注意若存在Key相同，則會被覆蓋。

3.1 小結(jié)

context包通過構(gòu)建樹型關(guān)系的Context，來達到上一層Goroutine能對傳遞給下一層Goroutine的控制。對于處理一個Request請求操作，需要采用context來層層控制Goroutine，以及傳遞一些變量來共享。

Context對象的生存周期一般僅為一個請求的處理周期。即針對一個請求創(chuàng)建一個Context變量（它為Context樹結(jié)構(gòu)的根）；在請求處理結(jié)束后，撤銷此ctx變量，釋放資源。

每次創(chuàng)建一個Goroutine，要么將原有的Context傳遞給Goroutine，要么創(chuàng)建一個子Context并傳遞給Goroutine。

Context能靈活地存儲不同類型、不同數(shù)目的值，并且使多個Goroutine安全地讀寫其中的值。

當(dāng)通過父Context對象創(chuàng)建子Context對象時，可同時獲得子Context的一個撤銷函數(shù)，這樣父Context對象的創(chuàng)建環(huán)境就獲得了對子Context將要被傳遞到的Goroutine的撤銷權(quán)。

4 使用原則

Programs that use Contexts should follow these rules to keep interfaces consistent across packages and enable static analysis tools to check context propagation:
使用Context的程序包需要遵循如下的原則來滿足接口的一致性以及便于靜態(tài)分析。

在子Context被傳遞到的goroutine中，應(yīng)該對該子Context的Done信道（channel）進行監(jiān)控，一旦該信道被關(guān)閉（即上層運行環(huán)境撤銷了本goroutine的執(zhí)行），應(yīng)主動終止對當(dāng)前請求信息的處理，釋放資源并返回。

Do not store Contexts inside a struct type; instead, pass a Context explicitly to each function that needs it. The Context should be the first parameter, typically named ctx；不要把Context存在一個結(jié)構(gòu)體當(dāng)中，顯式地傳入函數(shù)。Context變量需要作為第一個參數(shù)使用，一般命名為ctx；

Do not pass a nil Context, even if a function permits it. Pass context.TODO if you are unsure about which Context to use；即使方法允許，也不要傳入一個nil的Context，如果你不確定你要用什么Context的時候傳一個context.TODO；

Use context Values only for request-scoped data that transits processes and APIs, not for passing optional parameters to functions；使用context的Value相關(guān)方法只應(yīng)該用于在程序和接口中傳遞的和請求相關(guān)的元數(shù)據(jù)，不要用它來傳遞一些可選的參數(shù)；

The same Context may be passed to functions running in different goroutines; Contexts are safe for simultaneous use by multiple goroutines；同樣的Context可以用來傳遞到不同的goroutine中，Context在多個goroutine中是安全的；

編輯：黃飛