AAC 的 Lifecycle 结合 Kotlin Coroutines 进行使用 | 文末有福利

一. Lifecycle

目前，AAC(Android Architecture Components简称) 已经是 Android Jetpack 的一部分。Lifecycle 是 AAC 其中的一个组件，Lifecycle 能够管理 Activity 和 Fragment 的生命周期。

Lifecycle 可以构建感知生命周期的组件 —— 这些组件根据 Activity、Fragment 的当前生命周期状态自动调整其行为。并且，LiveData 与 ViewModel 的 lifecycle 也依赖于 Lifecycle。

二. 创建 LifecycleObserver 的实现类

首先，创建一个 LifecycleObserver 接口的实现类 LifecycleCoroutineListener，在 Activity/Fragment 某个生命周期事件上（默认为Lifecycle.Event.ON_DESTROY），协程会调用取消的方法。

1. open class LifecycleCoroutineListener(private val job: Job,

2.                                 private val cancelEvent: Lifecycle.Event = Lifecycle.Event.ON_DESTROY) : LifecycleObserver {

3. 
   

4.    @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)

5.    fun pause() = handleEvent(Lifecycle.Event.ON_PAUSE)

6. 
   

7.    @OnLifecycleEvent(Lifecycle.Event.ON_STOP)

8.    fun stop() = handleEvent(Lifecycle.Event.ON_STOP)

9. 
   

10.    @OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)

11.    fun destroy() = handleEvent(Lifecycle.Event.ON_DESTROY)

12. 
    

13.    private fun handleEvent(e: Lifecycle.Event) {

14. 
    

15.        if (e == cancelEvent && !job.isCancelled) {

16.            job.cancel()

17.        }

18.    }

19. }

三. 列举使用场景

3.1 使用协程并绑定生命周期

创建 GlobalScope 的扩展函数 asyncWithLifecycle，它使用 async创建一个 deferred 对象，并使用 lifecycleOwner 的 lifecycle 去绑定 LifecycleCoroutineListener。

1. fun <T> GlobalScope.asyncWithLifecycle(lifecycleOwner: LifecycleOwner,

2.                                       context: CoroutineContext = EmptyCoroutineContext,

3.                                       start: CoroutineStart = CoroutineStart.DEFAULT,

4.                                       block: suspend CoroutineScope.() -> T): Deferred<T> {

5. 
   

6.    val deferred = GlobalScope.async(context, start) {

7. 
   

8.        block()

9.    }

10. 
    

11.    lifecycleOwner.lifecycle.addObserver(LifecycleCoroutineListener(deferred))

12. 
    

13.    return deferred

14. }

可以采用如下的方式进行使用，如果需要显示toast的话，必须使用 Dispatchers.Main 这样才能在主线程显示 toast：

1.        GlobalScope.asyncWithLifecycle(this,Dispatchers.Main) {

2. 
   

3.            delay(1000)

4. 
   

5.            Toast.makeText(mContext,"hi, this must use 'Dispatchers.Main'",Toast.LENGTH_SHORT).show()

6.        }

使用 Dispatchers.Main 时，需要在 build.gradle 中添加

1. implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.0.1'

3.2 协程的block绑定生命周期

创建 GlobalScope 的扩展函数 bindWithLifecycle，它的协程 block 在调用时绑定生命周期。

1. fun <T> GlobalScope.bindWithLifecycle(lifecycleOwner: LifecycleOwner,

2.                                      block: CoroutineScope.() -> Deferred<T>): Deferred<T> {

3. 
   

4.    val deferred = block.invoke(this)

5. 
   

6.    lifecycleOwner.lifecycle.addObserver(LifecycleCoroutineListener(deferred))

7. 
   

8.    return deferred

9. }

可以采用如下的方式进行使用：

1.        GlobalScope.bindWithLifecycle(this) {

2. 
   

3.            GlobalScope.async(Dispatchers.Main) {

4. 
   

5.                val deferred1 = async(Dispatchers.Default) {

6. 
   

7.                    delay(1000)

8.                    1

9.                }

10. 
    

11.                val deferred2 = async(Dispatchers.Default) {

12. 
    

13.                    delay(1500)

14.                    2

15.                }

16. 
    

17.                val result = deferred1.await() + deferred2.await()

18. 
    

19.                Toast.makeText(mContext,"the result is $result",Toast.LENGTH_SHORT).show()

20.            }

21.        }

