Skip to content

Latest commit

 

History

History
564 lines (423 loc) · 31 KB

README.md

File metadata and controls

564 lines (423 loc) · 31 KB
Raw

原文链接： A Bottom-Up View of Kotlin Coroutines - Garth Gilmour / Eamonn Boyle，2020-01-11

🍎 译序

Kotlin的协程应该是Java生态中最好的协程实现，在生产环境（Android / 后端场景）也有比较多实际应用。在移动Android开发中，Google宣导Kotlin-First。而在后端开发中，Spring 5 / Spring Boot一等公民支持Kotlin语言，也添加了对Kotlin协程的支持；相信有后端开发框架王者Spring的加持，Kotlin语言与Kotlin协程的发展普及有着乐观的前景。

无论是Kotlin语言还是Kotlin协程，都非常注重务实与开发者友好：

  • Kotlin语言：相对Java，
    • 方便简洁。如字符串插值、smart cast、data class、统一原生类型与包装类型、扩展方法、命名参数、默认参数
    • 安全。如有效解决Java中司空见惯NullPointerException的非空类型
  • Kotlin协程：以大家习惯的命令式/过程式的编程方式写出非阻塞的高效并发程序。

但并发编程是计算机最复杂的主题之一，即使是用协程的编写方式；再者Kotlin协程的友好使用方式，对于使用者理解协程背后的运行机制其实反而是个障碍。而真正的理解协程才能让使用协程做到心中有数避免踩坑。这篇文章自底向上视角的讲解方式，正是有意于正面解决这个问题：如何有效理解Kotlin协程的运行机制。

考虑到原文中只给了代码示例但没有给出代码工程，不方便读者直接运行起来以跟着文章自己探索，译者提供了示例代码的可运行代码工程，参见GitHub仓库：oldratlee/kotlin-coroutines-bottom-up。

自己理解有限，翻译中不足和不对之处，欢迎建议（提交Issue）和指正（Fork后提Pull Request）。

理解Kotlin协程：自底向上的视角

0. 关键要点

  • JVM没有原生支持协程（coroutines）
  • Kotlin实现协程方式是，在编译器中将代码转换为状态机
  • 实现协程，Kotlin语言只用了一个关键字，剩下的通过库来实现
  • Kotlin使用延续传递风格（Continuation Passing Style/CPS）来实现协程
  • 协程使用了调度器（dispatchers），因此在JavaFX、Android、Swing等中使用方式略有不同

协程是一个令人着迷的主题，尽管并不是一个新话题。正如其他地方提到的，协程这些年来已经被多次重新发现挖掘出来，通常是作为轻量级线程（lightweight threading）或『回调地狱』（callback hell）的解决方案。

最近在JVM上，协程已成为反应式编程（Reactive Programming）的一种替代方法。诸如RxJava或Project Reactor之类的框架为客户端提供了一种增量处理传入信息的方式，并且对节流（throttling）和并行（parallelism）提供了广泛的支持。但是，必须围绕反应流（reactive streams）上的函数式操作（functional operations）来重新组织代码，在很多情况下这样做的成本是高过收益的。

这就是为什么像Android社区会对更简单的替代方案有需求的原因。Kotlin语言引入协程作为一个实验功能来满足这个需求，并且经过改进后已成为Kotlin 1.3的正式功能。Kotlin协程的采用范围已从UI开发拓展到服务器端框架（比如Spring 5添加了支持），甚至是像Arrow之类的函数式框架（通过Arrow Fx）。

1. 协程的理解挑战

不幸的是理解协程并非易事。尽管有非常多Kotlin专家的协程分享，但主要是关于协程是什么（或是协程的用法）这方面的见解和介绍。你可能会说协程是并行编程的单子🙂。

而要理解协程有挑战的其实是底层实现。在Kotlin协程，编译器仅实现 suspend 关键字，其他所有内容都由协程库处理。结果是，Kotlin协程非常强大和灵活，但同时也显得用无定形。对于新手来说，这是学习障碍，而在初学一个东西时就给到固定一致的准则和原则是最好的。本文有意于提供这个基础，自底向上地介绍协程。

2. 示例应用

2.1 示例应用（服务端）

