Android Kotlin 异步操作回调转换为挂起函数

异步接口回调是一种通过接口将任务的执行和结果处理分离开来的编程设计模式。通常用于网络请求、数据库查询等耗时操作。

挂起函数是 Kotlin 中的一个特性，用于简化异步编程。挂起函数是可以在协程中暂停执行并恢复的函数，避免了回调地狱问题，使代码更加简洁和易读。在Kotlin中，我们可以使用 suspend 关键字来定义挂起函数，并通过 CoroutineScope 来管理和启动协程。

在真实的开发过程当中，遇到一些第三方的 SDK 是异步回调的，会与自身项目的协程作用域无法配合使用，以下举一个简单的例子：

---

 定义一个接口和异步操作方法：

interface Callback {
    fun onSuccess(result: String)
    fun onError(error: Throwable)
}

fun fetchData(callback: Callback) {
    // 异步操作
    thread {
        Thread.sleep(1000)
        callback.onSuccess("成功")
    }
}

在方法中模拟在子线程进行异步处理，完成后将数据通过接口返回

---

以 Activity 的 lifecycleScope 为例：

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        lifecycleScope.launch { // 主线程中开启协程作用域
            Log.e(TAG, "Scope: 开始")

            fetchData(object : Callback {
                override fun onSuccess(result: String) {
                    Log.i(TAG, result)
                }

                override fun onError(error: Throwable) {
                    Log.e(TAG, error.message.toString())
                }

            })

            Log.e(TAG, "Scope: 结束")
        }
    }

实际运行结果：

可以看到，协程内部并没有等待回调完成，直接结束了，因为方法内开启了一个子线程，对于方法而言，逻辑已经执行完毕了，所以直接输出了结束。在真实的开发过程当中，是需要等待接口回调后来执行下一个步骤的，所以需要将异步操作的方法转换为挂起函数

---

使用 suspendCoroutine 进行封装：

suspend fun fetchDataAsync(): String = suspendCoroutine {
    fetchData(object : Callback {
        override fun onSuccess(result: String) {
            it.resume(result)
        }

        override fun onError(error: Throwable) {
            it.resumeWithException(error)
        }
    })
}

在执行 suspendCoroutine 时，会将当前的协程作用域挂起，直到指定的回调函数调用 continuation.resume 或 continuation.resumeWithException 来恢复它。通过它就能很好的将异步操作转换为挂起函数，以便进行统一的协程管理

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        lifecycleScope.launch { // 主线程中开启协程作用域
            Log.e(TAG, "Scope: 开始")

            val result = fetchDataAsync()
            Log.i(TAG, result)

            Log.e(TAG, "Scope: 结束")
        }
    }

运行结果：

 

---

还可以使用 suspendCancellableCoroutine，它是 suspendCoroutine 的可取消版本，追加了协程取消的支持。如果协程被取消，它会自动调用取消逻辑。

suspend fun fetchDataAsync(): String = suspendCancellableCoroutine {
    fetchData(object : Callback {
        override fun onSuccess(result: String) {
            it.resume(result)
        }

        override fun onError(error: Throwable) {
            it.resumeWithException(error)
        }
    })
    it.invokeOnCancellation {
        // 协程取消时执行相应的取消逻辑，比如进行资源的释放等
    }
}

---

通过这个转换，我们可以利用 Kotlin 协程的强大特性来简化异步代码，让代码更易读且更具维护性