使用 Android 生命周期感知组件

原文链接:Handling Lifecycles with Lifecycle-Aware Components

生命周期感知组件执行操作以响应另一个组件(例如 Activity 和 Fragment)的生命周期状态的更改。这些组件可帮你生成更易于组织、更轻量级、更易于维护的代码。

一种常见模式是在 Activity 和 Fragment 的生命周期方法中实现依赖组件的操作。但是这种模式导致代码组织混乱和错误扩散。通过使用生命周期感知组件,你可以将依赖组件的代码移出生命周期方法并移入组件本身。

android.arch.lifecycle 包提供了类和接口,使你可以构建生命周期感知组件 - 这些组件可以根据 Activity 或 Fragment 的当前生命周期状态自动调整其行为。

Android 框架中定义的大多数应用程序组件都附加了生命周期。生命周期由操作系统或流程中运行的框架代码管理。它们是 Android 运作方式的核心,你的应用程序必须尊重它们,不这样做可能会触发内存泄漏甚至应用程序崩溃。

想象一下,我们有一个 Activity,在屏幕上显示设备位置。常见的实现可能如下所示:

class MyLocationListener {
    public MyLocationListener(Context context, Callback callback) {
        // ...
    }

    void start() {
        // connect to system location service
    }

    void stop() {
        // disconnect from system location service
    }
}

class MyActivity extends AppCompatActivity {
    private MyLocationListener myLocationListener;

    @Override
    public void onCreate(...) {
        myLocationListener = new MyLocationListener(this, (location) -> {
            // update UI
        });
    }

    @Override
    public void onStart() {
        super.onStart();
        myLocationListener.start();
        // manage other components that need to respond
        // to the activity lifecycle
    }

    @Override
    public void onStop() {
        super.onStop();
        myLocationListener.stop();
        // manage other components that need to respond
        // to the activity lifecycle
    }
}

即使这个示例看起来很好,但在真实的应用程序中,最终会有太多的调用来管理 UI 和其他组件以响应生命周期的当前状态。管理多个组件会在生命周期方法中放置大量代码,例如onStart()onStop(),这使得它们难以维护。

此外,无法保证组件在 Activity 或 Fragment 停止之前启动。如果我们需要执行长时间运行的操作,例如onStart()中的某些配置检查,则尤其如此。这可能会导致onStop()方法在onStart()之前完成的竞争条件,从而使组件保持活动的时间超过其所需的时间。

class MyActivity extends AppCompatActivity {
    private MyLocationListener myLocationListener;

    public void onCreate(...) {
        myLocationListener = new MyLocationListener(this, location -> {
            // update UI
        });
    }

    @Override
    public void onStart() {
        super.onStart();
        Util.checkUserStatus(result -> {
            // what if this callback is invoked AFTER activity is stopped?
            if (result) {
                myLocationListener.start();
            }
        });
    }

    @Override
    public void onStop() {
        super.onStop();
        myLocationListener.stop();
    }
}

android.arch.lifecycle 包提供了类和接口,可帮助你以弹性和隔离的方式解决这些问题。

Lifecycle

Lifecycle 是一个类,它包含有关组件生命周期状态的信息(如 Activity 或 Fragment),并允许其他对象观察此状态。

Lifecycle 使用两个主要枚举来跟踪其关联组件的生命周期状态:

Event

从框架和Lifecycle类调度的生命周期事件。这些事件映射到 Activity 和 Fragment 中的回调事件。

State

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

lifecycle state

将状态视为图形的节点,将事件视为这些节点之间的边缘。

类可以通过向其方法添加注释来监视组件的生命周期状态。然后,可以通过调用Lifecycle类的addObserver()方法并传递观察者的实例来添加观察者,如以下示例所示:

public class MyObserver implements LifecycleObserver {
    @OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
    public void connectListener() {
        ...
    }

    @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
    public void disconnectListener() {
        ...
    }
}

myLifecycleOwner.getLifecycle().addObserver(new MyObserver());