示例应用是一个典型问题：安全有效地对RESTful服务进行多次调用。播放《威利在哪里？》的文字版 —— 用户要追踪一个连着一个的人名链，直到出现Waldo。

【译注】《威利在哪里？》是一套由英国插画家 Martin Handford 创作的儿童书籍。这个书的目标就是在一张人山人海的图片中找出一个特定的人物 —— 威利。他总是会弄丢东西，如书本、野营设备甚至是他的鞋子，而读者也要帮他在图中找出这些东西来。更多参见 威利在哪里 - 百度百科、威利在哪里 - 维基百科。

下面是用Http4k编写的完整RESTful服务实现。Http4k是 Marius Eriksen 的著名论文中所写的函数式服务端架构的Kotlin版本实现。实现有许多其他语言，包括Scala（Http4s）和Java 8或更高版本（Http4j）。

实现有唯一一个endpoint，通过Map实现人名链。给定一个人名，返回匹配值和200状态代码，或是返回404和错误消息。

fun main() {
   val names = mapOf(
       "Jane" to "Dave",
       "Dave" to "Mary",
       "Mary" to "Pete",
       "Pete" to "Lucy",
       "Lucy" to "Waldo"
   )

   val lookupName = { request: Request ->
       val name = request.path("name")
       val headers = listOf("Content-Type" to "text/plain")
       val result = names[name]
       if (result != null) {
           Response(OK)
               .headers(headers)
               .body(result)
       } else {
           Response(NOT_FOUND)
               .headers(headers)
               .body("No match for $name")
       }
   }

   routes(
       "/wheresWaldo" bind routes(
           "/{name:.*}" bind Method.GET to lookupName
       )
   ).asServer(Netty(8080))
       .start()
}

【译注】上面示例代码 完整实现的工程文件： ServerMain.kt

也就是说，用户要完成的操作是执行下面的请求链：

$ curl http://localhost:8080/wheresWaldo/Mary
Pete
$ curl http://localhost:8080/wheresWaldo/Pete
Lucy
$ curl http://localhost:8080/wheresWaldo/Lucy
Waldo

2.2 示例应用（客户端）

客户端应用基于JavaFX库来创建桌面用户界面，为了简化任务并避免不必要的细节，使用TornadoFX，它为JavaFX提供了Kotlin的DSL实现。

下面是客户端视图的完整定义：

class HelloWorldView: View("Coroutines Client UI") {
   private val finder: HttpWaldoFinder by inject()
   private val inputText = SimpleStringProperty("Jane")
   private val resultText = SimpleStringProperty("")

   override val root = form {
       fieldset("Lets Find Waldo") {
           field("First Name:") {
               textfield().bind(inputText)
               button("Search") {
                   action {
                       println("Running event handler".addThreadId())
                       searchForWaldo()
                   }
               }
           }
           field("Result:") {
               label(resultText)
           }
       }
   }

   private fun searchForWaldo() {
       GlobalScope.launch(Dispatchers.Main) {
           println("Doing Coroutines".addThreadId())
           val input = inputText.value
           val output = finder.wheresWaldo(input)
           resultText.value = output
       }
   }
}

【译注】上面示例代码 完整实现的工程文件： HelloWorldView.kt

另外还使用了下面的辅助函数作为String类型的扩展方法：

fun String.addThreadId() = "$this on thread ${Thread.currentThread().id}"

【译注】上面示例代码 完整实现的工程文件： Utils.kt

下面是用户界面运行起来的样子：

【译注】在可运行代码工程中，通过文件MyApp.kt的main启动客户端。

当用户单击按钮时，会启动一个新的协程，并通过类型为HttpWaldoFinder的服务对象访问RESTful endpoint。

Kotlin协程存在于CoroutineScope之中，CoroutineScope关联了表示底层并发模型的dispatcher。并发模型通常是线程池，但可以是其它的。

有哪些dispatcher可用取决于Kotlin代码的所运行环境。Main Dispatcher对应的是UI库的事件处理线程，因此（在JVM上）仅在Android、JavaFX和Swing中可用。Kotlin Native的协程在开始时完全不支持多线程，但是这种情况正在改变。在服务端，可以自己引入协程，但缺省就可用的情况变得越来越常见，比如在Spring 5中。

