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

26 KiB
Raw Permalink Blame History

28 | launch的背后到底发生了什么

你好,我是朱涛。

在前面的课程里我们一直在研究如何使用Kotlin协程比如如何启动协程如何使用挂起函数如何使用Channel、Flow等API。但到目前为止我们只知道该怎么用协程对它内部的运行机制并没有深究。

现在我们都知道launch、async可以创建、启动新的协程但我们只能通过调试参数通过log看到协程。比如我们可以回过头来看下第13讲当中的代码:

// 代码段1

// 代码中一共启动了两个协程
fun main() = runBlocking {
    println(Thread.currentThread().name)

    launch {
        println(Thread.currentThread().name)
        delay(100L)
    }

    Thread.sleep(1000L)
}

/*
输出结果:
main @coroutine#1
main @coroutine#2
*/

现在回过头来看这段代码无疑是非常简单的runBlocking{} 启动了第一个协程launch{} 启动了第二个协程。可是,有一个问题,我们一直都没有找到答案:协程到底是如何创建的?它对应的源代码,到底在哪个类?具体在哪一行?

我们常说Java线程的源代码是Thread.java这样说虽然不一定准确但我们起码能看到几个暴露出来的方法。那么在Kotlin协程当中有没有类似Coroutine.kt的类呢对于这些问题我们唯有去阅读Kotlin协程的源码、去分析launch的启动流程才能找到答案。

这节课,我就将从第26讲当中提到的createCoroutine{}、startCoroutine{} 这两个函数开始说起在认识了这两个协程基础元素以后我们就会进入协程的“中间层”开始分析launch的源代码。我相信学完这节课以后你一定会对Kotlin协程有一个更加透彻的认识。

协程启动的基础API

在第26讲里我给你留了一个思考题Continuation.kt这个文件当中,还有两个重要的扩展函数:

// 代码段2

public fun <T> (suspend () -> T).createCoroutine(
    completion: Continuation<T>
): Continuation<Unit> =
    SafeContinuation(createCoroutineUnintercepted(completion).intercepted(), COROUTINE_SUSPENDED)

public fun <T> (suspend () -> T).startCoroutine(
    completion: Continuation<T>
) {
    createCoroutineUnintercepted(completion).intercepted().resume(Unit)
}

其实createCoroutine{}、startCoroutine{}这两个函数就是Kotlin协程当中最基础的两个创建协程的API。

我们在第14讲里曾经提到过启动协程有三种常见的方式launch、runBlocking、async。它们其实属于协程中间层提供的API而它们的底层都在某种程度上调用了“基础层”的协程API。

那么,这是不是就意味着:我们使用协程的基础层API也可以创建协程呢

答案当然是肯定的。我们可以来分析一下代码段2当中的函数签名。

createCoroutine{}、startCoroutine{},它们都是扩展函数,其扩展接收者类型是一个函数类型:suspend () -> T代表了“无参数返回值为T的挂起函数或者Lambda”。而对于函数本身它们两个都接收一个 Continuation<T> 类型的参数,其中一个函数,还会返回一个 Continuation<Unit> 类型的返回值。

也许你对于“给函数类型增加扩展”这样的行为会感到不太适应。不过在Kotlin当中函数就是一等公民,普通的类型可以有扩展,那么,函数类型自然也可以有扩展。因此,我们完全可以写出像下面这样的代码:

// 代码段3

fun main() {
    testStartCoroutine()
    Thread.sleep(2000L)
}

val block = suspend {
    println("Hello!")
    delay(1000L)
    println("World!")
    "Result"
}

private fun testStartCoroutine() {

    val continuation = object : Continuation<String> {
        override val context: CoroutineContext
            get() = EmptyCoroutineContext

        override fun resumeWith(result: Result<String>) {
            println("Result is: ${result.getOrNull()}")
        }
    }

    block.startCoroutine(continuation)
}

/*
输出结果
Hello!
World!
Result is: Result
*/

在这段代码中我们定义了一个Lambda表达式block它的类型就是 suspend () -> T。这样一来我们就可以用block.startCoroutine()来启动协程了。这里我们还创建了一个匿名内部类对象continuation作为startCoroutine()的参数。

