gitbook/朱涛 · Kotlin编程第一课/docs/491021.md
2022-09-03 22:05:03 +08:00

780 lines
26 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 19 | Channel为什么说Channel是“热”的
你好,我是朱涛。
前面我们学习的挂起函数、async它们一次都只能返回一个结果。但在某些业务场景下我们往往需要协程返回多个结果比如微信等软件的IM通道接收的消息或者是手机GPS定位返回的经纬度坐标需要实时更新。那么在这些场景下我们之前学习的协程知识就无法直接解决了。
而今天我要讲解的Kotlin协程中的Channel就是专门用来做这种事情的。类似的需求如果我们不使用Channel而是用其他的并发手段配合集合来做的话其实也能实现但复杂度会大大增加。那么接下来我们就一起来学习下Channel。
## Channel就是管道
顾名思义Channel就是一个管道。我们可以用这个概念先来建立一个思维模型
![](https://static001.geekbang.org/resource/image/6e/e7/6e3884f46932e80f080191d20cc26be7.gif?wh=1080x270)
Channel这个管道的其中一端是发送方管道的另一端是接收方。而管道本身则可以用来传输数据。
所以,我们根据上面的思维模型,很容易就能写出下面的代码。
```plain
// 代码段1
fun main() = runBlocking {
// 1创建管道
val channel = Channel<Int>()
launch {
// 2在一个单独的协程当中发送管道消息
(1..3).forEach {
channel.send(it) // 挂起函数
logX("Send: $it")
}
}
launch {
// 3在一个单独的协程当中接收管道消息
for (i in channel) { // 挂起函数
logX("Receive: $i")
}
}
logX("end")
}
/*
================================
end
Thread:main @coroutine#1
================================
================================
Receive: 1
Thread:main @coroutine#3
================================
================================
Send: 1
Thread:main @coroutine#2
================================
================================
Send: 2
Thread:main @coroutine#2
================================
================================
Receive: 2
Thread:main @coroutine#3
================================
================================
Receive: 3
Thread:main @coroutine#3
================================
================================
Send: 3
Thread:main @coroutine#2
================================
// 4程序不会退出
*/
```
通过运行的结果我们首先可以看到的就是coroutine#2、coroutine#3这两个协程是交替执行的。这段代码其实和我们[第13讲](https://time.geekbang.org/column/article/485632)当中提到的“互相协作”的模式是类似的,两个协程会轮流执行。
我们还可以看出来Channel可以跨越不同的协程进行通信。我们是在“coroutine#1”当中创建的Channel然后分别在coroutine#2、coroutine#3当中使用Channel来传递数据。
另外在代码中,还有四个注释,我们一个个来看:
* 注释1我们通过“Channel()”这样的方式就可以创建一个管道。其中传入的泛型Int就代表了这个管道里面传递的数据类型。也就是说这里创建的Channel就是用于传递Int数据的。
* 注释2我们创建了一个新的协程然后在协程当中调用了send()方法发送数据到管道里。其中的send()方法是一个挂起函数。
* 注释3在另一个协程当中我们通过遍历channel将管道当中的数据都取了出来。这里我们使用的是for循环。
* 注释4通过运行结果我们还可以发现一个细节那就是程序在输出完所有的结果以后并不会退出。主线程不会结束整个程序还会处于运行状态。
而如果要解决上面的问题,其实也不难,只需要加上一行代码即可:
```plain
// 代码段2
fun main() = runBlocking {
val channel = Channel<Int>()
launch {
(1..3).forEach {
channel.send(it)
logX("Send: $it")
}
channel.close() // 变化在这里
}
launch {
for (i in channel) {
logX("Receive: $i")
}
}
logX("end")
}
```
所以channel其实也是一种**协程资源**在用完channel以后如果我们不去主动关闭它的话是会造成不必要的资源浪费的。在上面的案例中如果我们忘记调用“channel.close()”,程序将永远不会停下来。
现在我们来看看创建Channel的源代码。
```plain
// 代码段3
public fun <E> Channel(
capacity: Int = RENDEZVOUS,
onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND,
onUndeliveredElement: ((E) -> Unit)? = null
): Channel<E> {}
```
可以看到当我们调用“Channel()”的时候感觉像是在调用一个构造函数但实际上它却只是一个普通的顶层函数。这个函数带有一个泛型参数E另外还有三个参数。
第一个参数,**capacity**代表了管道的容量。这个也很好理解我们日常生活中的管道自身也是有容量的即使接收方不将数据取走管道本身也可以存储一些数据。而Kotlin的Channel在默认情况下是“RENDEZVOUS”也就代表了Channel的容量为0。
> 题外话RENDEZVOUS这个单词源自法语。它有约会、碰面的意思我们可以理解为“发送方、接收方不见不散”。
除此之外capacity还有其他几种情况比如说
* UNLIMITED代表了无限容量
* CONFLATED代表了容量为1新的数据会替代旧的数据
* BUFFERED代表了具备一定的缓存容量默认情况下是64具体容量由这个VM参数决定 `"kotlinx.coroutines.channels.defaultBuffer"`
第二个参数,**onBufferOverflow**也就是指当我们指定了capacity的容量等管道的容量满了时Channel的应对策略是怎么样的。这里它主要有三种做法
* SUSPEND当管道的容量满了以后如果发送方还要继续发送我们就会挂起当前的send()方法。由于它是一个挂起函数,所以我们可以以非阻塞的方式,将发送方的执行流程**挂起**,等管道中有了空闲位置以后再**恢复**。
* DROP\_OLDEST顾名思义就是丢弃最旧的那条数据然后发送新的数据
* DROP\_LATEST丢弃最新的那条数据。这里要注意这个动作的含义是丢弃当前正准备发送的那条数据而管道中的内容将维持不变。
由于这部分有点抽象,我画了一张图,来描述上面的几种模式,你可以看看。
![](https://static001.geekbang.org/resource/image/7f/9a/7f3e49c72caf6e12cafb79fb6affc69a.jpg?wh=2000x1125)
在创建Channel的方法中还有第三个参数**onUndeliveredElement**,它其实相当于一个异常处理回调。当管道中的某些数据没有被成功接收的时候,这个回调就会被调用。
这里,为了让你对这三个参数有个更具体的认识,我们来看几个代码的案例。
案例1capacity = UNLIMITED
```plain
// 代码段4
fun main() = runBlocking {
// 变化在这里
val channel = Channel<Int>(capacity = Channel.Factory.UNLIMITED)
launch {
(1..3).forEach {
channel.send(it)
println("Send: $it")
}
channel.close() // 变化在这里
}
launch {
for (i in channel) {
println("Receive: $i")
}
}
println("end")
}}
/*
输出结果:
end
Send: 1
Send: 2
Send: 3
Receive: 1
Receive: 2
Receive: 3
*/
```
以上代码对比代码段1其实只改动了一点点。我们在创建Channel的时候设置了 `capacity = Channel.Factory.UNLIMITED`。不过,通过分析运行的结果,可以发现代码的运行顺序就跟之前完全不一样了。
对于发送方来说由于Channel的容量是无限大的所以发送方可以一直往管道当中塞入数据等数据都塞完以后接收方才开始接收。这跟之前的交替执行是不一样的。
接下来我们看看capacity = CONFLATED的情况。
```plain
// 代码段5
fun main() = runBlocking {
// 变化在这里
val channel = Channel<Int>(capacity = Channel.Factory.CONFLATED)
launch {
(1..3).forEach {
channel.send(it)
println("Send: $it")
}
channel.close()
}
launch {
for (i in channel) {
println("Receive: $i")
}
}
println("end")
}
/*
输出结果:
end
Send: 1
Send: 2
Send: 3
Receive: 3
*/
```
可以看到当设置capacity = CONFLATED的时候发送方也会一直发送数据而且对于接收方来说它永远只能接收到最后一条数据。
我们再来看看onBufferOverflow的用法。其实我们可以运用onBufferOverflow与capacity来实现CONFLATED的效果。
```plain
// 代码段6
fun main() = runBlocking {
// 变化在这里
val channel = Channel<Int>(
capacity = 1,
onBufferOverflow = BufferOverflow.DROP_OLDEST
)
launch {
(1..3).forEach {
channel.send(it)
println("Send: $it")
}
channel.close()
}
launch {
for (i in channel) {
println("Receive: $i")
}
}
println("end")
}
/*
输出结果:
end
Send: 1
Send: 2
Send: 3
Receive: 3
*/
```
从这个运行结果里,我们就可以看出来,其实 `capacity = 1, onBufferOverflow = BufferOverflow.DROP_OLDEST`就代表了capacity = CONFLATED。
对应的,我们再来看看 `onBufferOverflow = BufferOverflow.DROP_LATEST` 的情况。
```plain
// 代码段7
fun main() = runBlocking {
// 变化在这里
val channel = Channel<Int>(
capacity = 3,
onBufferOverflow = BufferOverflow.DROP_LATEST
)
launch {
(1..3).forEach {
channel.send(it)
println("Send: $it")
}
channel.send(4) // 被丢弃
println("Send: 4")
channel.send(5) // 被丢弃
println("Send: 5")
channel.close()
}
launch {
for (i in channel) {
println("Receive: $i")
}
}
println("end")
}
/*
输出结果:
end
Send: 1
Send: 2
Send: 3
Send: 4
Send: 5
Receive: 1
Receive: 2
Receive: 3
*/
```
由此可见,`onBufferOverflow = BufferOverflow.DROP_LATEST` 就意味着当Channel容量满了以后之后再继续发送的内容就会直接被丢弃。
最后我们来看看onUndeliveredElement这个参数的作用。
```plain
// 代码段8
fun main() = runBlocking {
// 无限容量的管道
val channel = Channel<Int>(Channel.UNLIMITED) {
println("onUndeliveredElement = $it")
}
// 等价这种写法
// val channel = Channel<Int>(Channel.UNLIMITED, onUndeliveredElement = { println("onUndeliveredElement = $it") })
// 放入三个数据
(1..3).forEach {
channel.send(it)
}
// 取出一个,剩下两个
channel.receive()
// 取消当前channel
channel.cancel()
}
/*
输出结果:
onUndeliveredElement = 2
onUndeliveredElement = 3
*/
```
可以看到onUndeliveredElement的作用就是一个回调当我们发送出去的Channel数据无法被接收方处理的时候就可以通过onUndeliveredElement这个回调来进行监听。
它的使用场景一般都是用于“接收方对数据是否被消费特别关心的场景”。比如说,我发送出去的消息,接收方是不是真的收到了?对于接收方没收到的信息,发送方就可以灵活处理了,比如针对这些没收到的消息,发送方可以先记录下来,等下次重新发送。
## Channel关闭引发的问题
在前面提到的代码段1里由于我们忘记调用了close(),所以会导致程序一直运行无法终止。这个问题其实是很严重的。我们有没有办法避免这个问题呢?
当然是有的。Kotlin官方其实还为我们提供了另一种创建Channel的方式也就是 **produce{} 高阶函数**
```plain
// 代码段9
fun main() = runBlocking {
// 变化在这里
val channel: ReceiveChannel<Int> = produce {
(1..3).forEach {
send(it)
logX("Send: $it")
}
}
launch {
// 3接收数据
for (i in channel) {
logX("Receive: $i")
}
}
logX("end")
}
```
以上代码中我们使用produce{} 以后就不用再去调用close()方法了因为produce{} 会自动帮我们去调用close()方法。具体的源码,我们会在源码篇的时候再去深入分析。不过,现在我们也可以通过代码来验证这一点。
```plain
// 代码段10
fun main() = runBlocking {
// 1创建管道
val channel: ReceiveChannel<Int> = produce {
// 发送3条数据
(1..3).forEach {
send(it)
}
}
// 调用4次receive()
channel.receive() // 1
channel.receive() // 2
channel.receive() // 3
channel.receive() // 异常
logX("end")
}
/*
输出结果:
ClosedReceiveChannelException: Channel was closed
*/
```
在前面所有的代码当中我们都是以for循环来迭代channel当中的元素的但实际上channel还有一个 **receive()方法**它是与send(it)对应的。在上面代码中我们只调用了3次send()却调用4次receive()。
当我们第4次调用receive()的时候代码会抛出异常“ClosedReceiveChannelException”这其实也代表我们的Channel已经被关闭了。所以这也就说明了produce {}确实会帮我们调用close()方法。不然的话第4次receive()会被挂起,而不是抛出异常。
我们可以再写一段代码来验证下:
```plain
// 代码段11
fun main() = runBlocking {
val channel: Channel<Int> = Channel()
launch {
(1..3).forEach {
channel.send(it)
}
}
// 调用4次receive()
channel.receive() // 1
println("Receive: 1")
channel.receive() // 2
println("Receive: 2")
channel.receive() // 3
println("Receive: 3")
channel.receive() // 永远挂起
logX("end")
}
/*
输出结果
Receive: 1
Receive: 2
Receive: 3
*/
```
可见第4次调用receive(),就会导致程序被永久挂起,后面的 `logX("end")` 是没有机会继续执行的。也就是说,我们**直接使用receive()是很容易出问题的**。这也是我在前面的代码中一直使用for循环而没有用receive()的原因。
那么有没有办法解决这个问题呢如果你足够细心的话你会发现Channel其实还有两个属性isClosedForReceive、isClosedForSend。
这两个属性就可以用来判断当前的Channel是否已经被关闭。由于Channel分为发送方和接收方所以这两个参数也是针对这两者的。也就是说对于发送方我们可以使用“isClosedForSend”来判断当前的Channel是否关闭对于接收方来说我们可以用“isClosedForReceive”来判断当前的Channel是否关闭。
这时候你也许就会想到用它们来改造前面的代码段10。
```plain
// 代码段12
fun main() = runBlocking {
// 1创建管道
val channel: ReceiveChannel<Int> = produce {
// 发送3条数据
(1..3).forEach {
send(it)
println("Send $it")
}
}
// 使用while循环判断isClosedForReceive
while (!channel.isClosedForReceive) {
val i = channel.receive()
println("Receive $i")
}
println("end")
}
/*
输出结果
Send 1
Receive 1
Receive 2
Send 2
Send 3
Receive 3
end
*/
```
以上代码看起来是可以正常工作了。但是,我仍然不建议你用这种方式。**因为当你为管道指定了capacity以后以上的判断方式将会变得不可靠**原因是目前的1.6.0版本的协程库,运行这样的代码会崩溃,如下所示:
```plain
// 代码段13
fun main() = runBlocking {
// 变化在这里
val channel: ReceiveChannel<Int> = produce(capacity = 3) {
// 变化在这里
(1..300).forEach {
send(it)
println("Send $it")
}
}
while (!channel.isClosedForReceive) {
val i = channel.receive()
println("Receive $i")
}
logX("end")
}
/*
输出结果
// 省略部分
Receive 300
Send 300
ClosedReceiveChannelException: Channel was closed
*/
```
所以,**最好不要用channel.receive()**。即使配合isClosedForReceive这个判断条件我们直接调用channel.receive()仍然是一件非常危险的事情!
实际上以上代码除了可以使用for循环以外还可以使用Kotlin为我们提供的另一个高阶函数**channel.consumeEach {}**。我们再来看一个例子:
```plain
// 代码段14
fun main() = runBlocking {
val channel: ReceiveChannel<Int> = produce(capacity = 3) {
(1..300).forEach {
send(it)
println("Send $it")
}
}
// 变化在这里
channel.consumeEach {
println("Receive $it")
}
logX("end")
}
/*
输出结果:
正常
*/
```
所以当我们想要读取Channel当中的数据时我们一定要使用for循环或者是channel.consumeEach {}千万不要直接调用channel.receive()。
> 补充在某些特殊场景下如果我们必须要自己来调用channel.receive()那么可以考虑使用receiveCatching(),它可以防止异常发生。
## 为什么说Channel是“热”的
我们现在已经知道了Channel其实就是用来传递“数据流”的。注意这里的数据流指的是**多个数据组合形成的流**。前面挂起函数、async返回的数据就像是水滴一样而Channel则像是自来水管当中的水流一样。
在业界一直有一种说法Channel是“热”的。也是因为这句话在Kotlin当中我们也经常把Channel称为“热数据流”。
这话我们乍一听可能会有点懵。我们能直接把Channel想象成“热的自来水”吗当然不能了。所以为了对Channel的“热”有一个更具体的概念我们可以来看一段代码
```plain
// 代码段15
fun main() = runBlocking {
// 只发送不接受
val channel = produce<Int>(capacity = 10) {
(1..3).forEach {
send(it)
println("Send $it")
}
}
println("end")
}
/*
输出结果:
end
Send 1
Send 2
Send 3
程序结束
*/
```
在上面的代码中我们定义了一个Channel管道的容量是10然后我们发送了3个数据。但你是否注意到了在代码中并没有消费Channel当中的数据。所以这种“**不管有没有接收方,发送方都会工作**”的模式,就是我们将其认定为“热”的原因。
这就有点像是一个热心的饭店服务员,不管你有没有提要求,服务员都会给你端茶送水,把茶水摆在你的饭桌上。当你想要喝水的时候,就可以直接从饭桌上拿了(当你想要数据的时候,就可以直接从管道里取出来了)。
又或者你可以接着前面的水龙头的思维模型去思考Channel的发送方其实就像是“自来水厂”不管你是不是要用水自来水厂都会把水送到你家门口的管道当中来。这样当你想要用水的时候打开水龙头就会马上有水了。
![](https://static001.geekbang.org/resource/image/df/bf/dfe483ec08baa56c7f5cf937fb93b7bf.jpg?wh=2000x646)
不过也许你会想是不是因为前面的代码中设置了“capacity = 10”的原因如果设置成“capacity = 0”那Channel的发送方是不是就不会主动工作了让我们来试试。
```plain
// 代码段16
fun main() = runBlocking {
val channel = produce<Int>(capacity = 0) {
(1..3).forEach {
println("Before send $it")
send(it)
println("Send $it")
}
}
println("end")
}
/*
输出结果:
end
Befour send 1
程序将无法退出
*/
```
当我们把capacity改成0以后可以看到Channel的发送方仍然是会工作的只是说在它调用send()方法的时候由于接收方还未就绪且管道容量为0所以它会被挂起。所以它仍然还是有在工作的。最直接的证据就是**这个程序将无法退出,一直运行下去**。这个后果是不是更加严重?
但是总的来说不管接收方是否存在Channel的发送方一定会工作。对应的你可以想象成虽然你的饭桌已经没有空间了但服务员还是端来了茶水站在了你旁边只是没有把茶水放在你桌上等饭桌有了空间或者你想喝水了你就能马上喝到。
至于自来水的那个场景你可以想象成你家就在自来水厂的门口你们之间的管道容量为0但这并不意味着自来水厂没有工作。
## 思考与实战
其实如果你去看Channel的源代码定义你会发现Channel本身只是一个接口。
```plain
// 代码段17
public interface Channel<E> : SendChannel<E>, ReceiveChannel<E> {}
```
而且Channel本身并没有什么方法和属性它其实只是SendChannel、ReceiveChannel这两个接口的组合。也就是说Channel的所有能力都是来自于SendChannel、ReceiveChannel这两个接口。
```plain
// 代码段18
public interface SendChannel<in E>
public val isClosedForSend: Boolean
public suspend fun send(element: E)
// 1select相关
public val onSend: SelectClause2<E, SendChannel<E>>
// 2非挂起函数的接收
public fun trySend(element: E): ChannelResult<Unit>
public fun close(cause: Throwable? = null): Boolean
public fun invokeOnClose(handler: (cause: Throwable?) -> Unit)
}
public interface ReceiveChannel<out E> {
public val isClosedForReceive: Boolean
public val isEmpty: Boolean
public suspend fun receive(): E
public suspend fun receiveCatching(): ChannelResult<E>
// 3select相关
public val onReceive: SelectClause1<E>
// 4select相关
public val onReceiveCatching: SelectClause1<ChannelResult<E>>
// 5非挂起函数的接收
public fun tryReceive(): ChannelResult<E>
public operator fun iterator(): ChannelIterator<E>
public fun cancel(cause: CancellationException? = null)
}
```
在上面的源码中大部分的接口我们其实已经见过了。只有5个我们还没见过
* 注释1、3、4它们是跟select相关的我们会在第21讲介绍。
* 注释2、5是专门为非协程环境提供的API也就是说当我们不在协程作用域的时候也可以调用这两个方法来操作Channel。不过大部分情况下我们都应该优先使用挂起函数版本的API。
所以如果说Channel是一个管道那么SendChannel、ReceiveChannel就是组成这个管道的两个零件。
![](https://static001.geekbang.org/resource/image/80/6c/8033b2962552e1f49b2c46e38a94256c.jpg?wh=2000x768)
还记得我们在之前[不变性思维](https://time.geekbang.org/column/article/484631)当中提到的对外暴露不变性集合的思路吗其实对于Channel来说我们也可以做到类似的事情。
```plain
// 代码段19
class ChannelModel {
// 对外只提供读取功能
val channel: ReceiveChannel<Int> by ::_channel
private val _channel: Channel<Int> = Channel()
suspend fun init() {
(1..3).forEach {
_channel.send(it)
}
}
}
fun main() = runBlocking {
val model = ChannelModel()
launch {
model.init()
}
model.channel.consumeEach {
println(it)
}
}
```
也就是对于Channel来说它的send()就相当于集合的写入API当我们想要做到“对写入封闭对读取开放”的时候就可以用之前学过的知识轻松做到。
![](https://static001.geekbang.org/resource/image/6d/53/6dfd13fb26053246662abeb692b00d53.jpg?wh=2000x1125)
而这一切都得益于Channel的能力都是通过“组合”得来的。
## 小结
这节课的内容就到这里,我们来总结一下。
* Channel是一个**管道**当我们想要用协程传递多个数据组成的流的话就没办法通过挂起函数、async来实现了。这时候Channel是一个不错的选择。
* 我们可以通过**Channel()**这个顶层函数来创建Channel管道。在创建Channel的时候有三个重要参数capacity代表了容量onBufferOverflow代表容量满了以后的应对策略onUndeliveredElement则是一个异常回调。在某些场景下比如“**发送方对于数据是否被接收方十分关心**”的情况下,可以注册这个回调。
* Channel有两个关键的方法send()、receive()前者用于发送管道数据后者用于接收管道数据。但是由于Channel是存在关闭状态的如果我们直接使用receive()就会导致各种问题。因此对于管道数据的接收方来说我们应该尽可能地使用for循环、consumeEach {}。
* Channel是“热”的。这是因为“**不管有没有接收方,发送方都会工作**”。
* 最后我们也分析了Channel的源码定义发现它其实是SendChannel、ReceiveChannel这两个接口的组合。而我们也可以借助它的这个特点实现“对读取开放对写入封闭”的设计。
![](https://static001.geekbang.org/resource/image/89/6f/893c15a694f0ce2b467b9a3220ef446f.jpg?wh=2000x1253)
其实Channel也不是Kotlin独创的概念在某些其他编程语言当中也有这样的组件最典型的就是Go语言。所以当你学会Kotlin的Channel以后在别的语言中再遇到Channel或者是基于Channel的Actor你也就能快速地把Kotlin的知识迁移过去。
另外,学到这里相信你也发现了:编程语言里面的概念都是互通的。为什么有些人学习一门新的编程语言,可以特别快,还学得特别好?
原因往往就是,人家早已掌握了编程语言当中所有互通的概念。这就是所谓的**触类旁通**。学完这门课程以后,我相信,你也可以做到。
## 思考题
请问Channel是“热”的这一特点有什么坏处吗为什么 欢迎在留言区分享你的答案,也欢迎你把今天的内容分享给更多的朋友。