在开始调用挂起方法（suspending methods）之前，必须要有一个协程、一个CoroutineScope和一个dispatcher。如果是最开始的调用（如上面的代码所示），可以通过『协程构建器』（coroutine builder）函数（如launch和async）来启动这个过程。

调用协程构建器函数或诸如withContext之类的作用域函数(scoping function)总会创建一个新的CoroutineScope。在这个上下文中，执行的任务（task）对应由Job实例组成的层次结构。

协程的任务具有一些有趣的特性，即：

  • Job在自己完成之前，会等待自己区域中的所有协程完成。
  • 取消Job导致其所有子Job被取消。
  • Job的失败或取消会传播给他的父Job。

这样的设计是为了避免并发编程中的常见问题，比如在没有终止子任务的情况下终止了父任务。

2.3 访问REST endpoint的服务

下面是HttpWaldoFinder服务的完整代码：

class HttpWaldoFinder : Controller(), WaldoFinder {
   override suspend fun wheresWaldo(starterName: String): String {
       val firstName = fetchNewName(starterName)
       println("Found $firstName name".addThreadId())

       val secondName = fetchNewName(firstName)
       println("Found $secondName name".addThreadId())

       val thirdName = fetchNewName(secondName)
       println("Found $thirdName name".addThreadId())

       val fourthName = fetchNewName(thirdName)
       println("Found $fourthName name".addThreadId())

       return fetchNewName(fourthName)
   }

   private suspend fun fetchNewName(inputName: String): String {
       val url = URI("http://localhost:8080/wheresWaldo/$inputName")
       val client = HttpClient.newBuilder().build()
       val handler = HttpResponse.BodyHandlers.ofString()
       val request = HttpRequest.newBuilder().uri(url).build()

       return withContext<String>(Dispatchers.IO) {
           println("Sending HTTP Request for $inputName".addThreadId())
           client
               .send(request, handler)
               .body()
       }
   }
}

【译注】上面示例代码 完整实现的工程文件：WaldoFinder.kt

fetchNewName函数的参数是已知人名，在endpoint中查询关联的人名。通过HttpClient类完成，这个类在Java 11及以后版本的标准库中。实际的HTTP GET操作在使用IO Dispatcher的新子协程中运行。IO Dispatcher代表了为长时间运行的活动（如网络调用）优化的线程池。

wheresWaldo函数追踪人名称链五次，以（期望能）找到Waldo。因为后面要反汇编生成的字节码，所以逻辑实现得尽可能简单。我们感兴趣的是，每次调用fetchNewName都会导致当前协程被挂起，尽管它的子协程会在运行。在这种特殊情况下，父协程在Main Dispatcher上运行，而子协程在IO Dispatcher上运行。因此，尽管子协程在执行HTTP请求，UI事件处理线程已经释放了，以处理其他用户与视图的交互。如下图所示：

当调用挂起函数时，IntelliJ会在编辑器窗口左边条用图标提示在协程之间有控制权转移。请注意，如果不切换dispatcher，则调用不一定会导致新协程的创建。当一个挂起函数调用另一个挂起函数时，可以在同一协程中继续执行，实际上，如果处在同一线程上，这就是我们想要的行为。

当执行客户端时，控制台的输出如下：

Sending HTTP Request for Lucy on thread 24
Running event handler on thread 17
Doing Coroutines on thread 17
Sending HTTP Request for Jane on thread 24
Found Dave name on thread 17
Sending HTTP Request for Dave on thread 24
Found Mary name on thread 17
Sending HTTP Request for Mary on thread 24
Found Pete name on thread 17
Sending HTTP Request for Pete on thread 26
Found Lucy name on thread 17
Sending HTTP Request for Lucy on thread 26

可以看到，对于上面的这次运行，Main Dispatcher / UI事件Handler在线程17上运行，而IO Dispatcher在包含线程24和26的线程池上运行。

3. 开始探索

使用IntelliJ自带的字节码反汇编工具，可以窥探底层的实际情况。当然你也可以使用JDK自带的标准javap工具。

可以看到HttpWaldoFinder的方法签名已经改变了，因此可以接受延续对象（continuation object）作为额外的参数，并返回一个通用的Object。

public final class HttpWaldoFinder extends Controller implements WaldoFinder {
  public Object wheresWaldo(String a, Continuation b)

  final synthetic Object fetchNewName(String a, Continuation b)
}

