Go标准库：context

女爷i 2023-10-11 23:28 74阅读 0赞

#### 阅读目录 ####

*  Go标准库：context
 *   *  emptyCtx 整型
     *  cancelCtx 类型
     *  timerCtx 类型
     *  valueCtx 类型

## Go标准库：context ##

> context 可以理解为一棵树，可以从上向下发送数据，但不能从下向上发送数据。

Go 1.7 标准库引入 context，中文译作“上下文”，主要用来在 goroutine 之间传递上下文信息，包括：取消信号、超时时间、截止时间、k-v 等。

随着 context 包的引入，标准库中很多接口因此加上了 context 参数，例如 database/sql 包。

context 几乎成为了并发控制和超时控制的标准做法。

> context.Context 类型的值可以协调多个 groutine 中的代码执行“取消”操作，并且可以存储键值对。最重要的是它是并发安全的。  
>   
> 与它协作的 API 都可以由外部控制执行“取消”操作，例如：取消一个 HTTP 请求的执行。

一个接口、四种实现、六个函数。  
![在这里插入图片描述][88e7395808614bb194f41aac6cd34198.png]  
Context 提供了四个方法，也就是接口里有四个方法。

![在这里插入图片描述][6348f367d0214c379d2b2bcefcb37c47.png]

Context 接口，用于在API边界上携带截止时间(deadline)、取消信号(cancellation signal)和其他值。

> 注意：这段代码是一个接口的定义，它只是描述了接口的方法和行为，而不是具体实现。

1 Deadline()方法返回工作在此上下文中应该被取消的时间截点。  
当未设置截止时间时，Deadline()方法返回(deadline time.Time, ok bool)中ok为false。  
连续调用Deadline()方法将返回相同的结果。

2 Done()方法返回一个通道(chan struct\{\})，在工作在此上下文中应该被取消时关闭。  
如果此上下文无法被取消，则Done()方法可能返回nil。  
连续调用Done()方法将返回相同的值。  
Done()通道的关闭可能是异步的，在取消函数返回之后才发生。

3 Err()方法返回一个非nil错误，解释为什么Done()通道被关闭。  
如果Done()通道未关闭，则Err()方法返回nil。  
可能的错误值为Canceled表示上下文被取消，或者DeadlineExceeded表示上下文的截止时间已过。  
连续调用Err()方法将返回相同的错误。

4 Value(key any) any方法返回与指定键关联的值，如果该键没有关联的值，则返回nil。  
连续调用Value()方法使用相同的键将返回相同的结果。  
上下文值主要用于传递请求范围的数据，这些数据在进程和API边界之间传输，而不是用于向函数传递可选参数。

该接口的方法可以被多个 goroutine 同时调用。  
代码中还包含了一些使用 Context 的示例，例如使用 Done() 通道来取消工作的 Stream() 函数的实现。

### emptyCtx 整型 ###

![在这里插入图片描述][bfee99e93468463686a2dcb6db7d50fa.png]

`*emptyCtx` 对 Context 接口的实现只是简单的返回 nil 、false 等，实际上什么也没做。

![在这里插入图片描述][2c2d23ec2f084aec9c78e7337f02632e.png]

Background 和 TODO 这两个函数内部都会创建 emptyCtx，其中 Background 主要用于在初始化时获取一个 Context。

![在这里插入图片描述][ec132ce2d2654fa596394faf5db18c19.png]  
ctx 变量是非空接口类型：  
tab \*itab：inter Context 类型数据,动态类型 \*emptyCtx 类型元数据。  
data：指向一个 emptyCtx 本质上就是一个 int。

这就是 background 返回的变量结构。

![在这里插入图片描述][19bb66b7a23c496a85a4fbcf6c9a91e7.png]  
官方文档建议在本来应该使用外层传递的ctx，而外层去没有传递的地方使用。  
就像函数名称表达的含义一样，留下一个todo。

![在这里插入图片描述][f899a0def61747048d6255275295e6b9.png]

### cancelCtx 类型 ###

![在这里插入图片描述][b03ae0b49eee47cb99b7949a8a9cc99c.png]

![在这里插入图片描述][b630e3ff71614b4bbb46310832d5df7c.png]

这是一种可取消的 Context

1 done 用于获取该 Context 的取消通知。

2 children 用于存储以当前节点为根节点的所有可取消的 Context，以便在根节点取消时可以把它们一并取消。

3 err 用于存储取消的指定的错误信息。

4 mu 用来保护这几个字段的锁，保障 cancelCtx 是线程安全的。

![在这里插入图片描述][68476394032645b1a854c49751fb83af.png]  
WithCancel 函数可以包装为 cancelCtx 并提供一个取消函数，调用 Cancel 可以取消对应的 Context。

### timerCtx 类型 ###

