Kotlin協(xié)程低級api startCoroutine與ContinuationInterceptor
聊一聊kotlin協(xié)程“低級”api
Kotlin協(xié)程已經(jīng)出來很久了，相信大家都有不同程度的用上了，由于最近處理的需求有遇到協(xié)程相關(guān)，因此今天來聊一Kotlin協(xié)程的“低級”api，首先低級api并不是它真的很“低級”，而是kotlin協(xié)程庫中的基礎api，我們一般開發(fā)用的，其實都是通過低級api進行封裝的高級函數(shù)，本章會通過低級api的組合，實現(xiàn)一個自定義的async await 函數(shù)（下文也會介紹kotlin 高級api的async await），涉及的低級api有startCoroutine ，ContinuationInterceptor 等
startCoroutine
我們知道，一個suspend關(guān)鍵字修飾的函數(shù)，只能在協(xié)程體中執(zhí)行，伴隨著suspend 關(guān)鍵字，kotlin coroutine common庫（平臺無關(guān)）也提供出來一個api，用于直接通過suspend 修飾的函數(shù)直接啟動一個協(xié)程，它就是startCoroutine
@SinceKotlin("1.3")
@Suppress("UNCHECKED_CAST")
public fun <R, T> (suspend R.() -> T).startCoroutine(
作為Receiver
receiver: R,
當前協(xié)程結(jié)束時的回調(diào)
completion: Continuation<T>
) {
createCoroutineUnintercepted(receiver, completion).intercepted().resume(Unit)
}
可以看到，它的Receiver是(suspend R.() -> T)，即是一個suspend修飾的函數(shù)，那么這個有什么作用呢？我們知道，在普通函數(shù)中無法調(diào)起suspend函數(shù)（因為普通函數(shù)沒有隱含的Continuation對象，這里我們不在這章講，可以參考kotlin協(xié)程的資料）
但是普通函數(shù)是可以調(diào)起一個以suspend函數(shù)作為Receiver的函數(shù)（本質(zhì)也是一個普通函數(shù)）
其中startCoroutine就是其中一個，本質(zhì)就是我們直接從外部提供了一個Continuation，同時調(diào)用了resume方法，去進入到了協(xié)程的世界
startCoroutine實現(xiàn) createCoroutineUnintercepted(completion).intercepted().resume(Unit)
這個原理我們就不細講下去原理，之前也有寫過相關(guān)的文章。通過這種調(diào)用，我們其實就可以實現(xiàn)在普通的函數(shù)環(huán)境，開啟一個協(xié)程環(huán)境（即帶有了Continuation），進而調(diào)用其他的suspend函數(shù)。
ContinuationInterceptor
我們都知道攔截器的概念，那么kotlin協(xié)程也有，就是ContinuationInterceptor，它提供以AOP的方式，讓外部在resume（協(xié)程恢復）前后進行自定義的攔截操作，比如高級api中的Diapatcher就是。當然什么是resume協(xié)程恢復呢，可能讀者有點懵，我們還是以上圖中出現(xiàn)的mySuspendFunc舉例子
mySuspendFunc是一個suspned函數(shù)
::mySuspendFunc.startCoroutine(object : Continuation<Unit> {
override val context: CoroutineContext
get() = EmptyCoroutineContext
override fun resumeWith(result: Result<Unit>) {
}
})
它其實等價于
val continuation = ::mySuspendFunc.createCoroutine(object :Continuation<Unit>{
override val context: CoroutineContext
get() = EmptyCoroutineContext
override fun resumeWith(result: Result<Unit>) {
Log.e("hello","當前協(xié)程執(zhí)行完成的回調(diào)")
}
})
continuation.resume(Unit)
startCoroutine方法就相當于創(chuàng)建了一個Continuation對象，并調(diào)用了resume。創(chuàng)建Continuation可通過createCoroutine方法，返回一個Continuation，如果我們不調(diào)用resume方法，那么它其實什么也不會執(zhí)行，只有調(diào)用了resume等執(zhí)行方法之后，才會執(zhí)行到后續(xù)的協(xié)程體（這個也是協(xié)程內(nèi)部實現(xiàn)，感興趣可以看看之前文章）
而我們的攔截器，就相當于在continuation.resume前后，可以添加自己的邏輯。我們可以通過繼承ContinuationInterceptor，實現(xiàn)自己的攔截器邏輯，其中需要復寫的方法是interceptContinuation方法，用于返回一個自己定義的Continuation對象，而我們可以在這個Continuation的resumeWith方法里面（當調(diào)用了resume之后，會執(zhí)行到resumeWith方法），進行前后打印/其他自定義操作（比如切換線程）
class ClassInterceptor() :ContinuationInterceptor {
override val key = ContinuationInterceptor
override fun <T> interceptContinuation(continuation: Continuation<T>): Continuation<T> =MyContinuation(continuation)
}
class MyContinuation<T>(private val continuation: Continuation<T>):Continuation<T> by continuation{
override fun resumeWith(result: Result<T>) {
Log.e("hello","MyContinuation start ${result.getOrThrow()}")
continuation.resumeWith(result)
Log.e("hello","MyContinuation end ")
}
}
其中的key是ContinuationInterceptor，協(xié)程內(nèi)部會在每次協(xié)程恢復的時候，通過coroutineContext取出key為ContinuationInterceptor的攔截器，進行攔截調(diào)用，當然這也是kotlin協(xié)程內(nèi)部實現(xiàn)，這里簡單提一下。
實戰(zhàn)
kotlin協(xié)程api中的 async await
我們來看一下kotlin Coroutine 的高級api async await用法
CoroutineScope(Dispatchers.Main).launch {
val block = async(Dispatchers.IO) {
// 阻塞的事項
}
// 處理其他主線程的事務
// 此時必須需要async的結(jié)果時，則可通過await()進行獲取
val result = block.await()
}
我們可以通過async方法，在其他線程中處理其他阻塞事務，當主線程必須要用async的結(jié)果的時候，就可以通過await等待，這里如果結(jié)果返回了，則直接獲取值，否則就等待async執(zhí)行完成。這是Coroutine提供給我們的高級api，能夠?qū)⑷蝿蘸唵畏謱佣恍枰^多的回調(diào)處理。
通過startCoroutine與ContinuationInterceptor實現(xiàn)自定義的 async await
我們可以參考其他語言的async，或者Dart的異步方法調(diào)用，都有類似這種方式進行線程調(diào)用
async {
val result = await {
suspend 函數(shù)
}
消費result
}
await在async作用域里面，同時獲取到result后再進行消費，async可以直接在普通函數(shù)調(diào)用，而不需要在協(xié)程體內(nèi)，下面我們來實現(xiàn)一下這個做法。
首先我們想要限定await函數(shù)只能在async的作用域才能使用，那么首先我們就要定義出來一個Receiver,我們可以在Receiver里面定義出自己想要暴露的方法
interface AsyncScope {
fun myFunc(){
}
}
fun async(
context: CoroutineContext = EmptyCoroutineContext,
block: suspend AsyncScope.() -> Unit
) {
// 這個有兩個作用 1.充當receiver 2.completion,接收回調(diào)
val completion = AsyncStub(context)
block.startCoroutine(completion, completion)
}
注意這個類，resumeWith 只會跟startCoroutine的這個協(xié)程綁定關(guān)系，跟await的協(xié)程沒有關(guān)系
class AsyncStub(override val context: CoroutineContext = EmptyCoroutineContext) :
Continuation<Unit>, AsyncScope {
override fun resumeWith(result: Result<Unit>) {
// 這個是干嘛的 == > 完成的回調(diào)
Log.e("hello","AsyncStub resumeWith ${Thread.currentThread().id} ${result.getOrThrow()}")
}
}
上面我們定義出來一個async函數(shù)，同時定義出來了一個AsyncStub的類，它有兩個用處，第一個是為了充當Receiver，用于規(guī)范后續(xù)的await函數(shù)只能在這個Receiver作用域中調(diào)用，第二個作用是startCoroutine函數(shù)必須要傳入一個參數(shù)completion，是為了收到當前協(xié)程結(jié)束的回調(diào)resumeWith中可以得到當前協(xié)程體結(jié)束回調(diào)的信息
await方法里面
suspend fun<T> AsyncScope.await(block:() -> T) = suspendCoroutine<T> {
// 自定義的Receiver函數(shù)
myFunc()
Thread{
切換線程執(zhí)行await中的方法
it.resumeWith(Result.success(block()))
}.start()
}
在await中，其實是一個擴展函數(shù)，我們可以調(diào)用任何在AsyncScope中定義的方法，同時這里我們模擬了一下線程切換的操作（Dispatcher的實現(xiàn)，這里不采用Dispatcher就是想讓大家知道其實Dispatcher.IO也是這樣實現(xiàn)的），在子線程中調(diào)用it.resumeWith(Result.success(block()))，用于返回所需要的信息
通過上面定的方法，我們可以實現(xiàn)
async {
val result = await {
suspend 函數(shù)
}
消費result
}
public interface ContinuationInterceptor : CoroutineContext.Element //而CoroutineContext.Element又是繼承于CoroutineContext CoroutineContext.Element:CoroutineContext
而我們的攔截器，正是CoroutineContext的子類，我們把上文的ClassInterceptor修改一下
class ClassInterceptor() : ContinuationInterceptor {
override val key = ContinuationInterceptor
override fun <T> interceptContinuation(continuation: Continuation<T>): Continuation<T> =
MyContinuation(continuation)
}
class MyContinuation<T>(private val continuation: Continuation<T>) :
Continuation<T> by continuation {
private val handler = Handler(Looper.getMainLooper())
override fun resumeWith(result: Result<T>) {
Log.e("hello", "MyContinuation start ${result.getOrThrow()}")
handler.post {
continuation.resumeWith(Result.success(自定義內(nèi)容))
}
Log.e("hello", "MyContinuation end ")
}
}
同時把async默認參數(shù)CoroutineContext實現(xiàn)一下即可
fun async(
context: CoroutineContext = ClassInterceptor(),
block: suspend AsyncScope.() -> Unit
) {
// 這個有兩個作用 1.充當receiver 2.completion,接收回調(diào)
val completion = AsyncStub(context)
block.startCoroutine(completion, completion)
}
此后我們就可以直接通過，完美實現(xiàn)了一個類js協(xié)程的調(diào)用，同時具備了自動切換線程的能力
async {
val result = await {
test()
}
Log.e("hello", "result is $result ${Looper.myLooper() == Looper.getMainLooper()}")
}
結(jié)果
E start
E MyContinuation start kotlin.Unit
E MyContinuation end
E end
E 執(zhí)行阻塞函數(shù) test 1923
E MyContinuation start 自定義內(nèi)容數(shù)值
E MyContinuation end
E result is 自定義內(nèi)容的數(shù)值 true
E AsyncStub resumeWith 2 kotlin.Unit
最后，這里需要注意的是，為什么攔截器回調(diào)了兩次，因為我們async的時候開啟了一個協(xié)程，同時await的時候也開啟了一個，因此是兩個。AsyncStub只回調(diào)了一次，是因為AsyncStub被當作complete參數(shù)傳入了async開啟的協(xié)程block.startCoroutine，因此只是async中的協(xié)程結(jié)束才會被回調(diào)。
本章代碼
class ClassInterceptor() : ContinuationInterceptor {
override val key = ContinuationInterceptor
override fun <T> interceptContinuation(continuation: Continuation<T>): Continuation<T> =
MyContinuation(continuation)
}
class MyContinuation<T>(private val continuation: Continuation<T>) :
Continuation<T> by continuation {
private val handler = Handler(Looper.getMainLooper())
override fun resumeWith(result: Result<T>) {
Log.e("hello", "MyContinuation start ${result.getOrThrow()}")
handler.post {
continuation.resumeWith(Result.success(6 as T))
}
Log.e("hello", "MyContinuation end ")
}
}
interface AsyncScope {
fun myFunc(){
}
}
fun async(
context: CoroutineContext = ClassInterceptor(),
block: suspend AsyncScope.() -> Unit
) {
// 這個有兩個作用 1.充當receiver 2.completion,接收回調(diào)
val completion = AsyncStub(context)
block.startCoroutine(completion, completion)
}
class AsyncStub(override val context: CoroutineContext = EmptyCoroutineContext) :
Continuation<Unit>, AsyncScope {
override fun resumeWith(result: Result<Unit>) {
// 這個是干嘛的 == > 完成的回調(diào)
Log.e("hello","AsyncStub resumeWith ${Thread.currentThread().id} ${result.getOrThrow()}")
}
}
suspend fun<T> AsyncScope.await(block:() -> T) = suspendCoroutine<T> {
myFunc()
Thread{
it.resumeWith(Result.success(block()))
}.start()
}
模擬阻塞
fun test(): Int {
Thread.sleep(5000)
Log.e("hello", "執(zhí)行阻塞函數(shù) test ${Thread.currentThread().id}")
return 5
}
async {
val result = await {
test()
}
Log.e("hello", "result is $result ${Looper.myLooper() == Looper.getMainLooper()}")
}
最后
我們通過協(xié)程的低級api，實現(xiàn)了一個與官方庫不同版本的async await，同時也希望通過對低級api的設計，也能對Coroutine官方庫的高級api的實現(xiàn)有一定的了解。
以上就是Kotlin協(xié)程低級api startCoroutine與ContinuationInterceptor 的詳細內(nèi)容，更多關(guān)于Kotlin協(xié)程低級api的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Android 4.4以上"沉浸式"狀態(tài)欄效果的實現(xiàn)方法
Android與ios效果互仿早已不是什么稀奇的事，我猜大概這個效果來自ios吧，有爭議說這種效果不能叫做沉浸式，叫透明狀態(tài)欄更合適，我也感覺這和沉浸式的含義不太一致。但是大家都這么叫了，那就這樣唄。下面來一起看看關(guān)于Android 4.4以上"沉浸式"效果的實現(xiàn)方法。2016-09-09
這篇文章主要為大家詳細介紹了Handler實現(xiàn)倒計時功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-04-04
這篇文章主要介紹了Android自定義View控件實現(xiàn)刷新效果的相關(guān)資料,非常不錯具有參考借鑒價值，需要的朋友可以參考下2016-11-11
利用源碼編譯Android系統(tǒng)的APK和可執(zhí)行命令的方法
這篇文章主要介紹了利用源碼編譯Android系統(tǒng)的APK和可執(zhí)行命令的方法,示例在Linux系統(tǒng)環(huán)境上進行構(gòu)建,需要的朋友可以參考下2016-02-02
本文給大家分享的是如何實現(xiàn)偷偷的把一個安卓apk應用安裝到手機上，而且不顯示確認框，主要是通過反射來實現(xiàn)，好了，小伙伴們仔細看下代碼吧，有需要的小伙伴可以參考下。2015-04-04
這篇文章要給大家分享的是Android原生繪圖工具Paint，android中提供了類似的工具Canvas和Paint，分別對應畫布和畫筆，本文就來介紹Androi中的Paint，感興趣的小伙伴一起來學習下面文章內(nèi)容2021-09-09
對于Glide這個加載圖片的框架，很多人都在用，我之前使用的是ImageLoader，最近查資料時，發(fā)現(xiàn)Glide才是Google推薦的加載圖片框架，功能非常強大，而且還有Google專人維護，要知道，ImageLoader已經(jīng)沒人維護了，除了問題可沒人解答。所以有必要整理一下Glide的使用2022-11-11
Android編程開發(fā)實現(xiàn)多線程斷點續(xù)傳下載器實例
這篇文章主要介紹了Android編程開發(fā)實現(xiàn)多線程斷點續(xù)傳下載器,涉及Android多線程,文件傳輸及斷點續(xù)傳的相關(guān)技巧,需要的朋友可以參考下2016-01-01
這篇文章主要介紹了Android自定義dialog可選擇展示年月日時間選擇欄，非常不錯，具有參考借鑒價值，需要的的朋友參考下2017-03-03
本篇文章主要介紹了Android實時通信示例，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-03-03