使用生命周期感知组件处理生命周期   Android Jetpack 的一部分。

生命周期感知组件会响应其他组件(如 Activity 和 Fragment)生命周期状态的变化来执行操作。这些组件有助于您生成组织更良好、通常更轻量且更易于维护的代码。

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

androidx.lifecycle 软件包提供了类和接口,可用于构建“生命周期感知”组件,此类组件能够根据 Activity 或 Fragment 的当前生命周期状态自动调整其行为。

Android Framework 中定义的大多数应用组件都附有生命周期。生命周期由操作系统或在您的进程中运行的框架代码管理。它们是 Android 工作方式的核心,您的应用必须遵守它们。否则可能会导致内存泄漏甚至应用崩溃。

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

Kotlin

internal class MyLocationListener(
        private val context: Context,
        private val callback: (Location) -> Unit
) {

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

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

class MyActivity : AppCompatActivity() {
    private lateinit var myLocationListener: MyLocationListener

    override fun onCreate(...) {
        myLocationListener = MyLocationListener(this) { location ->
            // update UI
        }
    }

    public override fun onStart() {
        super.onStart()
        myLocationListener.start()
        // manage other components that need to respond
        // to the activity lifecycle
    }

    public override fun onStop() {
        super.onStop()
        myLocationListener.stop()
        // manage other components that need to respond
        // to the activity lifecycle
    }
}

Java

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
    }
}

尽管此示例看起来不错,但在实际应用中,您最终会因响应当前的生命周期状态而进行过多的调用来管理界面和其他组件。管理多个组件会导致生命周期方法(例如 onStart()onStop())中存在大量代码,从而难以维护。

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

Kotlin

class MyActivity : AppCompatActivity() {
    private lateinit var myLocationListener: MyLocationListener

    override fun onCreate(...) {
        myLocationListener = MyLocationListener(this) { location ->
            // update UI
        }
    }

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

    public override fun onStop() {
        super.onStop()
        myLocationListener.stop()
    }

}

Java

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();
    }
}

androidx.lifecycle 软件包提供了类和接口,可帮助您以弹性且隔离的方式解决这些问题。

Lifecycle

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

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

Event(事件)
从框架和 Lifecycle 类分发的生命周期事件。这些事件映射到 Activity 和 Fragment 中的回调事件。
State(状态)
Lifecycle 对象跟踪的组件当前状态。
图 1. Android Activity 生命周期中的状态和事件。

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

一个类可以通过实现 DefaultLifecycleObserver 并重写相应的 onCreateonStart 等方法来监控组件的生命周期状态。然后,您可以通过调用 Lifecycle 类的 addObserver() 方法并传入您的观察器实例来添加观察器,如以下示例所示:

Kotlin

class MyObserver : DefaultLifecycleObserver {
    override fun onResume(owner: LifecycleOwner) {
        connect()
    }

    override fun onPause(owner: LifecycleOwner) {
        disconnect()
    }
}

myLifecycleOwner.getLifecycle().addObserver(MyObserver())

Java

public class MyObserver implements DefaultLifecycleObserver {
    @Override
    public void onResume(LifecycleOwner owner) {
        connect()
    }

    @Override
    public void onPause(LifecycleOwner owner) {
        disconnect()
    }
}

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

在上述示例中,myLifecycleOwner 对象实现了 LifecycleOwner 接口,该接口将在下一节中进行解释。

LifecycleOwner

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

此接口将 Lifecycle 的所有权从 FragmentAppCompatActivity 等各个类中抽象出来,并允许编写与它们配合使用的组件。任何自定义应用类都可以实现 LifecycleOwner 接口。

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

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

Kotlin

class MyActivity : AppCompatActivity() {
    private lateinit var myLocationListener: MyLocationListener

    override fun onCreate(...) {
        myLocationListener = MyLocationListener(this, lifecycle) { location ->
            // update UI
        }
        Util.checkUserStatus { result ->
            if (result) {
                myLocationListener.enable()
            }
        }
    }
}

Java

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();
            }
        });
  }
}

一个常见的用例是,如果 Lifecycle 当前状态不佳,则避免调用某些回调。例如,如果回调在 Activity 状态保存后运行 Fragment 事务,则会触发崩溃,因此我们绝不希望调用该回调。

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

Kotlin