现在，让我们深入研究添加到这些方法中的代码，并解释『延续（Continuation）』是什么，以及返回的是什么。

3.1 延续传递风格（Continuation Passing Style/CPS）

正如Kotlin标准化流程（也称为KEEP）中的协程提案所记录的，协程的实现基于『延续传递风格』。延续对象用于存储函数在挂起期间所需的状态。

挂起函数的每个局部变量都成为延续的字段。另外还需要为各个函数的参数和当前对象（如果函数是方法）创建字段。因此，有四个参数和五个局部变量的挂起方法有至少十个字段的延续。

对于HttpWaldoFinder中的wheresWaldo方法，只有一个参数和四个局部变量，因此延续实现类型具有六个字段。如果将Kotlin编译器生成的字节码反汇编为Java源代码，可以看到确实如此：

$continuation = new ContinuationImpl($completion) {
  Object result;
  int label;
  Object L$0;
  Object L$1;
  Object L$2;
  Object L$3;
  Object L$4;
  Object L$5;

  @Nullable
  public final Object invokeSuspend(@NotNull Object $result) {
     this.result = $result;
     this.label |= Integer.MIN_VALUE;
     return HttpWaldoFinder.this.wheresWaldo((String)null, this);
  }
};

由于所有字段都为Object类型，因此如何使用它们并不是很明显。但是随着进一步探索，可以看到：

  • L$0持有对HttpWaldoFinder实例的引用。始终有值。
  • L$1持有starterName参数的值。始终有值。
  • L$2到L$5持有局部变量的值。在代码执行时逐步填充。L$2将持有firstName的值，依此类推。

另外还有用于最终结果的字段，以及一个名为label引人注意的整型字段。

3.2 挂起还是不挂起 —— 这是一个问题

在检查生成的代码时，需要记住：整个过程必须处理两个用例。每当一个挂起函数在调用另一个挂起函数时，要么挂起当前协程（以便另一个可以在同一线程上运行），要么继续执行当前协程。

考虑一个从数据存储中读取的挂起函数，在发生IO操作时这个函数起很可能会挂起，但也可能读取的是缓存的结果。后续调用可以同步返回缓存的值，而不会挂起。Kotlin编译器生成的代码对于这两个路径必须都是允许的。

Kotlin编译器调整了每个挂起函数的返回类型，以便可以返回实际结果或特殊值 COROUTINE_SUSPENDED。对于后一种情况下当前的协程是被挂起的。这就是挂起函数的返回类型从结果类型更改为Object的原因。

示例应用wheresWaldo会重复调用fetchNewName。从理论上讲，这些调用中的都可以挂起或不挂起当前的协程。在写fetchNewName的时候，我们知道的是挂起总是会发生。但是，如果要理解所生成的代码，必须记住，实现需要能够处理所有可能性。

3.3 大switch语句（The Big Switch Statement）和标签

如果进一步查看反汇编的代码，会发现埋在多个嵌套标签（label）中的switch语句。这是状态机（state machine）的实现，用于控制wheresWaldo()方法中的不同挂起点。下面的代码用于说明switch语句的高层结构：

代码段 1：生成的switch语句与标签

String firstName;
String secondName;
String thirdName;
String fourthName;
Object var11;
Object var10000;
label48: {
  label47: {
    label46: {
        Object $result = $continuation.result;
        var11 = IntrinsicsKt.getCOROUTINE_SUSPENDED();
        switch($continuation.label) {
        case 0:
            // code omitted
        case 1:
            // code omitted
        case 2:
            // code omitted
        case 3:
            // code omitted
        case 4:
            // code omitted
        case 5:
            // code omitted
        default:
           throw new IllegalStateException(
                "call to 'resume' before 'invoke' with coroutine");
        } // end of switch
        // code omitted
    } // end of label 46
    // code omitted
  } // end of label 47
  // code omitted
} // end of label 48
// code omitted

现在可以看清楚延续的label字段的用途。当完成wheresWaldo的不同阶段时，更改label的值。嵌套的标签块包含原来Kotlin代码中挂起点之间的代码块。label的值允许重新进入该代码：跳到上次挂起的位置（适当的case语句），从延续中提取一些数据，然后开始执行对应的标签块代码 。