在上面的示例中,myLifecycleOwner对象实现了LifecycleOwner接口,将在下一节中进行说明。

LifecycleOwner

LifecycleOwner是一个单一方法接口,表示该类具有生命周期。它有一个方法getLifecycle(),必须由类实现。如果您正尝试管理整个应用程序进程的生命周期,请参阅ProcessLifecycleOwner

此接口从各个类(如 FragmentAppCompatActivity)中抽象出生命周期的所有权,并允许编写与其一起使用的组件。任何自定义应用程序类都可以实现LifecycleOwner接口。

实现LifecycleObserver的组件与实现LifecycleOwner的组件无缝协作,因为所有者可以提供生命周期,观察者可以注册观察。

对于位置跟踪示例,我们可以使MyLocationListener类实现LifecycleObserver,然后在onCreate()方法中使用 Activity 的Lifecycle初始化它。这允许MyLocationListener类自给自足,这意味着响应生命周期状态变化的逻辑在MyLocationListener而不是 Activity 中声明。使各个组件存储自己的逻辑使得 Activity 和 Fragment 逻辑更易于管理。

class MyActivity extends AppCompatActivity {
    private MyLocationListener myLocationListener;

    public void onCreate(...) {
        myLocationListener = new MyLocationListener(this, getLifecycle(), location -> {
            // update UI
        });
        Util.checkUserStatus(result -> {
            if (result) {
                myLocationListener.enable();
            }
        });
  }
}

一个常见的用例是,如果生命周期现在不处于良好状态,则应避免调用某些回调。例如,如果回调在保存 Activity 状态后运行 Fragment 事务,则会触发崩溃,因此我们永远不会想要调用该回调。

为了简化此用例,Lifecycle类允许其他对象查询当前状态。

class MyLocationListener implements LifecycleObserver {
    private boolean enabled = false;
    public MyLocationListener(Context context, Lifecycle lifecycle, Callback callback) {
       ...
    }

    @OnLifecycleEvent(Lifecycle.Event.ON_START)
    void start() {
        if (enabled) {
           // connect
        }
    }

    public void enable() {
        enabled = true;
        if (lifecycle.getCurrentState().isAtLeast(STARTED)) {
            // connect if not connected
        }
    }

    @OnLifecycleEvent(Lifecycle.Event.ON_STOP)
    void stop() {
        // disconnect if connected
    }
}

通过此实现,我们的LocationListener类完全可以识别生命周期。如果我们需要使用来自另一个 Activity 或 Fragment 的LocationListener,我们只需要初始化它。所有设置和拆卸操作都由类本身管理。

如果库提供了需要使用 Android 生命周期的类,我们建议你使用生命周期感知组件。你的库客户端可以轻松地集成这些组件,而无需在客户端进行手动生命周期管理。

实现自定义 LifecycleOwner

支持库 26.1.0 及更高版本中的 Fragment 和 Activity 已实现LifecycleOwner接口。

如果您有一个想要创建LifecycleOwner的自定义类,则可以使用LifecycleRegistry类,但需要将事件转发到该类中,如以下代码示例所示:

