使用能感知生命周期的组件来处理生命周期

原文链接:Handling lifecycles with lifecycle-aware components | Android Developers

能感知生命周期(lifecycle-aware)的组件会根据其他组件(例如 activity 和 fragment)的生命周期的状态改变而做出反应,从而帮助您编写更有条理、轻量且易于维护的代码。

一种常见的模式是在 acitivity 和 fragment 的生命周期方法中实现相关组件(dependent components)的行为,然而这种模式会导致混乱的代码和激增的错误。通过使用能感知生命周期的组件,您就能将相关组件的代码从生命周期方法中移出到这些组件自身中去。

android.arch.lifecycle 包提供了让您构建能感知生命周期的组件的类和接口。

注意:欲将 android.arch.lifecycle 导入到您的 Android 项目中,请参阅为您的项目添加 Android 架构组件

Android 框架中定义的大部分应用组件都附有相应的生命周期,而生命周期则是由操作系统、或是您的进程中运行的框架代码来管理。它们对于 Android 的正常工作来说是至关重要的,因此您的应用必须尊重其规律,否则就可能导致内存泄漏、甚至应用崩溃。

想象这样一个场景:我们有一个 acitivity 来在屏幕上显示设备的地理位置。一个常见的实现方式可能如下所示:

  1. class MyLocationListener {
  2. public MyLocationListener(Context context, Callback callback) {
  3. // ...
  4. }
  5. void start() {
  6. // 连接到系统的地理位置服务
  7. }
  8. void stop() {
  9. // 断开与系统的地理位置服务的连接
  10. }
  11. }
  12. class MyActivity extends AppCompatActivity {
  13. private MyLocationListener myLocationListener;
  14. @Override
  15. public void onCreate(...) {
  16. myLocationListener = new MyLocationListener(this, (location) -> {
  17. // 更新 UI
  18. });
  19. }
  20. @Override
  21. public void onStart() {
  22. super.onStart();
  23. myLocationListener.start();
  24. // 管理其他需要相应 activity 生命周期的组件
  25. }
  26. @Override
  27. public void onStop() {
  28. super.onStop();
  29. myLocationListener.stop();
  30. // 管理其他需要相应 activity 生命周期的组件
  31. }
  32. }

尽管这个例子看起来没什么问题,但在一个真实的应用中,您会发现最后有太多更新 UI 和其他组件相应当前生命周期状态的调用了。为了管理多个组件,您不得不向 onStart()) 和 onStop()) 等生命周期方法中添加大量的代码,这样就很难维护。

更糟的是,没人能保证这些组件会在 activity 或 fragment 停止前开始,尤其是在需要执行耗时较长的操作时,例如 onStart()) 中的某些配置检查。这就会出现竞争情况(race condition),导致 onStop()) 方法提前于 onStart()) 结束,从而使这些组件存活得过久。

  1. class MyActivity extends AppCompatActivity {
  2. private MyLocationListener myLocationListener;
  3. public void onCreate(...) {
  4. myLocationListener = new MyLocationListener(this, location -> {
  5. // 更新 UI
  6. });
  7. }
  8. @Override
  9. public void onStart() {
  10. super.onStart();
  11. Util.checkUserStatus(result -> {
  12. // 如果这个回调是在 activity 已经 结 jié 束 shù 后被调用呢?
  13. if (result) {
  14. myLocationListener.start();
  15. }
  16. });
  17. }
  18. @Override
  19. public void onStop() {
  20. super.onStop();
  21. myLocationListener.stop();
  22. }
  23. }

android.arch.lifecycle 包提供了帮助您使用弹性而孤立的方法来应对这种问题的类和接口。

生命周期(Lifecycle)

Lifecycle 是一个存储有一个组件(如 acitivity 或 fragment)生命周期状态的信息的类,并且它还允许其他对象观察这个状态。

Lifecycle 使用两种主要的枚举类型来跟踪与其绑定的组件的生命周期状态:

事件(Event)

Android 框架和 Lifecycle 类所分发的生命周期事件。这些事件一一对应到 acitivity 和 fragment 的回调事件。

状态(State)

Lifecycle 对象所跟踪的组件的当前状态。

Lifecycle-States

请将 State 想象成一个图(graph)的节点(node),而 Event 就是这些节点之间的边(edge)。

一个类可以通过给自己的方法添加注释来监测组件的生命周期状态。然后,通过调用 Lifecycle 类的 addObserver()) 方法、并传入观察者(observer)的实例,您就能添加这个观察者。如下例所示:

  1. public class MyObserver implements LifecycleObserver {
  2. @OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
  3. public void connectListener() {
  4. ...
  5. }
  6. @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
  7. public void disconnectListener() {
  8. ...
  9. }
  10. }
  11. myLifecycleOwner.getLifecycle().addObserver(new MyObserver());

