簡書不維護了，歡迎關注我的知乎：波羅學的個人主頁
原文：Context-Based Programming in Go
作者：Gigi Sayfan
在GO中，我們需要有能力管理并發運行中的goroutine，主要是指它的生命周期。那些失去控制的goroutine可能會進入某個死循環，從而導致其它等待中的goroutine死鎖或運行太久。理想情況是，我們可以終止這些goroutine或使它們不不好的超時退出。
可以基于context編程。Go 1.7 引入了context包。它為我們提供了這些能力，同時我們也可以將某些變量與context關聯實現信息的跨界交流與傳遞。
在本教程中，你將會了解到context的輸入輸出以及何時和如何使用它，以避免濫用。
什么情況下使用
context是一種非常好的抽象。它讓你可以封裝一些與核心邏輯無關的信息，比如 請求ID、認證Token和超時時間。這可以為我們帶來如下的一些好處：
- 它有效地幫助我們把核心邏輯參數與運行參數中分離開來。
- 它為我們制定了通用的操作規則和在邊界交流數據的方法。
- 它為我們提供了一套標準的機制，在不修改函數簽名的情況下傳遞額外信息。
Context接口
如下是Context的所有接口信息：
type Context interface {
Deadline() (deadline time.Time, ok bool)
Done <-chan struct{}
Err() error
Value(key interface{}) interface{}
}
下面介紹各個方法的作用。
Deadline()
當執行完成，context就應被取消，此時Deadline()會返回相應的時間。當沒有設置最后期限，Deadline返回ok == false。多次調用Deadline返回結果相同。
Done()
Done()方法返回的是一個channel，它將在工作執行完成即context應該被取消的時候被關閉。連續調用Done()返回的結果相同。
- context.WithCancel()返回cancel函數，當調用它時，Done會被關閉；
- context.WithDeadline()設置過期時間，當過期后，Done會被關閉；
- context.WithTimeout()設置超時時間，當超時后，Done會被關閉；
可以在select語句中使用Done：
func Stream(ctx context.Context, out chan<- Value) error {
for {
v, err := DoSomething(ctx)
if err != nil {
return err
}
select {
case <-ctx.Done():
return ctx.Err()
case out <- v:
}
}
}
可以讀下這篇文章Go并發模型：Pipeline和Cancellation，介紹很多關于如何使用Done取消context的例子。
Err()
只要Done是打開狀態，Err()返回nil。如果context被取消，它返回Canceled error。如果context到期或超時，它返回DeadlineExceeded error。Done被關閉后，多次調用Err()返回結果相同。下面是一些定義：
// Canceled is the error returned by Context.Err when the context is canceled.
var Canceled = errors.New("context canceled")
// DeadlineExceeded is the error returned by Context.Err when the context's deadline passes.
var DeadlineExceeded error = deadlineExceededError{}
Value()
Value()通過key去調用與context關聯的value，如果context中與指定key對應的值，返回nil。多次以相同key調用Value()返回結果相同。
Context中的Value僅僅用于在請求范圍內不同程序和接口的數據轉化，不可用于其他的參數傳遞。
在Context，一個key代表一個具體的值。那些希望用Context存儲數據值的函數通常會在全局分配一個變量key，并用這個key作為參數調用context.WithValue和context.Value()。key支持任何類型。
Context的作用域
Contexts有作用范圍。你可以從已有的context作用域延伸出新的作用域。父級不能訪問衍生的作用域的數據，不過下級是可以訪問父級作用域數據的。
Contexts是層級結構。你可以通過context.Background()或context.TODO()創建contexts。無論何時你調用WithCancel、WithDeadline或WithTimeout，都會得到出新的context，同時會返回一個cancel函數。最重要的是當父級的context被取消，所有的子級也將取消。
你應該在main、init和tests中使用context.Background()。如果不知道該使用什么context，可以通過context.TODO()產生context。
注意，Background和TODO生成的context是不可取消的。
過期、超時和取消
如你所知，WithDeadline() 和 WithTimeout() 創建的contexts將會自動取消，而WithCancel() 創建的context必須通過cancel()明確指定何時取消。其實，它們都會返回一個cancel函數，所以既沒有超時/過期，你依然可以通過cancel取消衍生的context。
讓我們看個例子。首先，contextDemo函數有兩個參數，分別是name和context。它在一個無限循環中運行，不停的在控制臺打印name和deadline（如果有的話）。然后sleep一秒。
package main
import (
"fmt"
"context"
"time"
)
func contextDemo(name string, ctx context.Context) {
for {
if ok {
fmt.Println(name, "will expire at:", deadline)
} else {
fmt.Println(name, "has no deadline")
}
time.Sleep(time.Second)
}
}
主函數創建了三個contexts：
- 三秒超時的timeoutContext；
- 沒有過期時間的cancelContext；
- 由cancelContext產生的從現在開始4小時過期的deadlineContext；
然后，啟動三個contextDemo的goroutine。它們并發執行且每秒打印一次message。
主函數通過讀取timeoutContext的Done()來實現等待goroutine超時退出。一但三秒超時，main函數就調用cancelFunc取消cancelContext中的goroutine，同時cancelContext衍生出來的4小時過期的deadlineContext的goroutine也將退出。
func main() {
timeout := 3 * time.Second
deadline := time.Now().Add(4 * time.Hour)
timeOutContext, _ := context.WithTimeout(
context.Background(), timeout)
cancelContext, cancelFunc := context.withCancel(
context.Background())
deadlineContext, _ := context.WithDeadline(
cancelContext, deadline)
go contextDemo("[timeoutContext]", timeOutContext)
go contextDemo("[cancelContext]", cancelContext)
go contextDemo("[deadlineContext]", deadlineContext)
// Wait for the timeout to expire
<- timeOutContext.Done()
// This will cancel the deadline context as well as its
// child - the cancelContext
fmt.Println("Cancelling the cancel context...")
cancelFunc()
<- cancelContext.Done()
fmt.Println("The cancel context has been cancelled...")
// Wait for both contexts to be cancelled
<- deadlineContext.Done()
fmt.Println("The deadline context has been cancelled...")
}
下面是輸出結果：
[cancelContext] has no deadline
[deadlineContext] will expire at: 2017-07-29 09:06:02.34260363
[timeoutContext] will expire at: 2017-07-29 05:06:05.342603759
[cancelContext] has no deadline
[timeoutContext] will expire at: 2017-07-29 05:06:05.342603759
[deadlineContext] will expire at: 2017-07-29 09:06:02.34260363
[cancelContext] has no deadline
[timeoutContext] will expire at: 2017-07-29 05:06:05.342603759
[deadlineContext] will expire at: 2017-07-29 09:06:02.34260363
Cancelling the cancel context...
The cancel context has been cancelled...
The deadline context has been cancelled...
輸出結果不變。接下來是最佳實踐章節，將介紹一些指導原則，以便于我們恰當地使用context數據傳遞。
最佳實踐
圍繞context數據傳遞的幾個最佳實踐：
- 避免在context中傳遞函數參數；
- 在全局變量中為context中的數據分配一個對應key；
- 包中應該為key定義一個不可導出的類型，以防止發生沖突；
- 包中定義的key應該為其在context存儲的數據提供類型安全訪問方法；
HTTP請求的Context
context的常用場景之一就是在HTTP請求間傳遞信息。這些信息可能包含請求ID、認證證書等。在GO1.7，標準庫net/http利用了context的優勢，并且已經標準化，直接在request中加入了對context的支持。
func (r *Request) Context() context.Context
func (r *Request) WithContext(ctx context.Context) *Request
現在，我們可以使用一種標準方式把從headers中獲取到的requestId傳遞到最終的處理函數。WithRequestID() 處理函數從"X-Request-ID"頭部導出requestID并從正在使用的context中衍生出一個帶有requestID的context。然后把它傳遞給調用鏈的下一個處理函數。公共函數GetRequestID()為處理函數提供了訪問RequestID的途徑，包括定義在其他包的處理函數。
const requestIDKey int = 0
func WithRequestID(next http.Handler) http.Handler {
return http.HandlerFunc(
func(rw http.ResponseWriter, req *http.Request) {
// Extract request ID from request header
reqID := req.Header.Get("X-Request-ID")
// Create new context from request context with
// the request ID
ctx := context.WithValue(
req.Context(), requestIDKey, reqID)
// Create new request with the new context
req = req.WithContext(ctx)
// Let the next handler in the chain take over.
next.ServeHTTP(rw, req)
}
)
}
func GetRequestID(ctx context.Context) string {
ctx.Value(requestIDKey).(string)
}
func Handle(rw http.ResponseWriter, req *http.Request) {
reqID := GetRequestID(req.Context())
...
}
func main() {
handler := WithRequestID(http.HandlerFunc(Handle))
http.ListenAndServe("/", handler)
}
總結
基于Context的編程為我們提供了一套標準和良好支持的方法，它解決了兩個常見的問題：goroutine的生命周期管理和信息傳遞。
以最佳實踐為準，在合適的場景下使用contexts，你的編碼能力將會大幅提升。
