【譯】kotlin 協程官方文件（8）-共享可變狀態和併發性（Shared mutable state and concurrency）

葉志陳發表於2020-03-26

最近一直在瞭解關於kotlin協程的知識，那最好的學習資料自然是官方提供的學習文件了，看了看後我就萌生了翻譯官方文件的想法。前後花了要接近一個月時間，一共九篇文章，在這裡也分享出來，希望對讀者有所幫助。個人知識所限，有些翻譯得不是太順暢，也希望讀者能提出意見

協程官方文件：coroutines-guide

協程官方文件中文翻譯：coroutines-cn-guide

協程官方文件中文譯者：leavesC

[TOC]

可以使用多執行緒排程器（如 Dispatchers.Default）併發執行協程，它呈現了所有常見的併發問題。主要問題是對共享可變狀態的同步訪問。在協程作用域中解決這個問題的一些方法類似於多執行緒世界中的方法，但有一些其它方法是獨有的

一、問題（The problem）

讓我們啟動一百個協程，都做同樣的操作一千次。我們還將計算它們的完成時間，以便進一步比較：

suspend fun massiveRun(action: suspend () -> Unit) {
    val n = 100  // number of coroutines to launch
    val k = 1000 // times an action is repeated by each coroutine
    val time = measureTimeMillis {
        coroutineScope { // scope for coroutines 
            repeat(n) {
                launch {
                    repeat(k) { action() }
                }
            }
        }
    }
    println("Completed ${n * k} actions in $time ms")    
}
複製程式碼

我們從一個非常簡單的操作開始，該操作使用多執行緒排程器 Dispatchers.Default，並增加一個共享的可變變數

import kotlinx.coroutines.*
import kotlin.system.*    

suspend fun massiveRun(action: suspend () -> Unit) {
    val n = 100  // number of coroutines to launch
    val k = 1000 // times an action is repeated by each coroutine
    val time = measureTimeMillis {
        coroutineScope { // scope for coroutines 
            repeat(n) {
                launch {
                    repeat(k) { action() }
                }
            }
        }
    }
    println("Completed ${n * k} actions in $time ms")    
}

//sampleStart
var counter = 0

fun main() = runBlocking {
    withContext(Dispatchers.Default) {
        massiveRun {
            counter++
        }
    }
    println("Counter = $counter")
}
//sampleEnd    
複製程式碼

最後會列印出什麼呢？不太可能列印出 “Counter=100000”，因為100個協程從多個執行緒併發地遞增 counter 而不進行任何同步。

二、Volatiles 是沒有作用的（Volatiles are of no help）

有一種常見的誤解是：將變數標記為 volatile 可以解決併發問題。讓我們試試：

import kotlinx.coroutines.*
import kotlin.system.*

suspend fun massiveRun(action: suspend () -> Unit) {
    val n = 100  // number of coroutines to launch
    val k = 1000 // times an action is repeated by each coroutine
    val time = measureTimeMillis {
        coroutineScope { // scope for coroutines 
            repeat(n) {
                launch {
                    repeat(k) { action() }
                }
            }
        }
    }
    println("Completed ${n * k} actions in $time ms")    
}

//sampleStart
@Volatile // in Kotlin `volatile` is an annotation 
var counter = 0

fun main() = runBlocking {
    withContext(Dispatchers.Default) {
        massiveRun {
            counter++
        }
    }
    println("Counter = $counter")
}
//sampleEnd    
複製程式碼

這段程式碼執行得比較慢，但是我們在最後仍然沒有得到“Counter=100000”，因為 volatile 變數保證了可線性化（這是“atomic”的一個技術術語）對相應變數的讀寫，但不提供更大行為的原子性（在我們的例子中指遞增操作）

三、執行緒安全的資料結構（Thread-safe data structures）

對執行緒和協程都有效的一個解決方案是使用執行緒安全的（也稱為同步、可線性化或原子）資料結構，該結構為需要在共享狀態上執行的相應操作提供所有必要的同步保障。對於一個簡單的計數器，我們可以使用 AtomicInteger 類，該類具有保證原子性的 incrementAndGet 方法