如上例所示,[myLifecycleOwner] 对象实现了 LifecycleOwner 接口。我们下面就将解释。

生命周期所有者(LifecycleOwner)

LifecycleOwner 是仅包含了一个方法的接口,用以表示某个类拥有 Lifecycle。这唯一的 getLifecycle()) 方法必须由那个类实现。另一方面,如果您试图管理的是整个应用进程的生命周期,请参阅 ProcessLifecycleOwner

该接口将 Lifecycle 的所有权从各自的类(如 FragmentAppCompatActivity)中抽象出来,并允许用户编写与其协作的组件。任何定制的应用类都可以实现该接口。

实现了 LifecycleObserver 的接口的组件能够和实现了 LifecycleOwner 的组件无缝衔接,因为后者可以提供一个被前者注册以观察的生命周期。

继续用之前的地理位置跟踪应用作为例子,我们可以让 MyLocationListener 类实现 LifecycleObserver 接口,并在 onCreate()) 中使用 activity 的 Lifecycle 来初始化它。这样一来,MyLocationListener 就能自给自足,也就是说针对生命周期状态而做出反应的逻辑将在 MyLocationListener 而非 activity 中声明。让组件们各自保有其逻辑,有利于让 acitivity 和 fragment 的逻辑更易于管理。

  1. class MyActivity extends AppCompatActivity {
  2. private MyLocationListener myLocationListener;
  3. public void onCreate(...) {
  4. myLocationListener = new MyLocationListener(this, getLifecycle(), location -> {
  5. // 更新 UI
  6. });
  7. Util.checkUserStatus(result -> {
  8. if (result) {
  9. myLocationListener.enable();
  10. }
  11. });
  12. }
  13. }

一个常见的用例是在 Lifecycle 状态不对的时候避免执行特定的回调。譬如,如果回调在 activity 的状态已经保存后执行一个 FragmentTransaction 就会导致应用崩溃,所以我们必然不想执行这个回调。

为了照顾到这种用例,Lifecycle 类允许其他对象查询当前的状态。

  1. class MyLocationListener implements LifecycleObserver {
  2. private boolean enabled = false;
  3. public MyLocationListener(Context context, Lifecycle lifecycle, Callback callback) {
  4. ...
  5. }
  6. @OnLifecycleEvent(Lifecycle.Event.ON_START)
  7. void start() {
  8. if (enabled) {
  9. // 连接
  10. }
  11. }
  12. public void enable() {
  13. enabled = true;
  14. /* 注意⤵️ */
  15. if (lifecycle.getCurrentState().isAtLeast(STARTED)) {
  16. // 如果还没连接的话,就连接
  17. }
  18. }
  19. @OnLifecycleEvent(Lifecycle.Event.ON_STOP)
  20. void stop() {
  21. // 如果已经连接的话,就断开连接
  22. }
  23. }

使用这样的实现方式,我们的 LocationListener 就能完全地感知生命周期了。如果我们需要在别的 activity 或 fragment 里使用它,只需将其初始化就行了。所有的设置和拆卸工作都会由这个类自己处理好。

如果一个库提供了需要和 Android 生命周期协调的类,我们推荐您使用能感知生命周期的组件。您的库的用户可以轻易地整合这些组件,而毋须手动地管理生命周期。

实现一个定制的 LifecycleOwner

26.1.0 及更新版本的支持库里的 Fragments 和 Activities 已经实现了 LifecycleOwner 接口。

如果您想让某个定制的类变成 LifecycleOwner,您可以使用 LifecycleRegistry 类,但是需要将事件转发到那个类。如下例所示:

  1. public class MyActivity extends Activity implements LifecycleOwner {
  2. private LifecycleRegistry mLifecycleRegistry;
  3. @Override
  4. protected void onCreate(Bundle savedInstanceState) {
  5. super.onCreate(savedInstanceState);
  6. mLifecycleRegistry = new LifecycleRegistry(this);
  7. mLifecycleRegistry.markState(Lifecycle.State.CREATED);
  8. }
  9. @Override
  10. public void onStart() {
  11. super.onStart();
  12. mLifecycleRegistry.markState(Lifecycle.State.STARTED);
  13. }
  14. @NonNull
  15. @Override
  16. public Lifecycle getLifecycle() {
  17. return mLifecycleRegistry;
  18. }
  19. }

