github博客
λ：
今天起 android demo 項目新加個sdk：騰訊云IM，最近正在用，而且接口多，涉及到的需求也挺全。正好練手。同時也有flutter的sdk。順路把flutter也寫了。
大多數(shù)sdk或者庫在提供api時，對于異步處理一般都是提供回調(diào)。好處是通用，兼容，不管java, kotlin，不用管其他依賴庫。 壞處就不用再提了。
IM也不例外是一堆回調(diào)，MVVM模式下，一層層傳回調(diào)上去就很low，所以把IM用到的接口整理成Service，在里邊把回調(diào)包成kotlin 協(xié)程掛起函數(shù)。
suspendCancellableCoroutine
public suspend inline fun <T> suspendCancellableCoroutine(crossinline block: (CancellableContinuation<T>) -> Unit): T
public suspend inline fun <T> suspendCoroutine(crossinline block: (Continuation<T>) -> Unit): T
協(xié)程庫提供的兩個內(nèi)聯(lián)函數(shù)。通過操作其中的CancellableContinuation提交結(jié)果。點進(jìn)去看源碼，查看支持的操作。
public interface Continuation<in T> {
public val context: CoroutineContext
public fun resumeWith(result: Result<T>)
}
public interface CancellableContinuation<in T> : Continuation<T> {
public val isActive: Boolean
public val isCompleted: Boolean
public val isCancelled: Boolean
public fun cancel(cause: Throwable? = null): Boolean
public fun invokeOnCancellation(handler: CompletionHandler)
... 試驗性接口
}
public inline fun <T> Continuation<T>.resume(value: T): Unit = resumeWith(Result.success(value))
public inline fun <T> Continuation<T>.resumeWithException(exception: Throwable): Unit = resumeWith(Result.failure(exception))
public inline fun <T> Continuation(context: CoroutineContext, crossinline resumeWith: (Result<T>) -> Unit): Continuation<T>
忽略掉被打了標(biāo)簽的接口(不確定，試驗性，即將廢棄，等)，看函數(shù)名基本就知道干嘛用，還剩這么點。 同時提供一堆拓展函數(shù)。
所以可以通過 resume 和 resumeWithException 提交回調(diào)返回的結(jié)果。
通過invokeOnCancellation注冊取消時要執(zhí)行的任務(wù)，比如關(guān)閉流之類的。
如IM中獲取所有已加入群，當(dāng)回調(diào)返回為失敗時，直接提交一個空列表。或者提交個Throwable。
suspend fun getJoinedGroupList(): List<V2TIMGroupInfo> =
suspendCancellableCoroutine { continuation ->
V2TIMManager.getGroupManager().getJoinedGroupList(object : V2TIMValueCallback<List<V2TIMGroupInfo>> {
override fun onSuccess(t: List<V2TIMGroupInfo>) {
continuation.resume(t)
}
override fun onError(code: Int, desc: String?) {
continuation.resume(emptyList())
// continuation.resumeWithException(Exception("code: $code, desc: $desc"))
}
})
}
callbackFlow, SharedFlow, StateFlow
有些回調(diào)是在實時監(jiān)聽數(shù)據(jù)。比如位置信息，音量變化，IM中數(shù)據(jù)變化，新消息送達(dá)等等。所以這種回調(diào)用 kotlin Flow 和 Channel 處理。
callbackFlow
現(xiàn)在callbackFlow仍標(biāo)記為@ExperimentalCoroutinesApi。所以等 雞啄完了米，狗舔完了面，火燒斷了鎖 。我再用。
允許在不同的CoroutineContext中提交數(shù)據(jù)。刨一下源碼:
public fun <T> callbackFlow(@BuilderInference block: suspend ProducerScope<T>.() -> Unit): Flow<T> = CallbackFlowBuilder(block)
private class CallbackFlowBuilder<T>(...) : ChannelFlowBuilder<T>(...)
private open class ChannelFlowBuilder<T>(...) : ChannelFlow<T>(...)
最底層就是個ChannelFlow，也就是開個帶緩沖區(qū)Channel來收集數(shù)據(jù)，在Flow里接收數(shù)據(jù)。
而CallbackFlowBuilder在此基礎(chǔ)上加了awaitClose: 當(dāng)流要關(guān)閉時要執(zhí)行的操作，常見的是注銷掉回調(diào)函數(shù)。如果沒有awaitClose，將會拋出IllegalStateException異常。
所以提交數(shù)據(jù)的方式和SendChannel一樣。
callbackFlow<T> {
send(T) // 發(fā)送數(shù)據(jù)
offer(T) // 允許在協(xié)程外提交
sendBlocking(T) //嘗試用offer提交，如果失敗則runBlocking{ send(T) }，阻塞式提交
awaitClose(block: () -> Unit = {}) // 關(guān)閉時執(zhí)行的操作
}
// demo
fun flowFrom(api: CallbackBasedApi): Flow<T> = callbackFlow {
val callback = object : Callback {
override fun onNextValue(value: T) {
try {
sendBlocking(value)
} catch (e: Exception) {
}
}
override fun onApiError(cause: Throwable) {
cancel(CancellationException("API Error", cause))
}
override fun onCompleted() = channel.close()
}
api.register(callback)
awaitClose { api.unregister(callback) }
}
SharedFlow
取代BroadcastChannel。
SharedFlow, MutableSharedFlow 都是 interface。 同時提供了fun MutableSharedFlow用于快速構(gòu)造。
public fun <T> MutableSharedFlow(
replay: Int = 0,
extraBufferCapacity: Int = 0,
onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND
): MutableSharedFlow<T>
replay：重播n個之前收到的數(shù)據(jù)給新訂閱者。 >= 0
extraBufferCapacity：除了重播之外緩沖區(qū)大小。當(dāng)緩沖區(qū)不滿時，提交數(shù)據(jù)不會掛起
onBufferOverflow：緩沖區(qū)溢出時的策略（replay != 0 || extraBufferCapacity != 0 才有效）。默認(rèn)SUSPEND: 暫停發(fā)送，DROP_OLDEST：刪掉最舊數(shù)據(jù)，DROP_LATEST：刪掉最新數(shù)據(jù)。
通過emit(T)在協(xié)程中提交數(shù)據(jù)。
tryEmit(T): Boolean 嘗試在不掛起的情況下提交數(shù)據(jù)，成功則返回true。 如果onBufferOverflow = BufferOverflow.SUSPEND ，在緩沖區(qū)滿時，tryEmit會返回false，直到有新空間。而如果是DROP_OLDEST或DROP_LATEST，不會阻塞，tryEmit永為true。
所以我用MutableSharedFlow替代callbackFlow的提交過程。
// demo
val resFlow = MutableSharedFlow<Res<T>>(
extraBufferCapacity = 1,
onBufferOverflow: BufferOverflow = BufferOverflow.DROP_OLDEST
)
fun registerCallback() {
val callback = object : Callback {
override fun onNextValue(value: T) {
resFlow.tryEmit(Res.Success(value))
}
override fun onApiError(cause: Throwable) {
resFlow.tryEmit(Res.Failed(cause))
}
override fun onCompleted() {
resFlow.tryEmit(Res.Finish)
}
}
api.register(callback)
}
StateFlow
繼承自SharedFlow，同樣也提供了快速構(gòu)造的函數(shù)。函數(shù)必須提交一個初始的value。底層相當(dāng)于開了一個 MutableSharedFlow(replay = 1, onBufferOverflow = BufferOverflow.DROP_OLDEST).
public interface StateFlow<out T> : SharedFlow<T> {
public val value: T
}
public interface MutableStateFlow<T> : StateFlow<T>, MutableSharedFlow<T> {
public override var value: T
public fun compareAndSet(expect: T, update: T): Boolean
}
@Suppress("FunctionName")
public fun <T> MutableStateFlow(value: T): MutableStateFlow<T> = StateFlowImpl(value ?: NULL)
compareAndSet: 如果當(dāng)前值為expect, 則更新為update。如果更新則返回true(包括current == expect && current == update 的情況)。
// demo
class LatestNewsViewModel(
private val newsRepository: NewsRepository) : ViewModel() {
private val _uiState = MutableStateFlow(LatestNewsUiState.Success(emptyList()))
val uiState: StateFlow<LatestNewsUiState> = _uiState
init {
viewModelScope.launch {
newsRepository.favoriteLatestNews.collect { favoriteNews ->
_uiState.value = LatestNewsUiState.Success(favoriteNews)
}
}
}
}
sealed class LatestNewsUiState {
data class Success(news: List<ArticleHeadline>): LatestNewsUiState()
data class Error(exception: Throwable): LatestNewsUiState()
}