import kotlinx.coroutines.*
import java.util.concurrent.atomic.*
import kotlin.system.*

suspend fun massiveRun(action: suspend () -> Unit) {
    val n = 100  // number of coroutines to launch
    val k = 1000 // times an action is repeated by each coroutine
    val time = measureTimeMillis {
        coroutineScope { // scope for coroutines 
            repeat(n) {
                launch {
                    repeat(k) { action() }
                }
            }
        }
    }
    println("Completed ${n * k} actions in $time ms")    
}

//sampleStart
var counter = AtomicInteger()

fun main() = runBlocking {
    withContext(Dispatchers.Default) {
        massiveRun {
            counter.incrementAndGet()
        }
    }
    println("Counter = $counter")
}
//sampleEnd    
複製程式碼

這是解決這個特殊問題的最快方法。它適用於普通計數器、集合、佇列和其他標準資料結構及其基本操作。但是，它不容易擴充套件到複雜的狀態或沒有實現好了的執行緒安全的複雜操作

四、以細粒度限制執行緒（Thread confinement fine-grained）

執行緒限制是解決共享可變狀態問題的一種方法，其中對特定共享狀態的所有訪問都限制在一個執行緒內。它通常用於 UI 應用程式，其中所有的 UI 狀態都限制在“單個事件分派”或“應用程式執行緒”中。通過使用單執行緒上下文，可以很容易地使用協程來實現上述的計數器

import kotlinx.coroutines.*
import kotlin.system.*

suspend fun massiveRun(action: suspend () -> Unit) {
    val n = 100  // number of coroutines to launch
    val k = 1000 // times an action is repeated by each coroutine
    val time = measureTimeMillis {
        coroutineScope { // scope for coroutines 
            repeat(n) {
                launch {
                    repeat(k) { action() }
                }
            }
        }
    }
    println("Completed ${n * k} actions in $time ms")    
}

//sampleStart
val counterContext = newSingleThreadContext("CounterContext")
var counter = 0

fun main() = runBlocking {
    withContext(Dispatchers.Default) {
        massiveRun {
            // confine each increment to a single-threaded context
            withContext(counterContext) {
                counter++
            }
        }
    }
    println("Counter = $counter")
}
//sampleEnd      
複製程式碼

這段程式碼執行得非常緩慢，因為它執行細粒度的執行緒限制。每個單獨的增值操作都使用 withContext(counterContext) 從多執行緒 Dispatchers.Default 上下文切換到單執行緒上下文

五、以粗粒度限制執行緒（Thread confinement coarse-grained）

在實踐中，執行緒限制是在比較大的範圍內執行的，例如，更新狀態的邏輯的範圍被限制在單個執行緒中。下面的示例就是這樣做的，首先在單執行緒上下文中執行每個協程

import kotlinx.coroutines.*
import kotlin.system.*

suspend fun massiveRun(action: suspend () -> Unit) {
    val n = 100  // number of coroutines to launch
    val k = 1000 // times an action is repeated by each coroutine
    val time = measureTimeMillis {
        coroutineScope { // scope for coroutines 
            repeat(n) {
                launch {
                    repeat(k) { action() }
                }
            }
        }
    }
    println("Completed ${n * k} actions in $time ms")    
}

//sampleStart
val counterContext = newSingleThreadContext("CounterContext")
var counter = 0

fun main() = runBlocking {
    // confine everything to a single-threaded context
    withContext(counterContext) {
        massiveRun {
            counter++
        }
    }
    println("Counter = $counter")
}
//sampleEnd     
複製程式碼

現在這段程式碼的執行速度會快得多，併產生了正確的結果

六、互斥（Mutual exclusion）

互斥問題的解決方案是保護共享狀態的所有修改操作，其中的關鍵程式碼永遠不會同時執行。在一個阻塞的世界中，通常會使用 synchronized 或 ReentrantLock。協程的替換方案稱為互斥(Mutex)。它具有 lock 和 unlock 函式以劃定一個關鍵位置。關鍵的區別在於 Mutex.lock() 是一個掛起函式。它不會阻塞執行緒