加餐我们提到过Continuation主要有两种用法一种是在实现挂起函数的时候用于传递挂起函数的执行结果;另一种是在调用挂起函数的时候,以匿名内部类的方式,用于接收挂起函数的执行结果。而代码段3中Continuation的作用则明显属于后者。

从代码段3的执行结果中我们可以看出来startCoroutine()的作用其实就是创建一个新的协程并且执行block当中的逻辑等协程执行完毕以后将结果返回给Continuation对象。而这个逻辑我们使用 createCoroutine() 这个方法其实也可以实现。

代码段4

private fun testCreateCoroutine() {

    val continuation = object : Continuation<String> {
        override val context: CoroutineContext
            get() = EmptyCoroutineContext

        override fun resumeWith(result: Result<String>) {
            println("Result is: ${result.getOrNull()}")
        }
    }

    val coroutine = block.createCoroutine(continuation)

    coroutine.resume(Unit)
}

/*
输出结果
Hello!
World!
Result is: Result
*/

根据以上代码我们可以看到createCoroutine()的作用其实就是创建一个协程并暂时先不启动它。等我们想要启动它的时候直接调用resume()即可。如果我们再进一步分析代码段2当中的源代码会发现createCoroutine()、startCoroutine()的源代码差别也并不大只是前者没有调用resume()而后者调用了resume()。

换句话说startCoroutine()之所以可以创建并同时启动协程的原因就在于它在源码中直接调用了resume(Unit)所以我们在代码段3当中就不需要自己调用resume()方法了。

那么下面我们就以startCoroutine()为例来研究下它的实现原理。我们把代码段3反编译成Java看看它会变成什么样子

// 代码段5

public final class LaunchUnderTheHoodKt {
    // 1
    public static final void main() {
        testStartCoroutine();
        Thread.sleep(2000L);
    }

    // 2
    private static final Function1<Continuation<? super String>, Object> block = new LaunchUnderTheHoodKt$block$1(null);

    // 3
    public static final Function1<Continuation<? super String>, Object> getBlock() {
        return block;
    }
    // 4
    static final class LaunchUnderTheHoodKt$block$1 extends SuspendLambda implements Function1<Continuation<? super String>, Object> {
        int label;

        LaunchUnderTheHoodKt$block$1(Continuation $completion) {
          super(1, $completion);
        }

        @Nullable
        public final Object invokeSuspend(@NotNull Object $result) {
          Object object = IntrinsicsKt.getCOROUTINE_SUSPENDED();
          switch (this.label) {
            case 0:
              ResultKt.throwOnFailure(SYNTHETIC_LOCAL_VARIABLE_1);
              System.out
                .println("Hello!");
              this.label = 1;
              if (DelayKt.delay(1000L, (Continuation)this) == object)
                return object; 
              DelayKt.delay(1000L, (Continuation)this);
              System.out
                .println("World!");
              return "Result";
            case 1:
              ResultKt.throwOnFailure(SYNTHETIC_LOCAL_VARIABLE_1);
              System.out.println("World!");
              return "Result";
          } 
          throw new IllegalStateException("call to 'resume' before 'invoke' with coroutine");
        }

        @NotNull
        public final Continuation<Unit> create(@NotNull Continuation<? super LaunchUnderTheHoodKt$block$1> $completion) {
          return (Continuation<Unit>)new LaunchUnderTheHoodKt$block$1($completion);
        }

        @Nullable
        public final Object invoke(@Nullable Continuation<?> p1) {
          return ((LaunchUnderTheHoodKt$block$1)create(p1)).invokeSuspend(Unit.INSTANCE);
        }
    }

    // 5
    private static final void testStartCoroutine() {
        LaunchUnderTheHoodKt$testStartCoroutine$continuation$1 continuation = new LaunchUnderTheHoodKt$testStartCoroutine$continuation$1();
        ContinuationKt.startCoroutine(block, continuation);
    }

    // 6
    public static final class LaunchUnderTheHoodKt$testStartCoroutine$continuation$1 implements Continuation<String> {
        @NotNull
        public CoroutineContext getContext() {
          return (CoroutineContext)EmptyCoroutineContext.INSTANCE;
        }

        public void resumeWith(@NotNull Object result) {
          System.out.println(Intrinsics.stringPlus("Result is: ", Result.isFailure-impl(result) ? null : result));
        }
    }
}


