深入了解Go语言中context的用法.docxVIP

第

深入了解Go语言中context的用法

目录遵循规则WithCancelWithDeadlineWithTimeoutWithValue很多Go项目的源码，在读的过程中会发现一个很常见的参数ctx，而且基本都是作为函数的第一个参数。

为什么要这么写呢？这个参数到底有什么用呢？带着这样的疑问，我研究了这个参数背后的故事。

开局一张图：

核心是Context接口：

//?A?Context?carries?a?deadline,?cancelation?signal,?and?request-scoped?values

//?across?API?boundaries.?Its?methods?are?safe?for?simultaneous?use?by?multiple

//?goroutines.

type?Context?interface?{

????//?Done?returns?a?channel?that?is?closed?when?this?Context?is?canceled

????//?or?times?out.

????Done()?-chan?struct{}

????//?Err?indicates?why?this?context?was?canceled,?after?the?Done?channel

????//?is?closed.

????Err()?error

????//?Deadline?returns?the?time?when?this?Context?will?be?canceled,?if?any.

????Deadline()?(deadline?time.Time,?ok?bool)

????//?Value?returns?the?value?associated?with?key?or?nil?if?none.

????Value(key?interface{})?interface{}

}

包含四个方法：

Done()：返回一个channel，当timesout或者调用cancel方法时。Err()：返回一个错误，表示取消ctx的原因。Deadline()：返回截止时间和一个bool值。Value()：返回key对应的值。

有四个结构体实现了这个接口，分别是：emptyCtx,cancelCtx,timerCtx和valueCtx。

其中emptyCtx是空类型，暴露了两个方法：

func?Background()?Context

func?TODO()?Context

一般情况下，会使用Background()作为根ctx，然后在其基础上再派生出子ctx。要是不确定使用哪个ctx，就使用TODO()。

另外三个也分别暴露了对应的方法：

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,?val?interface{})?Context

遵循规则

在使用Context时，要遵循以下四点规则：

不要将Context放入结构体，而是应该作为第一个参数传入，命名为ctx。即使函数允许，也不要传入nil的Context。如果不知道用哪种Context，可以使用context.TODO()。使用Context的Value相关方法只应该用于在程序和接口中传递和请求相关的元数据，不要用它来传递一些可选的参数。相同的Context可以传递给不同的goroutine；Context是并发安全的。

WithCancel

func?WithCancel(parent?Context)?(ctx?Context,?cancel?CancelFunc)

WithCancel返回带有新Done通道的父级副本。当调用返回的cancel函数或关闭父上下文的Done通道时，返回的ctx的Done通道将关闭。

取消此上下文会释放与其关联的资源，因此在此上下文中运行的操作完成后，代码应立即调用cancel。

举个例子：

这段代码演示了如何使用可