還有一個擴充套件函式 withLock 可以方便地來實現 mutex.lock(); try {...} finally { mutex.unlock() }

import kotlinx.coroutines.*
import kotlinx.coroutines.sync.*
import kotlin.system.*

suspend fun massiveRun(action: suspend () -> Unit) {
    val n = 100  // number of coroutines to launch
    val k = 1000 // times an action is repeated by each coroutine
    val time = measureTimeMillis {
        coroutineScope { // scope for coroutines 
            repeat(n) {
                launch {
                    repeat(k) { action() }
                }
            }
        }
    }
    println("Completed ${n * k} actions in $time ms")    
}

//sampleStart
val mutex = Mutex()
var counter = 0

fun main() = runBlocking {
    withContext(Dispatchers.Default) {
        massiveRun {
            // protect each increment with lock
            mutex.withLock {
                counter++
            }
        }
    }
    println("Counter = $counter")
}
//sampleEnd
複製程式碼

本例中的鎖是細粒度的，因此它也付出了某些代價（消耗）。但是，在某些情況下這是一個很好的選擇，比如你必須定期修改某些共享狀態，但不具備修改共享狀態所需的原生執行緒

七、Actors

actor 是一個實體，由一個協程、被限制並封裝到這個協程中的狀態以及一個與其它協程通訊的通道組成。簡單的 actor 可以寫成函式，但具有複雜狀態的 actor 更適合類

有一個 actor 協程構造器，它可以方便地將 actor 的 mailbox channel 合併到其接收的訊息的作用域中，並將 send channel 合併到生成的 job 物件中，以便可以將對 actor 的單個引用作為其控制程式碼引有

使用 actor 的第一步是定義一類 actor 將要處理的訊息。kotlin 的密封類非常適合這個目的。在 CounterMsg 密封類中，我們用 IncCounter 訊息來定義遞增計數器，用 GetCounter 訊息來獲取其值，後者需要返回值。為此，這裡使用 CompletableDeferred communication primitive，它表示將來已知（通訊）的單個值

// Message types for counterActor
sealed class CounterMsg
object IncCounter : CounterMsg() // one-way message to increment counter
class GetCounter(val response: CompletableDeferred<Int>) : CounterMsg() // a request with reply
複製程式碼

然後，我們定義一個函式，該函式使用 actor 協程構造器來啟動 actor：

// This function launches a new counter actor
fun CoroutineScope.counterActor() = actor<CounterMsg> {
    var counter = 0 // actor state
    for (msg in channel) { // iterate over incoming messages
        when (msg) {
            is IncCounter -> counter++
            is GetCounter -> msg.response.complete(counter)
        }
    }
}
複製程式碼

程式碼很簡單：

import kotlinx.coroutines.*
import kotlinx.coroutines.channels.*
import kotlin.system.*

suspend fun massiveRun(action: suspend () -> Unit) {
    val n = 100  // number of coroutines to launch
    val k = 1000 // times an action is repeated by each coroutine
    val time = measureTimeMillis {
        coroutineScope { // scope for coroutines 
            repeat(n) {
                launch {
                    repeat(k) { action() }
                }
            }
        }
    }
    println("Completed ${n * k} actions in $time ms")    
}

// Message types for counterActor
sealed class CounterMsg
object IncCounter : CounterMsg() // one-way message to increment counter
class GetCounter(val response: CompletableDeferred<Int>) : CounterMsg() // a request with reply

// This function launches a new counter actor
fun CoroutineScope.counterActor() = actor<CounterMsg> {
    var counter = 0 // actor state
    for (msg in channel) { // iterate over incoming messages
        when (msg) {
            is IncCounter -> counter++
            is GetCounter -> msg.response.complete(counter)
        }
    }
}