internal abstract class SuspendLambda(
    public override val arity: Int,
    completion: Continuation<Any?>?
) : ContinuationImpl(completion), FunctionBase<Any?>, SuspendFunction {}

上面的反编译代码中一共有6个注释我们一个个来看

  • 注释1是我们的main()函数。由于它本身只是一个普通的函数,因此反编译之后,逻辑并没有什么变化。
  • 注释2、3它们是Kotlin为block变量生成的静态变量以及方法。
  • 注释4LaunchUnderTheHoodKt$block$1其实就是block具体的实现类。这个类继承自SuspendLambda而SuspendLambda是ContinuationImpl的子类因此它也间接实现了Continuation接口。其中的invokeSuspend(),也就是我们在上节课分析过的协程状态机逻辑。除此之外它还有一个create()方法,我们在后面会来分析它。
  • 注释5它对应了testStartCoroutine()这个方法,原本的 block.startCoroutine(continuation) 变成了“ContinuationKt.startCoroutine(block, continuation)”,这其实就体现出了扩展函数的原理。
  • 注释6其实就是continuation变量对应的匿名内部类。

那么接下来,我们就可以对照着反编译代码,来分析整个代码的执行流程了。

首先main()函数会调用testStartCoroutine()函数接着就会调用startCoroutine()方法。

// 代码段6

public fun <T> (suspend () -> T).startCoroutine(
    completion: Continuation<T>
) {
//        注意这里
//           ↓
createCoroutineUnintercepted(completion).intercepted().resume(Unit)
}

从代码段6里我们可以看到在startCoroutine()当中首先会调用createCoroutineUnintercepted()方法。如果我们直接去看它的源代码,会发现它只存在一个声明,并没有具体实现:

// 代码段7

//    注意这里
//       ↓
public expect fun <T> (suspend () -> T).createCoroutineUnintercepted(
    completion: Continuation<T>
): Continuation<Unit>

上面代码中的expect我们可以把它理解为一种声明由于Kotlin是面向多个平台的具体的实现就需要在特定的平台实现。所以在这里我们就需要打开Kotlin的源代码找到JVM平台对应的实现

// 代码段8

//    1注意这里
//       ↓
public actual fun <T> (suspend () -> T).createCoroutineUnintercepted(
    completion: Continuation<T>
): Continuation<Unit> {
    val probeCompletion = probeCoroutineCreated(completion)
    //             2注意这里
    //               ↓
    return if (this is BaseContinuationImpl)
        create(probeCompletion)
    else
        createCoroutineFromSuspendFunction(probeCompletion) {
            (this as Function1<Continuation<T>, Any?>).invoke(it)
        }
}

请留意这里的注释1这个actual代表了createCoroutineUnintercepted()在JVM平台的实现。

另外我们可以看到createCoroutineUnintercepted()仍然还是一个扩展函数注释2处的this其实就代表了前面代码段3当中的block变量。我们结合代码段5反编译出来的 LaunchUnderTheHoodKt$block$1可以知道block其实就是SuspendLambda的子类而SuspendLambda则是ContinuationImpl的子类。

因此注释2处的 (this is BaseContinuationImpl) 条件一定是为 true 的。这时候,它就会调用 create(probeCompletion)

然后如果你去查看create()的源代码,会看到这样的代码:

// 代码段9

public open fun create(completion: Continuation<*>): Continuation<Unit> {
    throw UnsupportedOperationException("create(Continuation) has not been overridden")
}

可以看到在默认情况下这个create()方法是会抛出异常的它的提示信息是create()方法没有被重写潜台词就是create()方法应该被重写!如果不被重写,就会抛出异常。

那么,**create()方法是在哪里被重写的呢?**答案其实就在代码段5的“LaunchUnderTheHoodKt$block$1”这个block的实现类当中。

// 代码段10

static final class LaunchUnderTheHoodKt$block$1 extends SuspendLambda implements Function1<Continuation<? super String>, Object> {
    int label;

    LaunchUnderTheHoodKt$block$1(Continuation $completion) {
      super(1, $completion);
    }