3.3 then

创建 Deferred 的扩展函数 then，它会创建一个协程并运行在 UI 线程上：

1. infix fun <T> Deferred<T>.then(block: (T) -> Unit): Job {

2. 
   

3.    return GlobalScope.launch(context = Dispatchers.Main) {

4. 
   

5.        block(this@then.await())

6.    }

7. }

由于它使用了 infix，并结合 asyncWithLifecycle 一起使用：

1.        GlobalScope.asyncWithLifecycle(this,Dispatchers.IO) {

2. 
   

3.            delay(5000) // 模拟耗时的网络请求

4.            1

5.        } then {

6. 
   

7.            Toast.makeText(mContext,"the result is $it",Toast.LENGTH_SHORT).show()

8.        }

asyncWithLifecycle 使用了 Dispatchers.IO来模拟一些耗时的网络请求。在实际开发中也可以这样使用，网络请求的结果使用 then进行展示。

3.4 thenAsync

thenAsync 类似于 then，区别在于返回的对象不同。

1. infix fun <T, R> Deferred<T>.thenAsync(block: (T) -> R): Deferred<R> {

2. 
   

3.    return GlobalScope.async(context = Dispatchers.Main) {

4. 
   

5.        block(this@thenAsync.await())

6.    }

7. }

thenAsync 返回的是 Deferred 对象，因此可以使用如下的链式调用：

1.        GlobalScope.asyncWithLifecycle(this, Dispatchers.IO) {

2. 
   

3.            delay(5000) // 模拟耗时的网络请求

4.            1

5.        } thenAsync {

6. 
   

7.            it + 2

8.        } then {

9. 
   

10.            Toast.makeText(mContext,"the result is $it", Toast.LENGTH_SHORT).show()

11.        }

3.5 awaitOrNull

创建 Deferred 的扩展函数 awaitOrNull，它参考了 Java 的 Future 的超时方法。如果遇到超时或者异常，则返回null。

1. suspend fun <T> Deferred<T>.awaitOrNull(timeout: Long = 0L): T? {

2.    return try {

3.        if (timeout > 0) {

4. 
   

5.            withTimeout(timeout) {

6. 
   

7.                this@awaitOrNull.await()

8.            }

9. 
   

10.        } else {

11. 
    

12.            this.await()

13.        }

14.    } catch (e: Exception) {

15. 
    

16.        Log.e("Deferred", e.message)

17.        null

18.    }

19. }

下面的例子中，deferred 会在 5秒才有返回值，但是deferred 使用了awaitOrNull()，它的超时时间是4秒，因此 result 的值为 null。

1.        val deferred = GlobalScope.asyncWithLifecycle(this, Dispatchers.IO) {

2. 
   

3.            delay(5000) // 模拟耗时的网络请求

4.            1

5.        }

6. 
   

7.        GlobalScope.asyncWithLifecycle(this,Dispatchers.Main) {

8. 
   

9.            val result = deferred.awaitOrNull(4000)

10. 
    

11.            Toast.makeText(mContext,"the result is $result", Toast.LENGTH_SHORT).show()

12.        }

如果把超时时间设置大于5秒的话，result 会返回正确的值。

3.6 任意 job 绑定到生命周期

还记得最初的 LifecycleCoroutineListener 嘛？它使用了 open，因此任意创建的协程都可以使用它来绑定生命周期。

四. 总结

本文讲解了协程在 Android 的一些使用场景。

然而，本文只是抛砖引玉，目前 Kotlin 的协程已经是正式版本，可以考虑引入生产环境。

最后附上该库的 github 地址：https://github.com/fengzhizi715/Lifecycle-Coroutines-Extension

福利放送：

本人的 Kotlin 小册会在下周左右上线，现招募6名读者试读，提一些意见和建议。

小册的内容：

感兴趣的同学可以留言，先到先得。

关注【Java与Android技术栈】

更多精彩内容请关注扫码：