//sampleStart
fun main() = runBlocking<Unit> {
    val counter = counterActor() // create the actor
    withContext(Dispatchers.Default) {
        massiveRun {
            counter.send(IncCounter)
        }
    }
    // send a message to get a counter value from an actor
    val response = CompletableDeferred<Int>()
    counter.send(GetCounter(response))
    println("Counter = ${response.await()}")
    counter.close() // shutdown the actor
}
//sampleEnd    
複製程式碼

在什麼上下文中執行 actor 本身並不重要（為了正確）。actor 是一個協程，並且協程是按順序執行的，因此將狀態限制到特定的協程可以解決共享可變狀態的問題。實際上，actors 可以修改自己的私有狀態，但只能通過訊息相互影響（避免需要任何鎖）

actor 比使用鎖更為有效，因為在這種情況下，它總是有工作要做，根本不需要切換到不同的上下文

注意，actor 協程構造器是一個雙重的 product 協程構造器。actor 與它接收訊息的通道相關聯，而 producer 與向其傳送元素的通道相關聯

【譯】kotlin 協程官方文件（6）-通道（Channels）
2020-03-24
Kotlin
【譯】kotlin 協程官方文件（1）-協程基礎（Coroutine Basics）
2020-03-21
Kotlin
kotlinx協程官方文件中文翻譯版本
2018-06-04
Kotlin
Solidity之旅（十三）函式及其可見性和狀態可變性
2023-12-21
Solid函式
Kotlin 官方參考文件翻譯完畢
2017-06-20
Kotlin
狀態模式（State）
2018-01-03
模式
REST = Representational State Transfer（表述性狀態轉移）
2016-02-01
REST
【譯】使用kotlin協程提高app效能
2019-12-24
KotlinAPP
[譯] Kotlin 協程高階使用技巧
2019-03-03
Kotlin
Kotlin（android）協程中文翻譯
2018-09-01
KotlinAndroid
Go 併發 -- 協程
2019-04-18
Go
狀態模式(State pattern)
2013-09-27
模式
React Native 探索（三）元件的 Props (屬性) 和 State (狀態)
2020-02-18
React Native元件
React專題：可變狀態
2019-01-16
React
[譯]記一次Kotlin官方文件翻譯的PR(內聯類)
2018-12-21
Kotlin
【設計模式基礎】行為模式 - 8 -狀態(State)
2014-03-11
設計模式
在 Android 開發中使用 Kotlin 協程 (一) -- 初識 Kotlin 協程
2019-03-23
AndroidKotlin
Android版kotlin協程入門(四)：kotlin協程開發實戰
2021-10-12
AndroidKotlin
RxJava常用操作符官方文件翻譯及Kotlin示例(1)
2019-02-26
RxJavaKotlin
[譯] 使用 Kotlin 協程改進應用效能
2019-05-19
Kotlin
【翻譯】What is State Machine Diagram(什麼是狀態機圖)?
2018-09-06
Mac
併發王者課-青銅8：分工協作-從本質認知執行緒的狀態和動作方法
2021-05-31
執行緒
Linux下共享VG改變活動狀態
2018-05-29
Linux
Java 8 併發: 原子變數和 ConcurrentMap
2018-02-04
Java變數
Kotlin的協程
2017-12-13
Kotlin
Moya官方文件翻譯
2018-03-21
Kotlin Coroutine(協程): 二、初識協程
2021-07-13
Kotlin
Kotlin Coroutine(協程): 三、瞭解協程
2021-07-14
Kotlin
[React]屬性和狀態
2017-12-10
React
HarmonyOS 實踐之應用狀態變數共享
2023-12-27
變數
[python官方文件]8錯誤和異常
2016-10-11
Python
電子遊戲、規則和結束狀態（end state）
2019-09-06
遊戲
PHP協程：併發 shell_exec
2019-02-16
PHP
併發技術2：多協程
2018-11-16
Kotlin 協程一 —— Coroutine
2022-01-15
Kotlin
Kotlin 之旅7 協程
2017-12-21
Kotlin
django1.8官方文件翻譯：8-5加密簽名
2015-09-16
Django加密
[譯] AsyncDisplayKit/Texture 官方文件(1)
2019-03-02