    @Nullable
    public final Object invokeSuspend(@NotNull Object $result) {
      Object object = IntrinsicsKt.getCOROUTINE_SUSPENDED();
      switch (this.label) {
        case 0:
          ResultKt.throwOnFailure(SYNTHETIC_LOCAL_VARIABLE_1);
          System.out
            .println("Hello!");
          this.label = 1;
          if (DelayKt.delay(1000L, (Continuation)this) == object)
            return object; 
          DelayKt.delay(1000L, (Continuation)this);
          System.out
            .println("World!");
          return "Result";
        case 1:
          ResultKt.throwOnFailure(SYNTHETIC_LOCAL_VARIABLE_1);
          System.out.println("World!");
          return "Result";
      } 
      throw new IllegalStateException("call to 'resume' before 'invoke' with coroutine");
    }

    // 1注意这里
    public final Continuation<Unit> create(@NotNull Continuation<? super LaunchUnderTheHoodKt$block$1> $completion) {
      return (Continuation<Unit>)new LaunchUnderTheHoodKt$block$1($completion);
    }

    @Nullable
    public final Object invoke(@Nullable Continuation<?> p1) {
      return ((LaunchUnderTheHoodKt$block$1)create(p1)).invokeSuspend(Unit.INSTANCE);
    }
}

这里你可以留意下代码里的注释1这个其实就是重写之后的create()方法。换句话说代码段8当中的 create(probeCompletion)最终会调用代码段10的create()方法,它最终会返回“LaunchUnderTheHoodKt$block$1”这个block实现类对应的Continuation对象。

这行代码,其实就对应着协程被创建的时刻。

到这里协程创建的逻辑就分析完了我们再回到startCoroutine()的源码,看看它后续的逻辑。

// 代码段11

public fun <T> (suspend () -> T).startCoroutine(
    completion: Continuation<T>
) {
//                                           注意这里
//                                             ↓
createCoroutineUnintercepted(completion).intercepted().resume(Unit)
}

类似的intercepted()这个方法的源代码我们也需要去Kotlin的源代码当中找到对应的JVM实现。

// 代码段12

public actual fun <T> Continuation<T>.intercepted(): Continuation<T> =
    (this as? ContinuationImpl)?.intercepted() ?: this

它的逻辑很简单只是将Continuation强转成了ContinuationImpl调用了它的intercepted()。这里有个细节由于this的类型是“LaunchUnderTheHoodKt$block$1它是ContinuationImpl的子类所以这个类型转换一定可以成功。

接下来我们看看ContinuationImpl的源代码。

// 代码段13

internal abstract class ContinuationImpl(
    completion: Continuation<Any?>?,
    private val _context: CoroutineContext?
) : BaseContinuationImpl(completion) {

    @Transient
    private var intercepted: Continuation<Any?>? = null

    public fun intercepted(): Continuation<Any?> =
        intercepted
            ?: (context[ContinuationInterceptor]?.interceptContinuation(this) ?: this)
                .also { intercepted = it }
}

这里其实就是通过ContinuationInterceptor对Continuation进行拦截从而将程序的执行逻辑派发到特定的线程之上这部分的逻辑我们在下一讲会再展开。

让我们回到startCoroutine()的源码,看看它的最后一步 resume(Unit)

// 代码段14

public fun <T> (suspend () -> T).startCoroutine(
    completion: Continuation<T>
) {
//                                                   注意这里
//                                                      ↓
createCoroutineUnintercepted(completion).intercepted().resume(Unit)
}

这里的 resume(Unit),作用其实就相当于启动了协程。

现在我们已经弄清楚了startCoroutine()这个协程的基础API是如何启动协程的了。接下来我们来看看中间层的launch{} 函数是如何启动协程的。

launch是如何启动协程的

在研究launch的源代码之前我们先来写一个简单的Demo

// 代码段15

fun main() {
    testLaunch()
    Thread.sleep(2000L)
}

private fun testLaunch() {
    val scope = CoroutineScope(Job())
    scope.launch {
        println("Hello!")
        delay(1000L)
        println("World!")
    }
}

/*
输出结果:
Hello!
World!
*/

然后我们还是通过反编译来看看它对应的Java代码长什么样

// 代码段16

public final class LaunchUnderTheHoodKt {
  public static final void main() {
    testLaunch();
    Thread.sleep(2000L);
  }