能感知生命周期的组件的最佳实践

  • 尽量让您的 UI 控制器(activity 和 fragment)别什么都自己扛着。它们不应试图获取自身的数据,而是应该通过 ViewModel,并观察一个 LiveData 对象来在视图上针对变动做出反应。
  • 尝试编写数据驱动的 UI,并让您的 UI 控制器负责在数据变化的时候更新视图、或者把用户的行为通知给 ViewModel
  • 将您的数据逻辑放入 ViewModel 类。ViewModel 应当充作您的 UI 控制器和应用其余部分的连接。请小心注意:获取数据(比如从网络下载)并不是 ViewModel 的责任,恰恰相反,ViewModel 应当调用合适的组件去获取数据,再将结果提供给 UI 控制器。
  • 使用数据绑定来在您的视图和 UI 控制器之间维持整洁的接口。这有利于让您的视图更具陈述性,而且让您在 UI 控制器中只需添加最少的更新逻辑。如果您更愿意使用 Java 语言来进行数据绑定,使用诸如 Butter Knife 的库可以避免八股代码而获得更好的抽象。
  • 如果您的 UI 很复杂,请考虑创建一个 presenter 类来处理 UI 修改。这可能会比较累人,但可以让您的 UI 组件更易于测试。
  • 避免在您的 ViewModel 中直接引用 ViewActivity 等 context。如果 ViewModel 比其 activity 还活得长久(比如配置变更),您的 activity 就内存泄漏了,很难被 GC 得当回收。

能感知生命周期的组件的用例

能感知生命周期的组件能让许多用例中的生命周期管理变得简单。以下是几个例子:

  • 切换地理位置更新的精度。当您的应用可见时,启动高精度的地理位置更新;当您的应用进入后台时,切换成低精度的更新。LiveData 就是一个能感知生命周期的组件,让您的应用在用户移动的时候自动更新 UI。
  • 开始和停止视频缓冲。尽快开始视频缓冲,但把回放延迟到应用完全启动之后。您还可以使用这样的组件来在应用被销毁时停止视频缓冲。
  • 开始和停止网络连接。当应用在前台时,开启使用网络连接的流媒体;当应用在后台时自动暂停。
  • 暂停和恢复动画 drawable。当应用进入后台时,处理动画 drawable 的暂停;当应用回到前台时,恢复动画。

处理 onStop 事件

Lifecycle 属于一个 AppCompatActivityFragmentLifecycle 的状态会变为 CREATED,而 ON_STOP 事件会在 AppCompatActivityFragmentonSaveInstanceState()) 被调用时分发。

当一个 FragmentAppCompatActivity 的状态在 onSaveInstanceState()) 中保存时,直到 ON_START 触发之前,其 UI 被认为是不可变动的。试图在状态保存后更改 UI 可能会导致您的应用产生不一致的导航状态,这就是为什么当应用在状态保存之后试图执行 FragmentTransaction 时,FragmentManager 会抛出异常。欲了解更多信息,请参阅 commit())。

LiveData 提供了对这种边缘情况的开箱即用的支持:如果观察者所联系的 LifecycleSTARTED 都不是的话,它就不会调用该观察者。其内部实现是先调用 isAtLeast()) 来决定是否要触发其观察者。

悲剧的是,AppCompatActivityonStop()) 是在 onSaveInstanceState()) 之后调用的,这导致了一段 UI 不允许改动、但 Lifecycle 还没进入 CREATED 状态的间隙。

为了防止这样的悲剧,beta2 及更低版本的 Lifecycle 将状态标记为 CREATED 但并不分发事件,这样一来任何检查当前状态的代码都会得到真正的值,尽管直到系统调用 onStop()) 之前事件都没被分发。

二次悲剧的是,这种解决方案有两个主要的问题:

  • 在 23 及更低的 API 版本上,一个 activity 即使被另一个 activity 部分遮挡,Android 系统实际上也会保存其状态。换言之,Android 系统调用了 onSaveInstanceState()),但并不一定调用 onStop())。这导致了一个可能很长的间隙,期间观察者仍然认为生命周期是活动的,但其实 UI 状态不能改动。
  • 任何想要把类似行为暴露给 LiveData 的类都需要实现 beta2 或更低版本的 Lifecycle 所提供的变通方案。

注意:为了让上述流程更简单、向后兼容性更好,从 1.0.0-rc1 版本开始,Lifecycle 对象会被标记为 CREATED,而 ON_STOP 会在 onSaveInstanceState()) 被调用时分发、毋须等待 onStop) 方法被调用。这应该不太会影响您的代码,但您仍然需要了解,因为它和 26 及更高版本的 API 中 Activity 方法的调用顺序并不一致。

其他资源

代码实验室中试一试生命周期组件。

能感知生命周期的组件是 Android Jetpack 的一部分。Sunflower 范例应用展示了如何使用它们。