GOLANG使用Context實現傳值、超時和取消

winlin發表於2017-06-28

GO1.7之後,新增了context.Context這個package,實現goroutine的管理。

Context基本的用法參考GOLANG使用Context管理關聯goroutine

實際上,Context還有個非常重要的作用,就是設定超時。比如,如果我們有個API是這樣設計的:

type Packet interface {
    encoding.BinaryMarshaler
    encoding.BinaryUnmarshaler
}

type Stack struct {
}
func (v *Stack) Read(ctx context.Context) (pkt Packet, err error) {
    return
}

一般使用是這樣使用,建立context然後呼叫介面:

ctx,cancel := context.WithCancel(context.Background())
stack := &Stack{}
pkt,err := stack.Read(ctx)

那麼,它本身就可以支援取消和超時,也就是使用者如果需要取消,比如傳送了SIGINT訊號,程式需要退出,可以在收到訊號後呼叫cancel

sc := make(chan os.Signal, 0)
signal.Notify(sc, syscall.SIGINT, syscall.SIGTERM)
go func() {
    for range sc {
        cancel()
    }
}()

如果需要超時,這個API也不用改,只需要呼叫前設定超時時間:

ctx,cancel := context.WithTimeout(context.Background(), 3*time.Second)
defer cancel()
pkt,err := stack.Read(ctx)

如果一個程式在執行,比如Read在等待,那麼在沒有人工干預的情況下,那就應該自己執行就好了。而人工干預,也就是需要取消,比如要升級程式了,或者需要停止服務了,都屬於這種取消操作。而超時,一般是系統的策略,因為不能一直等下去,就需要在一定時間沒有反應時終止服務。實際上context這兩個都能支援得很好,而且還不影響Read本身的邏輯,在Read中只需要關注context是否Done:

func (v *Stack) Read(ctx context.Context) (pkt Packet, err error) {
    select {
    // case <- dataChannel: // Parse packet from data channel.
    case <- ctx.Done():
        return nil,ctx.Err()
    }
    return
}

這是為何context被接納成為標準庫的包的緣故了吧,非常之強大和好用,而又非常簡單。一行context,深藏功與名。

另外,Context還可以傳遞上下文的Key-Value物件,比如我們希望日誌中,相關的goroutine都列印一個簡化的CID,那麼就可以用context.WithValue,參考go-oryx-lib/logger

相關文章