  private static final void testLaunch() {
    CoroutineScope scope = CoroutineScopeKt.CoroutineScope((CoroutineContext)JobKt.Job$default(null, 1, null));
    BuildersKt.launch$default(scope, null, null, new LaunchUnderTheHoodKt$testLaunch$1(null), 3, null);
  }

  static final class LaunchUnderTheHoodKt$testLaunch$1 extends SuspendLambda implements Function2<CoroutineScope, Continuation<? super Unit>, Object> {
    int label;

    LaunchUnderTheHoodKt$testLaunch$1(Continuation $completion) {
      super(2, $completion);
    }

    @Nullable
    public final Object invokeSuspend(@NotNull Object $result) {
      Object object = IntrinsicsKt.getCOROUTINE_SUSPENDED();
      switch (this.label) {
        case 0:
          ResultKt.throwOnFailure(SYNTHETIC_LOCAL_VARIABLE_1);
          System.out
            .println("Hello!");
          this.label = 1;
          if (DelayKt.delay(1000L, (Continuation)this) == object)
            return object; 
          DelayKt.delay(1000L, (Continuation)this);
          System.out
            .println("World!");
          return Unit.INSTANCE;
        case 1:
          ResultKt.throwOnFailure(SYNTHETIC_LOCAL_VARIABLE_1);
          System.out.println("World!");
          return Unit.INSTANCE;
      } 
      throw new IllegalStateException("call to 'resume' before 'invoke' with coroutine");
    }

    @NotNull
    public final Continuation<Unit> create(@Nullable Object value, @NotNull Continuation<? super LaunchUnderTheHoodKt$testLaunch$1> $completion) {
      return (Continuation<Unit>)new LaunchUnderTheHoodKt$testLaunch$1($completion);
    }

    @Nullable
    public final Object invoke(@NotNull CoroutineScope p1, @Nullable Continuation<?> p2) {
      return ((LaunchUnderTheHoodKt$testLaunch$1)create(p1, p2)).invokeSuspend(Unit.INSTANCE);
    }
  }
}

有了前面的经验,上面的代码对我们来说就很简单了。唯一需要注意的是“LaunchUnderTheHoodKt$testLaunch$1”这个类它其实对应的就是我们launch当中的Lambda。

为了让它们之间的对应关系更加明显,我们可以换一种写法:

// 代码段17

private fun testLaunch() {
    val scope = CoroutineScope(Job())
    val block: suspend CoroutineScope.() -> Unit = {
        println("Hello!")
        delay(1000L)
        println("World!")
    }
    scope.launch(block = block)
}

这段代码中的block其实就对应着“LaunchUnderTheHoodKt$testLaunch$1”这个类。这里的block本质上仍然是一个Continuation

接下来我们来看看launch{} 的源代码。

public fun CoroutineScope.launch(
    context: CoroutineContext = EmptyCoroutineContext,
    start: CoroutineStart = CoroutineStart.DEFAULT,
    block: suspend CoroutineScope.() -> Unit
): Job {
    // 1
    val newContext = newCoroutineContext(context)
    // 2
    val coroutine = if (start.isLazy)
        LazyStandaloneCoroutine(newContext, block) else
        StandaloneCoroutine(newContext, active = true)
    // 3
    coroutine.start(start, coroutine, block)
    return coroutine
}

上面的代码一共有三个注释,我们也来分析一下:

  • 注释1launch会根据传入的CoroutineContext创建出新的Context。
  • 注释2launch会根据传入的启动模式来创建对应的协程对象。这里有两种一种是标准的一种是懒加载的。
  • 注释3尝试启动协程。

我们跟进coroutine.start()这个方法会进入AbstractCoroutine这个抽象类

public abstract class AbstractCoroutine<in T>(
    parentContext: CoroutineContext,
    initParentJob: Boolean,
    active: Boolean
) : JobSupport(active), Job, Continuation<T>, CoroutineScope {

    // 省略

    public fun <R> start(start: CoroutineStart, receiver: R, block: suspend R.() -> T) {
        start(block, receiver, this)
    }
}

到这里我们其实就能看到Java当中有Thread.java对应线程的逻辑而Kotlin协程当中也有AbstractCoroutine.kt这个类对应协程的抽象逻辑。AbstractCoroutine有一个start()方法,专门用于启动协程。