![在这里插入图片描述][b8bb88e4a4de4c61832820e65577bbb0.png]  
在 cancelCtx 基础上有封装了一个定时器和一个截止时间，这样既可以根据需要主动取消，也可以在到达 deadline 时通过 timer 来触发取消动作。  
![在这里插入图片描述][6107dc8992ee49b6ace64eb3e55d5206.png]  
WithDeadline 和 WithTimeout 函数都可以创建 timerCtx，区别是 WithDeadline 函数需要指定一个时间点，withtimeout 函数接收一个时间段。

![在这里插入图片描述][a26cb0b7d3334493a210c05bef1198d9.png]  
我们使用 WithDeadline 基于 ctx1 构造一个 timerCtx。

ctx2 同样是 Context 接口类型，动态类型为 \*timerCtx，data 指向一个 timerCtx 结构体。

第一个字段是一个 cancelCtx 这个 cancelCtx 是基于 ctx1 创建的，后面是一个定时器和一个截止时间，这个定时器会在 deadline 到达时调用 cancelCtx 的取消函数。

现在可以看到 ctx2 是基于 ctx1 创建的 ctx1 又是基于 ctx 创建的基于每个 Context 可以创建多个 Context，这样就形成了一颗 Context 树。

每个节点都可以有零个或多个子节点，可取消的Context都会被注册到离它最近的，可取消的祖先节点中。  
对ctx2来说离它最近的，可取消的祖先节点是ctx1，所以ctx1里的children map 中会增加 ctx2 这组键值对。

如果ctx2先取消，就只会影响到以它为根节点的Context，  
如果ctx1先取消，就可以根据children map 中记录的把ctx1子节点中所有可取消的 Context 全部cancel掉。

### valueCtx 类型 ###

![在这里插入图片描述][3dcb4536c3d147c695668b9ae4e3e2b9.png]

> 注意点：一下方式要用自定义类型方式，使用基础类型方式会出现值覆盖情况。

![在这里插入图片描述][a346778e18cf4ce3ab58bad37aae904a.png]  
![在这里插入图片描述][507f7abfeb754a0a8f2e732c27607707.png]

[88e7395808614bb194f41aac6cd34198.png]: https://img-blog.csdnimg.cn/88e7395808614bb194f41aac6cd34198.png
[6348f367d0214c379d2b2bcefcb37c47.png]: https://img-blog.csdnimg.cn/6348f367d0214c379d2b2bcefcb37c47.png
[bfee99e93468463686a2dcb6db7d50fa.png]: https://img-blog.csdnimg.cn/bfee99e93468463686a2dcb6db7d50fa.png
[2c2d23ec2f084aec9c78e7337f02632e.png]: https://img-blog.csdnimg.cn/2c2d23ec2f084aec9c78e7337f02632e.png
[ec132ce2d2654fa596394faf5db18c19.png]: https://img-blog.csdnimg.cn/ec132ce2d2654fa596394faf5db18c19.png
[19bb66b7a23c496a85a4fbcf6c9a91e7.png]: https://img-blog.csdnimg.cn/19bb66b7a23c496a85a4fbcf6c9a91e7.png
[f899a0def61747048d6255275295e6b9.png]: https://img-blog.csdnimg.cn/f899a0def61747048d6255275295e6b9.png
[b03ae0b49eee47cb99b7949a8a9cc99c.png]: https://img-blog.csdnimg.cn/b03ae0b49eee47cb99b7949a8a9cc99c.png
[b630e3ff71614b4bbb46310832d5df7c.png]: https://img-blog.csdnimg.cn/b630e3ff71614b4bbb46310832d5df7c.png
[68476394032645b1a854c49751fb83af.png]: https://img-blog.csdnimg.cn/68476394032645b1a854c49751fb83af.png
[b8bb88e4a4de4c61832820e65577bbb0.png]: https://img-blog.csdnimg.cn/b8bb88e4a4de4c61832820e65577bbb0.png
[6107dc8992ee49b6ace64eb3e55d5206.png]: https://img-blog.csdnimg.cn/6107dc8992ee49b6ace64eb3e55d5206.png
[a26cb0b7d3334493a210c05bef1198d9.png]: https://img-blog.csdnimg.cn/a26cb0b7d3334493a210c05bef1198d9.png
[3dcb4536c3d147c695668b9ae4e3e2b9.png]: https://img-blog.csdnimg.cn/3dcb4536c3d147c695668b9ae4e3e2b9.png
[a346778e18cf4ce3ab58bad37aae904a.png]: https://img-blog.csdnimg.cn/a346778e18cf4ce3ab58bad37aae904a.png
[507f7abfeb754a0a8f2e732c27607707.png]: https://img-blog.csdnimg.cn/507f7abfeb754a0a8f2e732c27607707.png