但是，如果所有的挂起点都没有实际挂起，则整个代码块会同步执行掉。在生成的代码中，下面的代码片段反复出现：

代码段 2：决定当前协程是否应该挂起

if (var10000 == var11) {
  return var11;
}

从之前的代码可以知道，var11的值是 CONTINUATION_SUSPENDED，而var10000保存的是调用另一个挂起函数的返回值。因此，当发生挂起时，代码将返回（之后会重新进入）；如果没有发生挂起，代码会穿过了一个标签，直接继续执行这个标签之后的代码。

再强调一次，请记住：生成的代码不能假定所有调用都将挂起，或者所有调用都将继续执行当前协程。必须能够应对任何可能的组合。

4. 追踪执行过程

当执行开始时，延续中label字段的值设置的是0。switch语句中相应分支代码如下：

代码段 3：switch语句的第一个分支

case 0:
  ResultKt.throwOnFailure($result);
  $continuation.L$0 = this;
  $continuation.L$1 = starterName;
  $continuation.label = 1;
  var10000 = this.fetchNewName(starterName, $continuation);
  if (var10000 == var11) {
    return var11;
  }
  break;

将实例和参数存储到延续对象中，然后将延续对象传递给fetchNewName。如前文所述，编译器生成的fetchNewName版本将返回实际结果或 COROUTINE_SUSPENDED 值。

如果协程被挂起，那么从函数中返回，并且当协程继续时跳转到case 1分支。如果继续执行当前的协程（即没有被挂起），那么将穿过switch语句的一个标签，执行下面的代码：

代码段 4：第二次调用fetchNewName

firstName = (String)var10000;
secondName = UtilsKt.addThreadId("Found " + firstName + " name");
boolean var13 = false;
System.out.println(secondName);
$continuation.L$0 = this;
$continuation.L$1 = starterName;
$continuation.L$2 = firstName;
$continuation.label = 2;
var10000 = this.fetchNewName(firstName, $continuation);
if (var10000 == var11) {
  return var11;
}

因为知道var10000是函数返回值，所以可以将其转型为正确的类型并存储在本地变量firstName中。然后，生成的代码使用变量secondName存储连接线程ID的结果，然后将其打印出来。

更新延续中的字段，以添加从服务器检索到的值。请注意，label的值现在为2。然后，第三次调用fetchNewName。

4.1 第三次调用fetchNewName的请求 —— 不挂起

实现流程必须再次基于fetchNewName返回值进行选择，如果返回的值是 COROUTINE_SUSPENDED，那么将从当前函数返回。下次调用时，将进入switch语句的case 2分支。

如果继续当前的协程，则执行下面的代码块。从实现流程可以看到，这与前一步相同，除了现在有更多数据要存储在延续中。

代码段 4：第三次调用fetchNewName

secondName = (String)var10000;
thirdName = UtilsKt.addThreadId("Found " + secondName + " name");
boolean var14 = false;
System.out.println(thirdName);
$continuation.L$0 = this;
$continuation.L$1 = starterName;
$continuation.L$2 = firstName;
$continuation.L$3 = secondName;
$continuation.label = 3;
var10000 = this.fetchNewName(secondName, (Continuation)$continuation);
if (var10000 == var11) {
  return var11;
}

对于所有剩余的调用（假设从未返回 COROUTINE_SUSPENDED），此模式将重复进行，直到到达结尾为止。

4.2 第三次调用fetchNewName —— 挂起

另一情况是协程被挂起，那么要运行下面的case块：

代码段 5：switch语句的第三个分支

case 2:
  firstName = (String)$continuation.L$2;
  starterName = (String)$continuation.L$1;
  this = (HttpWaldoFinder)$continuation.L$0;
  ResultKt.throwOnFailure($result);
  var10000 = $result;
  break label46;

从延续中提取值到函数的局部变量中。然后用带标签的break将执行跳转到上面的代码段4。因此，最终将在同一个地方结束整个协程的执行。

4.3 执行过程总结

现在我们可以重新梳理代码结构，并对每个部分中所做的进行高层的描述：

代码段 6：生成的switch语句与标签，带展开深入的说明

