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

619 lines
24 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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.

# 17 | Context万物皆为Context
你好我是朱涛。今天我们来学习Kotlin协程的Context。
协程的Context在Kotlin当中有一个具体的名字叫做CoroutineContext。它是我们理解Kotlin协程非常关键的一环。
从概念上讲CoroutineContext很容易理解它只是个[上下文](https://zh.wikipedia.org/zh-hans/%E4%B8%8A%E4%B8%8B%E6%96%87_(%E8%AE%A1%E7%AE%97%E6%9C%BA))而已实际开发中它最常见的用处就是切换线程池。不过CoroutineContext背后的代码设计其实比较复杂如果不能深入理解它的设计思想那我们在后面阅读协程源码并进一步建立复杂并发结构的时候都将会困难重重。
所以这节课我将会从应用的角度出发带你了解CoroutineContext的使用场景并会对照源码带你理解它的设计思路。另外知识点之间的串联也是很重要的所以我还会带你分析它跟我们前面学的Job、Deferred、launch、async有什么联系让你能真正理解和掌握协程的上下文并建立一个**基于CoroutineContext的协程知识体系**。
## Context的应用
前面说过CoroutineContext就是协程的上下文。你在前面的第14~16讲里其实就已经见过它了。在[第14讲](https://time.geekbang.org/column/article/486305)我介绍launch源码的时候CoroutineContext其实就是函数的第一个参数
```plain
// 代码段1
public fun CoroutineScope.launch(
// 这里
// ↓
context: CoroutineContext = EmptyCoroutineContext,
start: CoroutineStart = CoroutineStart.DEFAULT,
block: suspend CoroutineScope.() -> Unit
): Job {}
```
这里我先说一下之前我们在调用launch的时候都没有传context这个参数因此它会使用默认值EmptyCoroutineContext顾名思义这就是一个空的上下文对象。而如果我们想要指定launch工作的线程池的话就需要自己传context这个参数了。
另外,在[第15讲](https://time.geekbang.org/column/article/487085)里我们在挂起函数getUserInfo()当中也用到了withContext()这个函数当时我们传入的是“Dispatchers.IO”这就是Kotlin官方提供的一个CoroutineContext对象。让我们来回顾一下
```plain
// 代码段2
fun main() = runBlocking {
val user = getUserInfo()
logX(user)
}
suspend fun getUserInfo(): String {
logX("Before IO Context.")
withContext(Dispatchers.IO) {
logX("In IO Context.")
delay(1000L)
}
logX("After IO Context.")
return "BoyCoder"
}
/*
输出结果:
================================
Before IO Context.
Thread:main @coroutine#1
================================
================================
In IO Context.
Thread:DefaultDispatcher-worker-1 @coroutine#1
================================
================================
After IO Context.
Thread:main @coroutine#1
================================
================================
BoyCoder
Thread:main @coroutine#1
================================
*/
```
可以看到当我们在withContext()这里指定线程池以后Lambda当中的代码就会被分发到DefaultDispatcher线程池中去执行而它外部的所有代码仍然还是运行在main之上。
其实Kotlin官方还提供了挂起函数版本的main()函数,所以我们的代码也可以改成这样:
```plain
// 代码段3
suspend fun main() {
val user = getUserInfo()
logX(user)
}
```
不过你要注意的是挂起函数版本的main()的底层做了很多封装虽然它可以帮我们省去写runBlocking的麻烦但不利于我们学习阶段的探索和研究。因此后续的Demo我们仍然以runBlocking为主你只需要知道Kotlin有这么一个东西等到你深入理解协程以后就可以直接用“suspend main()”写Demo了。
我们说回runBlocking这个函数第14讲里我们介绍过它的第一个参数也是CoroutineContext所以我们也可以传入一个Dispatcher对象作为参数
```plain
// 代码段4
// 变化在这里
// ↓
fun main() = runBlocking(Dispatchers.IO) {
val user = getUserInfo()
logX(user)
}
/*
输出结果:
================================
Before IO Context.
Thread:DefaultDispatcher-worker-1 @coroutine#1
================================
================================
In IO Context.
Thread:DefaultDispatcher-worker-1 @coroutine#1
================================
================================
After IO Context.
Thread:DefaultDispatcher-worker-1 @coroutine#1
================================
================================
BoyCoder
Thread:DefaultDispatcher-worker-1 @coroutine#1
================================
*/
```
这时候我们会发现所有的代码都运行在DefaultDispatcher这个线程池当中了。而Kotlin官方除了提供了Dispatchers.IO以外还提供了Dispatchers.Main、Dispatchers.Unconfined、Dispatchers.Default这几种内置Dispatcher。我来分别给你介绍一下
* **Dispatchers.Main**它只在UI编程平台才有意义在Android、Swing之类的平台上一般只有Main线程才能用于UI绘制。这个Dispatcher在普通的JVM工程当中是无法直接使用的。
* **Dispatchers.Unconfined**,代表无所谓,当前协程可能运行在任意线程之上。
* **Dispatchers.Default**它是用于CPU密集型任务的线程池。一般来说它内部的线程个数是与机器CPU核心数量保持一致的不过它有一个最小限制2。
* **Dispatchers.IO**它是用于IO密集型任务的线程池。它内部的线程数量一般会更多一些比如64个具体线程的数量我们可以通过参数来配置kotlinx.coroutines.io.parallelism。
需要特别注意的是Dispatchers.IO底层是可能复用Dispatchers.Default当中的线程的。如果你足够细心的话会发现前面我们用的都是Dispatchers.IO但实际运行的线程却是DefaultDispatcher这个线程池。
为了让这个问题更加清晰,我们可以把上面的例子再改一下:
```plain
// 代码段5
// 变化在这里
// ↓
fun main() = runBlocking(Dispatchers.Default) {
val user = getUserInfo()
logX(user)
}
/*
输出结果:
================================
Before IO Context.
Thread:DefaultDispatcher-worker-1 @coroutine#1
================================
================================
In IO Context.
Thread:DefaultDispatcher-worker-2 @coroutine#1
================================
================================
After IO Context.
Thread:DefaultDispatcher-worker-2 @coroutine#1
================================
================================
BoyCoder
Thread:DefaultDispatcher-worker-2 @coroutine#1
================================
*/
```
当Dispatchers.Default线程池当中有富余线程的时候它是可以被IO线程池复用的。可以看到后面三个结果的输出都是在同一个线程之上的这就是因为Dispatchers.Default被Dispatchers.IO复用线程导致的。如果我们换成自定义的Dispatcher结果就会不一样了。
```plain
// 代码段6
val mySingleDispatcher = Executors.newSingleThreadExecutor {
Thread(it, "MySingleThread").apply { isDaemon = true }
}.asCoroutineDispatcher()
// 变化在这里
// ↓
fun main() = runBlocking(mySingleDispatcher) {
val user = getUserInfo()
logX(user)
}
public fun ExecutorService.asCoroutineDispatcher(): ExecutorCoroutineDispatcher =
ExecutorCoroutineDispatcherImpl(this)
/*
输出结果:
================================
Before IO Context.
Thread:MySingleThread @coroutine#1
================================
================================
In IO Context.
Thread:DefaultDispatcher-worker-1 @coroutine#1
================================
================================
After IO Context.
Thread:MySingleThread @coroutine#1
================================
================================
BoyCoder
Thread:MySingleThread @coroutine#1
================================
*/
```
在上面的代码中我们是通过asCoroutineDispatcher()这个扩展函数创建了一个Dispatcher。从这里我们也能看到Dispatcher的本质仍然还是线程。这也再次验证了我们[之前的说法](https://time.geekbang.org/column/article/485632)**协程运行在线程之上**。
然后在这里当我们为runBlocking传入自定义的mySingleDispatcher以后程序运行的结果就不一样了由于它底层并没有复用线程因此只有“In IO Context”是运行在DefaultDispatcher这个线程池的其他代码都运行在mySingleDispatcher之上。
另外,前面提到的**Dispatchers.Unconfined**我们也要额外注意。还记得之前学习launch的时候我们遇到的例子吗请问下面4行代码它们的执行顺序是怎样的
```plain
// 代码段7
fun main() = runBlocking {
logX("Before launch.") // 1
launch {
logX("In launch.") // 2
delay(1000L)
logX("End launch.") // 3
}
logX("After launch") // 4
}
```
如果你理解了第14讲的内容那你一定能分析出它们的运行顺序应该是1、4、2、3。
但你要注意同样的代码模式在特殊的环境下结果可能会不一样。比如在Android平台或者是如果我们指定了Dispatchers.Unconfined这个特殊的Dispatcher它的这种行为模式也会被打破。比如像这样
```plain
// 代码段8
fun main() = runBlocking {
logX("Before launch.") // 1
// 变化在这里
// ↓
launch(Dispatchers.Unconfined) {
logX("In launch.") // 2
delay(1000L)
logX("End launch.") // 3
}
logX("After launch") // 4
}
/*
输出结果:
================================
Before launch.
Thread:main @coroutine#1
================================
================================
In launch.
Thread:main @coroutine#2
================================
================================
After launch
Thread:main @coroutine#1
================================
================================
End launch.
Thread:kotlinx.coroutines.DefaultExecutor @coroutine#2
================================
*/
```
以上代码的运行顺序就变成了1、2、4、3。这一点就再一次说明了Kotlin协程的难学。传了一个不同的参数进来整个代码的执行顺序都变了这谁不头疼呢最要命的是Dispatchers.Unconfined设计的本意也并不是用来改变代码执行顺序的。
请你留意“End launch”运行的线程“DefaultExecutor”是不是觉得很乱其实Unconfined代表的意思就是**当前协程可能运行在任何线程之上,不作强制要求**。
由此可见Dispatchers.Unconfined其实是很危险的。所以**我们不应该随意使用Dispatchers.Unconfined**。
现在我们也了解了CoroutineContext的常见应用场景。不过我们还没解释这节课的标题什么是“万物皆为Context”
## 万物皆有Context
所谓的“万物皆为Context”当然是一种夸张的说法我们换成“万物皆有Context”可能更加准确。
在Kotlin协程当中但凡是重要的概念都或多或少跟CoroutineContext有关系Job、Dispatcher、CoroutineExceptionHandler、CoroutineScope甚至挂起函数它们都跟CoroutineContext有着密切的联系。甚至它们之中的Job、Dispatcher、CoroutineExceptionHandler本身就是Context。
我这么一股脑地告诉你,你肯定觉得晕乎乎,所以下面我们就一个个来看。
### CoroutineScope
在学习launch的时候我提到过如果要调用launch就必须先有“协程作用域”也就是CoroutineScope。
```plain
// 代码段9
// 注意这里
// ↓
public fun CoroutineScope.launch(
context: CoroutineContext = EmptyCoroutineContext,
start: CoroutineStart = CoroutineStart.DEFAULT,
block: suspend CoroutineScope.() -> Unit
): Job {}
// CoroutineScope 源码
public interface CoroutineScope {
public val coroutineContext: CoroutineContext
}
```
如果你去看CoroutineScope的源码你会发现它其实就是一个简单的接口而这个接口只有唯一的成员就是CoroutineContext。所以CoroutineScope只是对CoroutineContext做了一层封装而已它的核心能力其实都来自于CoroutineContext。
而CoroutineScope最大的作用就是可以方便我们批量控制协程。
```plain
// 代码段10
fun main() = runBlocking {
// 仅用于测试生成环境不要使用这么简易的CoroutineScope
val scope = CoroutineScope(Job())
scope.launch {
logX("First start!")
delay(1000L)
logX("First end!") // 不会执行
}
scope.launch {
logX("Second start!")
delay(1000L)
logX("Second end!") // 不会执行
}
scope.launch {
logX("Third start!")
delay(1000L)
logX("Third end!") // 不会执行
}
delay(500L)
scope.cancel()
delay(1000L)
}
/*
输出结果:
================================
First start!
Thread:DefaultDispatcher-worker-1 @coroutine#2
================================
================================
Third start!
Thread:DefaultDispatcher-worker-3 @coroutine#4
================================
================================
Second start!
Thread:DefaultDispatcher-worker-2 @coroutine#3
================================
*/
```
在上面的代码中我们自己创建了一个简单的CoroutineScope接着我们使用这个scope连续创建了三个协程在500毫秒以后我们就调用了scope.cancel()这样一来代码中每个协程的“end”日志就不会输出了。
这同样体现了协程**结构化并发**的理念相同的功能我们借助Job也同样可以实现。关于CoroutineScope更多的底层细节我们会在源码篇的时候深入学习。
那么接下来我们就看看Job跟CoroutineContext的关系。
### Job和Dispatcher
如果说CoroutineScope是封装了CoroutineContext那么Job就是一个真正的CoroutineContext了。
```plain
// 代码段11
public interface Job : CoroutineContext.Element {}
public interface CoroutineContext {
public interface Element : CoroutineContext {}
}
```
上面这段代码很有意思Job继承自CoroutineContext.Element而CoroutineContext.Element仍然继承自CoroutineContext这就意味着Job是间接继承自CoroutineContext的。所以说Job确实是一个真正的CoroutineContext。
所以,我们写这样的代码也完全没问题:
```plain
// 代码段12
fun main() = runBlocking {
val job: CoroutineContext = Job()
}
```
不过更有趣的是CoroutineContext本身的接口设计。
```plain
// 代码段13
public interface CoroutineContext {
public operator fun <E : Element> get(key: Key<E>): E?
public operator fun plus(context: CoroutineContext): CoroutineContext {}
public fun minusKey(key: Key<*>): CoroutineContext
public fun <R> fold(initial: R, operation: (R, Element) -> R): R
public interface Key<E : Element>
}
```
从上面代码中的get()、plus()、minusKey()、fold()这几个方法我们可以看到CoroutineContext的接口设计就跟集合API一样。准确来说它的API设计和Map十分类似。
![图片](https://static001.geekbang.org/resource/image/a6/26/a611d29c307f953ebb099554a06a5d26.png?wh=1429x627)
所以,我们完全可以**把CoroutineContext当作Map来用**。
```plain
// 代码段14
@OptIn(ExperimentalStdlibApi::class)
fun main() = runBlocking {
// 注意这里
val scope = CoroutineScope(Job() + mySingleDispatcher)
scope.launch {
// 注意这里
logX(coroutineContext[CoroutineDispatcher] == mySingleDispatcher)
delay(1000L)
logX("First end!") // 不会执行
}
delay(500L)
scope.cancel()
delay(1000L)
}
/*
输出结果:
================================
true
Thread:MySingleThread @coroutine#2
================================
*/
```
在上面的代码中我们使用了“Job() + mySingleDispatcher”这样的方式创建CoroutineScope代码之所以这么写是因为CoroutineContext的plus()进行了**操作符重载**。
```plain
// 代码段15
// 操作符重载
// ↓
public operator fun <E : Element> plus(key: Key<E>): E?
```
你注意这里代码中的**operator关键字**如果少了它我们就得换一种方式了mySingleDispatcher.plus(Job())。因为当我们用operator修饰plus()方法以后,就可以用“+”来重载这个方法类似的List和Map都支持这样的写法list3 = list1+list2、map3 = map1 + map2这代表集合之间的合并。
另外我们还使用了“coroutineContext\[CoroutineDispatcher\]”这样的方式访问当前协程所对应的Dispatcher。这也是因为CoroutineContext的get(),支持了**操作符重载**。
```plain
// 代码段16
// 操作符重载
// ↓
public operator fun <E : Element> get(key: Key<E>): E?
```
实际上在Kotlin当中很多集合也是支持get()方法重载的比如List、Map我们都可以使用这样的语法list\[0\]、map\[key\],以数组下标的方式来访问集合元素。
还记得我们在[第1讲](https://time.geekbang.org/column/article/472154)提到的“集合与数组的访问方式一致”这个知识点吗现在我们知道了这都要归功于操作符重载。实际上Kotlin官方的源代码当中大量使用了操作符重载来简化代码逻辑而CoroutineContext就是一个最典型的例子。
如果你足够细心的话这时候你应该也发现了Dispatcher本身也是CoroutineContext不然它怎么可以实现“Job() + mySingleDispatcher”这样的写法呢最重要的是当我们以这样的方式创建出scope以后后续创建的协程就全部都运行在mySingleDispatcher这个线程之上了。
那么,**Dispatcher到底是如何跟CoroutineContext建立关系的呢**让我们来看看它的源码吧。
```plain
// 代码段17
public actual object Dispatchers {
public actual val Default: CoroutineDispatcher = DefaultScheduler
public actual val Main: MainCoroutineDispatcher get() = MainDispatcherLoader.dispatcher
public actual val Unconfined: CoroutineDispatcher = kotlinx.coroutines.Unconfined
public val IO: CoroutineDispatcher = DefaultIoScheduler
public fun shutdown() { }
}
public abstract class CoroutineDispatcher :
AbstractCoroutineContextElement(ContinuationInterceptor), ContinuationInterceptor {}
public interface ContinuationInterceptor : CoroutineContext.Element {}
```
可以看到Dispatchers其实是一个object单例它的内部成员的类型是CoroutineDispatcher而它又是继承自ContinuationInterceptor这个类则是实现了CoroutineContext.Element接口。由此可见Dispatcher确实就是CoroutineContext。
### 其他CoroutineContext
除了上面几个重要的CoroutineContext之外协程其实还有一些上下文是我们还没提到的。比如**CoroutineName**,当我们创建协程的时候,可以传入指定的名称。比如:
```plain
// 代码段18
@OptIn(ExperimentalStdlibApi::class)
fun main() = runBlocking {
val scope = CoroutineScope(Job() + mySingleDispatcher)
// 注意这里
scope.launch(CoroutineName("MyFirstCoroutine!")) {
logX(coroutineContext[CoroutineDispatcher] == mySingleDispatcher)
delay(1000L)
logX("First end!")
}
delay(500L)
scope.cancel()
delay(1000L)
}
/*
输出结果:
================================
true
Thread:MySingleThread @MyFirstCoroutine!#2 // 注意这里
================================
*/
```
在上面的代码中我们调用launch的时候传入了“CoroutineName(“MyFirstCoroutine!”)”作为协程的名字。在后面输出的结果中,我们得到了“@MyFirstCoroutine!#2”这样的输出。由此可见其中的数字“2”其实是一个自增的唯一ID。
CoroutineContext当中还有一个重要成员是**CoroutineExceptionHandler**,它主要负责处理协程当中的异常。
```plain
// 代码段19
public interface CoroutineExceptionHandler : CoroutineContext.Element {
public companion object Key : CoroutineContext.Key<CoroutineExceptionHandler>
public fun handleException(context: CoroutineContext, exception: Throwable)
}
```
可以看到CoroutineExceptionHandler的接口定义其实很简单我们基本上一眼就能看懂。CoroutineExceptionHandler真正重要的其实只有handleException()这个方法,如果我们要自定义异常处理器,我们就只需要实现该方法即可。
```plain
// 代码段20
//  这里使用了挂起函数版本的main()
suspend fun main() {
    val myExceptionHandler = CoroutineExceptionHandler { _, throwable ->
        println("Catch exception: $throwable")
    }
    val scope = CoroutineScope(Job() + mySingleDispatcher)
    val job = scope.launch(myExceptionHandler) {
        val s: String? = null
        s!!.length // 空指针异常
    }
    job.join()
}
/*
输出结果:
Catch exception: java.lang.NullPointerException
*/
```
不过虽然CoroutineExceptionHandler的用法看起来很简单但当它跟协程“结构化并发”理念相结合以后内部的异常处理逻辑是很复杂的。关于协程异常处理的机制我们会在第23讲详细介绍。
## 小结
这节课的内容到这里就结束了,我们来总结一下吧。
* CoroutineContext是Kotlin协程当中非常关键的一个概念。它本身是一个接口但它的接口设计与Map的API极为相似我们在使用的过程中也可以把它**当作Map来用**。
* 协程里很多重要的类它们本身都是CoroutineContext。比如Job、Deferred、Dispatcher、ContinuationInterceptor、CoroutineName、CoroutineExceptionHandler它们都继承自CoroutineContext这个接口。也正因为它们都继承了CoroutineContext接口所以我们可以通过**操作符重载**的方式写出更加灵活的代码比如“Job() + mySingleDispatcher+CoroutineName(“MyFirstCoroutine!”)”。
* 协程当中的CoroutineScope本质上也是CoroutineContext的一层**简单封装**。
* 另外协程里极其重要的“挂起函数”它与CoroutineContext之间也有着非常紧密的联系。
另外我也画了一张结构图来描述CoroutineContext元素之间的关系方便你建立完整的知识体系。
![](https://static001.geekbang.org/resource/image/eb/76/eb225787718e0d2cff8a55bcba86yy76.jpg?wh=2000x1125)
所以总的来说我们前面学习的Job、Dispatcher、CoroutineName它们本质上只是CoroutieContext这个集合当中的一种数据类型只是恰好Kotlin官方让它们都继承了CoroutineContext这个接口。而CoroutineScope则是对CoroutineContext的进一步封装它的核心能力全部都是源自于CoroutineContext。
## 思考题
课程里我提到了“挂起函数”与CoroutineContext也有着紧密的联系请问你能找到具体的证据吗或者你觉得下面的代码能成功运行吗为什么
```
// 代码段21
import kotlinx.coroutines.*
import kotlin.coroutines.coroutineContext
// 挂起函数能可以访问协程上下文吗?
// ↓
suspend fun testContext() = coroutineContext
fun main() = runBlocking {
println(testContext())
}
```
欢迎在留言区分享你的答案,也欢迎你把今天的内容分享给更多的朋友。