我们继续跟进 start(block, receiver, this)就会进入CoroutineStart.invoke()。

public enum class CoroutineStart {
    public operator fun <T> invoke(block: suspend () -> T, completion: Continuation<T>): Unit =
        when (this) {
            DEFAULT -> block.startCoroutineCancellable(completion)
            ATOMIC -> block.startCoroutine(completion)
            UNDISPATCHED -> block.startCoroutineUndispatched(completion)
            LAZY -> Unit // will start lazily
        }
}

在这个invoke()方法当中它会根据launch传入的启动模式以不同的方式启动协程。当我们的启动模式是ATOMIC的时候就会调用 block.startCoroutine(completion)而这个其实就是我们在课程最开始研究过的startCoroutine()这个协程基础API。

而另外两个方法,startCoroutineUndispatched(completion)startCoroutineCancellable(completion)我们从名字上也能判断出它们只是在startCoroutine()的基础上增加了一些额外的功能而已。前者代表启动协程以后就不会被分发,后者代表启动以后可以响应取消。

然后对于代码段15的launch逻辑而言由于我们没有传入特定的启动模式因此这里会执行默认的模式也就是调用“startCoroutineCancellable(completion)”这个方法。

public fun <T> (suspend () -> T).startCoroutineCancellable(completion: Continuation<T>): Unit = runSafely(completion) {
    // 1
    createCoroutineUnintercepted(completion).intercepted().resumeCancellableWith(Result.success(Unit))
}

public actual fun <T> (suspend () -> T).createCoroutineUnintercepted(
    completion: Continuation<T>
): Continuation<Unit> {
    val probeCompletion = probeCoroutineCreated(completion)

    return if (this is BaseContinuationImpl)
        // 2
        create(probeCompletion)
    else
        createCoroutineFromSuspendFunction(probeCompletion) {
            (this as Function1<Continuation<T>, Any?>).invoke(it)
        }
}

那么通过查看startCoroutineCancellable()的源代码,我们能发现,它最终还是会调用我们之前分析过的 createCoroutineUnintercepted(),而在它的内部,仍然会像我们之前分析过的,去调用 create(probeCompletion)然后最终会调用代码段16当中“LaunchUnderTheHoodKt$testLaunch$1”的 create() 方法。

至此launch启动协程的整个过程我们就已经分析完了。其实launch这个API只是对协程的基础元素startCoroutine()等方法进行了一些封装而已。

看完这么多的代码和文字相信你可能已经有一些感觉了不过可能对整个流程还是有些模糊。这里我做了一个视频描述了launch的执行流程。

小结

createCoroutine{}、startCoroutine{}它们是Kotlin提供的两个底层API前者是用来创建协程的后者是用来创建并同时启动协程的。

通过反编译我们发现startCoroutine{} 最终会调用createCoroutineUnintercepted()这个函数而它在JVM平台的实现就是调用Lambda对应的实现类“LaunchUnderTheHoodKt$block$1”当中的create()方法。

另外Kotlin协程框架在中间层实现了launch、async之类的协程构建器Builder你要知道它们只是对协程底层API进行了更好的封装而已。它们除了拥有启动协程的基础能力还支持传入CoroutineContext、CoroutineStart等参数前者可以帮我们实现结构化并发后者可以支持更灵活的启动模式。

思考题

在代码段3当中我们使用的是 suspend {} 启动的协程,它的类型是 suspend () -> String。那么,我们是否可以使用挂起函数启动协程呢?就像下面这样:

private suspend fun func(): String {
    println("Hello!")
    delay(1000L)
    println("World!")
    return "Result"
}

private fun testStartCoroutineForSuspend() {
    val block = ::func

    val continuation = object : Continuation<String> {
        override val context: CoroutineContext
            get() = EmptyCoroutineContext

        override fun resumeWith(result: Result<String>) {
            println("Result is: ${result.getOrNull()}")
        }
    }

    block.startCoroutine(continuation)
}

如果使用这种方式启动协程它的整体执行流程和代码段3会有什么不一样吗欢迎在留言区分享你的答案也欢迎你把今天的内容分享给更多的朋友。