String firstName;
String secondName;
String thirdName;
String fourthName;
Object var11;
Object var10000;
label48: {
  label47: {
     label46: {
        Object $result = $continuation.result;
        var11 = IntrinsicsKt.getCOROUTINE_SUSPENDED();
        switch($continuation.label) {
        case 0:
            // 设置延续的`label`字段值 成1，进行第一次调用`fetchNewName`
            // 如果fetchNewName调用挂起，则返回；否则执行switch的break
        case 1:
            // 从延续中提提取 参数值
            // 执行switch的break（即跳过`switch`代码块）
        case 2:
            // 从延续中提取 参数值 以及 第一个结果
            // 执行外面`label46`标签的break（即跳过`label46`的代码块）
        case 3:
            // 从延续中提取 参数值 以及 第一个和第二个结果
            // 执行外面`label47`标签的break（即跳过`label47`的代码块）
        case 4:
            // 从延续中提取 参数值 以及 第一个、第二个和第三个结果
            // 执行外面`label48`标签的break（即跳过`label48`的代码块）
        case 5:
            // 从延续中提取 参数值 以及 第一个、第二个、第三个和第四个结果
            // 返回最终的结果
        default:
           throw new IllegalStateException(
                "call to 'resume' before 'invoke' with coroutine");
        } // end of switch
        // 将参数 以及 第一个结果 存入 延续
        // 设置 延续的`label`字段值 成2，进行第二次调用`fetchNewName`
        // 如果fetchNewName调用挂起，则返回；否则继续执行
    } // end of label 46
        // 将参数 以及 第一个和第二个结果 存入 延续
        // 设置 延续的`label`字段值 成3，进行第三次调用`fetchNewName`
        // 如果fetchNewName调用挂起，则返回；否则继续执行
  } // end of label 47
        // 将参数 以及 第一个、第二个和第三个结果 存入 延续
        // 设置 延续的`label`字段值 成4，进行第四次调用`fetchNewName`
        // 如果fetchNewName调用挂起，则返回；否则继续执行
} // end of label 48
// 将参数 以及 第一个、第二个、第三个和第四个结果 存入 延续
// 设置 延续的`label`字段值 成5，进行第五次调用`fetchNewName`
// 返回 最终结果 或是 COROUTINE_SUSPENDED

5. 结论

这不是一份容易理解的代码。我们研究了由Kotlin编译器生成的字节码所反汇编的Java代码。Kotlin编译器生成的字节码目标是执行的效率和简约，而不是清晰易读。

可以得出一些有用的结论：

  1. 没有魔法。当初次了解协程时，很容易会以为有一些特殊的『魔法』来把所有东西连接起来。正如我们上面所看到的，生成的代码只使用过程式编程（Procedural Programming）的基本构建块，比如条件语句和带有标签的break。
  2. 实现是基于延续的。如KEEP提案中所说明，实现函数的挂起和恢复的方式是将函数的状态捕捉到一个对象中。因此，对于每一个挂起函数，编译器会创建一个具有N个字段的延续类，其中N是函数参数个数加上函数变量个数加上3。后面3个字段分别持有的是当前对象、最终结果和索引。
  3. 执行始终遵循标准模式。如果要从挂起中恢复，使用延续的label字段跳转到switch语句里的对应分支。在这个分支中，从延续对象中取出所找到的数据，然后用带有标签的break语句跳转到如果没有发生挂起所要执行的代码。

关于作者

Garth Gilmour 是Instil的学习主管。他在1999年放弃了全职开发工作，先是给C程序员讲授C++，然后给C++程序员讲授Java，再给Java程序员讲授C#，现在向所有人讲授所有东西，但更喜欢讲授Kotlin。如果算算上过的课话，那一定会超过1000次了。他是20多门课程的作者，经常在聚会上演讲，在国家和国际会议上发表演讲，并共同组织了贝尔法斯特（北爱尔兰首府）开发者活动的BASH系列主题和最近成立的贝尔法斯特Kotlin用户组。如不在黑板前，就会教色列搏击术（Krav Maga）和练举重。

Eamonn Boyle 从事软件开发、架构师和团队管理超过15年。在过去的大约四年中，他一直是一名全职培训师和教练，为很多不同的组织撰写和提供有关各种主题的课程。包括从核心语言技能与框架到工具与过程的范式和技术。还在包括Goto和KotlinConf在内的许多会议、活动和聚会中演讲并举办了研讨会。