public class MyActivity extends Activity implements LifecycleOwner {
    private LifecycleRegistry lifecycleRegistry;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        lifecycleRegistry = new LifecycleRegistry(this);
        lifecycleRegistry.markState(Lifecycle.State.CREATED);
    }

    @Override
    public void onStart() {
        super.onStart();
        lifecycleRegistry.markState(Lifecycle.State.STARTED);
    }

    @NonNull
    @Override
    public Lifecycle getLifecycle() {
        return lifecycleRegistry;
    }
}

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

  • 保持 UI 控制器(Activity 和 Fragment)尽可能精简。他们不应该试图获取自己的数据;相反,使用ViewModel执行此操作,并观察LiveData对象以将更改反映回视图。
  • 尝试编写数据驱动的 UI,其中 UI 控制器负责在数据更改时更新视图,或将用户操作通知给ViewModel
  • 将您的数据逻辑放在ViewModel类中。ViewModel应该充当 UI 控制器和应用程序其余部分之间的连接器。但要小心,ViewModel不负责获取数据(例如从网络获取)。相反,ViewModel应调用适当的组件来获取数据,然后将结果返回 UI 控制器。
  • 使用数据绑定来维护视图和 UI 控制器之间的干净界面。这使您可以使视图更具说明性,并最大限度地减少在 Activity 和 Fragment 中编写所需的更新代码。如果您更喜欢用 Java 编程语言执行此操作,请使用像Butter Knife这样的库来避免样板代码并具有更好的抽象。
  • 如果您的 UI 很复杂,请考虑创建一个presenter类来处理 UI 修改。这可能是一项艰巨的任务,但它可以使您的 UI 组件更容易测试。
  • 避免在ViewModel中引用ViewActivity上下文。如果ViewModel超过 Activity(在配置更改的情况下)生存时间,将导致 Activity 内存泄漏,并且垃圾收集器未正确处理。

生命周期感知组件的用例

生命周期感知组件可以使你在各种情况下更轻松地管理生命周期。一些例子是:

  • 在粗粒度和细粒度位置更新之间切换。使用生命周期感知组件可在你的位置应用程序可见时启用细粒度位置更新,并在应用程序位于后台时切换到粗粒度更新。LiveData是一个生命周期感知组件,允许你的应用在用户更改位置时自动更新 UI。
  • 停止并开始视频缓冲。使用生命周期感知组件尽快启动视频缓冲,但推迟播放直到应用程序完全启动。还可以使用生命周期感知组件在销毁应用程序时终止缓冲。
  • 启动和停止网络连接。使用生命周期感知组件在应用程序处于前台时启用网络数据的实时更新(流式传输),并在应用程序进入后台时自动暂停。
  • 暂停和恢复动画 drawables。当 app 在后台时使用生命周期感知组件处理暂停动画 drawables,并在 app 在前台后恢复 drawables。

处理停止事件

当生命周期属于AppCompatActivityFragment时,Lifecycle的状态将更改为CREATED,并且在调用AppCompatActivityFragmentonSaveInstanceState()时调度ON_STOP事件。

当通过onSaveInstanceState()保存FragmentAppCompatActivity的状态时,在调用ON_START之前,它的UI被认为是不可变的。保存状态后尝试修改UI可能会导致应用程序的导航状态不一致,这就是如果应用程序在保存状态后运行FragmentTransaction时,FragmentManager会抛出异常的原因。有关详细信息,请参阅commit()

如果观察者的关联生命周期至少没有开始,LiveData会通过禁止调用其观察者来防止这种边缘情况开箱即用。在幕后,它在决定调用其观察者之前调用isAtLeast()

不幸的是,在onSaveInstanceState()之后调用AppCompatActivity的onStop()方法,这留下了一个间隙,其中不允许UI状态更改但Lifecycle尚未移至CREATED状态。

为防止出现此问题,版本 beta2 及更低版本的Lifecycle类将状态标记为CREATED,而不调度事件,以便检查当前状态的任何代码都获得实际值,即使事件未调度,直到系统调用onStop()

不幸的是,这个解决方案有两个主要问题:

  • 在 API 级别 23 和更低级别,Android 系统实际上保存了 Activity 的状态,即使它被另一个 Activity 部分覆盖。换句话说,Android 系统调用onSaveInstanceState()但它不一定调用onStop()。这会创建一个可能很长的时间间隔,即使无法修改其 UI 状态,观察者仍然认为生命周期处于活动状态。
  • 任何想要向LiveData类公开类似行为的类都必须实现Lifecycle version beta 2 及更低版本提供的解决方法。

私以为,lifecycle 的目的就是解除业务逻辑和 UI 控制器的耦合,使 UI 控制器保持单一职责,这样代码也更容易组织和维护。配合LiveDataViewModel来实现 Clean Architecture,这也是 Android 官方推荐的做法。

推荐阅读更多精彩内容