internal class MyLocationListener(
        private val context: Context,
        private val lifecycle: Lifecycle,
        private val callback: (Location) -> Unit
): DefaultLifecycleObserver {

    private var enabled = false

    override fun onStart(owner: LifecycleOwner) {
        if (enabled) {
            // connect
        }
    }

    fun enable() {
        enabled = true
        if (lifecycle.currentState.isAtLeast(Lifecycle.State.STARTED)) {
            // connect if not connected
        }
    }

    override fun onStop(owner: LifecycleOwner) {
        // disconnect if connected
    }
}

Java

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

    @Override
    public void onStart(LifecycleOwner owner) {
        if (enabled) {
           // connect
        }
    }

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

    @Override
    public void onStop(LifecycleOwner owner) {
        // disconnect if connected
    }
}

通过此实现,我们的 LocationListener 类完全具有生命周期感知能力。如果我们需要从另一个 Activity 或 Fragment 中使用 LocationListener,只需对其进行初始化即可。所有的设置和拆卸操作都由类本身管理。

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

实现自定义 LifecycleOwner

Support Library 26.1.0 及更高版本中的 Fragment 和 Activity 都已实现 LifecycleOwner 接口。

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

Kotlin

class MyActivity : Activity(), LifecycleOwner {

    private lateinit var lifecycleRegistry: LifecycleRegistry

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

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

    public override fun onStart() {
        super.onStart()
        lifecycleRegistry.markState(Lifecycle.State.STARTED)
    }

    override fun getLifecycle(): Lifecycle {
        return lifecycleRegistry
    }
}

Java

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;
    }
}

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

  • 让您的界面控制器(Activity 和 Fragment)尽可能地精简。它们不应尝试获取自己的数据;而是应该使用 ViewModel 来执行此操作,并观察 LiveData 对象以将更改反映回视图。
  • 尝试编写数据驱动的界面,其中界面控制器的职责是根据数据变化更新视图,或将用户操作通知回 ViewModel
  • 将您的数据逻辑放入 ViewModel 类中。ViewModel 应充当您的界面控制器与应用其余部分之间的连接器。但请注意,ViewModel 的职责不是获取数据(例如,从网络获取)。相反,ViewModel 应该调用适当的组件来获取数据,然后将结果提供回界面控制器。
  • 使用 数据绑定 在视图和界面控制器之间保持清晰的接口。这使您可以使视图更具声明性,并最大限度地减少需要在 Activity 和 Fragment 中编写的更新代码。如果您更喜欢在 Java 编程语言中执行此操作,请使用 Butter Knife 等库,以避免样板代码并获得更好的抽象。
  • 如果您的界面很复杂,请考虑创建 Presenter 类来处理界面修改。这可能是一项费力的任务,但可以使您的界面组件更易于测试。
  • 避免在您的 ViewModel 中引用 ViewActivity 上下文。如果 ViewModel 的生命周期长于 Activity(在配置更改的情况下),您的 Activity 会泄漏,并且不会被垃圾回收器正确处置。
  • 使用 Kotlin 协程管理长时间运行的任务和其他可以异步运行的操作。

生命周期感知组件的用例

生命周期感知组件可以使您在各种情况下更容易地管理生命周期。以下是一些示例:

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

处理 onStop 事件

Lifecycle 属于 AppCompatActivityFragment 时,在调用 AppCompatActivityFragmentonSaveInstanceState() 时,Lifecycle 的状态会变为 CREATED,并且会分发 ON_STOP 事件。

FragmentAppCompatActivity 的状态通过 onSaveInstanceState() 保存后,其界面被视为不可变,直到调用 ON_START。在状态保存后尝试修改界面可能会导致应用导航状态不一致,这就是为什么如果应用在状态保存后运行 FragmentTransactionFragmentManager 会抛出异常。有关详细信息,请参阅 commit()

LiveData 会默认避免调用其观察器,如果观察器关联的 Lifecycle 状态不至少为 STARTED,从而防止此极端情况。在幕后,它会在决定调用其观察器之前调用 isAtLeast()

遗憾的是,AppCompatActivityonStop() 方法是在 onSaveInstanceState() 之后调用的,这留下了一个空白期,在此期间不允许更改界面状态,但 Lifecycle 尚未移动到 CREATED 状态。

为了防止此问题,Lifecycle 类在 beta2 及更低版本中会将状态标记为 CREATED,而不会分发事件,这样任何检查当前状态的代码都可以获得实际值,即使事件直到系统调用 onStop() 后才分发。

遗憾的是,此解决方案存在两个主要问题:

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

其他资源

要详细了解如何使用生命周期感知组件处理生命周期,请查阅以下其他资源。

示例

  • Sunflower,一个演示架构组件最佳实践的示例应用

Codelab

博客