Android架构组件官方文档02——LiveData

LiveData概述

LiveData是一个可观察的数据持有者类。
与常规可观察性不同，LiveData具有生命周期感知能力，这意味着它尊重其他应用程序组件（例如活动，片段或服务）的生命周期。
这种感知确保LiveData只更新处于活动生命周期状态的应用程序组件观察者。
注意：要将LiveData组件导入到Android项目中，请参阅向项目添加组件。
如果观察者的生命周期处于STARTED或RESUMED状态，则LiveData会将Observer类表示的观察者视为活动状态。
LiveData仅通知处于活跃状态的观察者更新。
未注册观看LiveData对象的非活跃期的观察者不会收到有关更改的通知。

您可以注册与实现LifecycleOwner接口的对象配对的观察者。此关系允许在相应生命周期对象的状态更改为DESTROYED时删除观察者。
这对于活动和片段尤其有用，因为它们可以安全地观察LiveData对象，而不必担心泄漏 - 在其生命周期被破坏时，活动和片段会立即取消订阅。

有关如何使用LiveData的更多信息，请参阅使用LiveData对象

使用LiveData的优点

使用LiveData提供以下优点：
确保您的UI界面符合您UI数据状态

LiveData遵循观察者模式。
当生命周期状态改变时，LiveData会通知Observer对象。
您可以合并代码以更新这些Observer对象中的UI。
每次应用程序数据更改时，您的观察者都可以在每次更改时更新UI，而不是每次更新UI。
没有内存泄漏
观察者绑定到Lifecycle对象，并在其相关生命周期被破坏后自行清理。

不会因为活动停止而崩溃

如果观察者的生命周期处于非活动状态，例如在后退堆栈中的活动，则它不会收到任何LiveData事件。

没有更多的手动声明周期处理
UI组件只是观察相关数据，不停止或恢复观察。
LiveData自动管理所有这些，因为它在观察时意识到相关的生命周期状态更改。
始终保持最新的数据
如果生命周期变为非活动状态，它将在再次变为活动状态时收到最新数据。例如，后台活动在返回到前台后立即收到最新数据。
正确的配置更改
如果由于配置更改（如设备旋转）而重新创建活动或片段，它会立即收到最新的可用数据。
共享资源
您可以使用单例模式扩展LiveData对象以包装系统服务，以便它们可以在应用程序中共享。
LiveData对象连接到系统服务一次，然后任何需要该资源的观察者都可以观看LiveData对象。
有关更多信息，请参阅扩展LiveData。

使用LiveData对象

按照以下步骤操作LiveData对象：

1. 创建一个LiveData实例来保存某种类型的数据。这通常在您的ViewModel类中完成。
2. 创建一个Observer对象，该对象定义onChanged()方法，该方法控制LiveData对象保存的数据更改时发生的情况。您通常在UI控制器中创建Observer对象，如活动或片段。
3. 使用observe()方法将Observer对象附加到LiveData对象。observe()方法使用LifecycleOwner对象。这将Observer对象订阅到LiveData对象，以便通知其更改。您通常将Observer对象附加到UI控制器中，例如Activity或Fragment。

注意：您可以使用observeForever（Observer）方法注册一个没有关联的LifecycleOwner对象的观察器。在这种情况下，观察者被认为始终处于活动状态，因此总是通知修改。您可以删除这些观察者调用removeObserver（Observer）方法。

当您更新存储在LiveData对象中的值时，只要附加的LifecycleOwner处于活动状态，它就会触发所有已注册的观察者。
LiveData允许UI控制器观察者订阅更新。当LiveData对象持有的数据更改时，UI会自动更新以作为响应。

创建LiveData对象

LiveData是一个可用于任何数据的包装器，包括实现集合的对象（如List）。LiveData对象通常存储在ViewModel对象中，并通过getter方法访问，如以下示例所示：

public class NameViewModel extends ViewModel {

// Create a LiveData with a String
private MutableLiveData<String> mCurrentName;

    public MutableLiveData<String> getCurrentName() {
        if (mCurrentName == null) {
            mCurrentName = new MutableLiveData<String>();
        }
        return mCurrentName;
    }

// Rest of the ViewModel...
}

最初，LiveData对象中的数据未设置。

注意：由于以下原因，请确保存储更新ViewModel对象中的UI的LiveData对象，而不是活动或片段：

• 避免臃肿的活动和碎片。现在这些UI控制器负责显示数据但不保存数据状态。
• 将LiveData实例与特定活动或片段实例分离，并允许LiveData对象保留配置更改。

您可以在ViewModel指南中了解更多关于ViewModel类的好处和用法。

观察LiveData对象

在大多数情况下，出于以下原因，应用程序组件的onCreate()方法是开始观察LiveData对象的正确位置：

1. 确保系统不会从Activity或fragment的onResume（）方法进行多余的调用。
2. 确保Activity或Fragment具有一旦它变为活动状态即可显示的数据。只要应用程序组件处于STARTED状态，它就会从它所观察的LiveData对象中接收最新的值。这只会在设置要观察的LiveData对象时才会发生。

通常，LiveData仅在数据更改时传递更新，并且仅传递给活动观察者。此行为的一个例外是，观察者在从非活动状态变为活动状态时也会收到更新。此外，如果观察者第二次从非激活状态变为激活状态，则只有在自上一次变为活动状态以来该值发生变化时才会收到更新。

以下示例代码说明了如何开始观察LiveData对象：

public class NameActivity extends AppCompatActivity {

    private NameViewModel mModel;

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

        // Other code to setup the activity...

        // Get the ViewModel.
        mModel = ViewModelProviders.of(this).get(NameViewModel.class);


        // Create the observer which updates the UI.
        final Observer<String> nameObserver = new Observer<String>() {
            @Override
            public void onChanged(@Nullable final String newName) {
                // Update the UI, in this case, a TextView.
                mNameTextView.setText(newName);
            }
        };

        // Observe the LiveData, passing in this activity as the LifecycleOwner and the observer.
        mModel.getCurrentName().observe(this, nameObserver);
    }
}

使用nameObserver作为参数传递observe()后，立即调用onChanged()，以提供存储在mCurrentName中的最新值。如果LiveData对象未在mCurrentName中设置值，则不调用onChanged()。

更新LiveData对象

LiveData没有公开可用的方法来更新存储的数据。MutableLiveData类公开公开setValue(T)和postValue(T)方法，如果需要编辑存储在LiveData对象中的值，则必须使用这些方法。通常在ViewModel中使用MutableLiveData，然后ViewModel只向观察者公开不可变的LiveData对象。
在建立观察者关系后，可以更新LiveData对象的值，如以下示例所示，当用户点击按钮时触发所有观察者：

mButton.setOnClickListener(new OnClickListener() {
    @Override
    public void onClick(View v) {
        String anotherName = "John Doe";
        mModel.getCurrentName().setValue(anotherName);
    }
});

在示例中调用setValue（T）会导致观察者用值John Doe调用它们的onChanged（）方法。该示例显示按钮按下，但setValue（）或postValue（）可能因多种原因被调用来更新mName，包括响应网络请求或数据库加载完成;在所有情况下，调用setValue（）或postValue（）都会触发观察者并更新UI。

注意：您必须调用setValue（T）方法来更新主线程中的LiveData对象。如果代码在工作线程中执行，则可以使用postValue（T）方法更新LiveData对象。

与Room一起使用LiveData

Room持久性库支持返回LiveData对象的可观察查询。可观察查询是作为数据库访问对象（DAO）的一部分写入的。

当更新数据库时，会生成所有必要的代码以更新LiveData对象。生成的代码在需要时在后台线程上异步运行查询。这种模式对于保持UI中显示的数据与存储在数据库中的数据保持同步很有用。您可以在Room持久库指南中阅读关于Room和DAO的更多信息。

扩展LiveData

如果观察者的生命周期处于STARTED或RESUMED状态，则LiveData将认为观察者处于活动状态。以下示例代码说明了如何扩展LiveData类：

public class StockLiveData extends LiveData<BigDecimal> {
    private StockManager mStockManager;

    private SimplePriceListener mListener = new SimplePriceListener() {
        @Override
        public void onPriceChanged(BigDecimal price) {
            setValue(price);
        }
    };

    public StockLiveData(String symbol) {
        mStockManager = new StockManager(symbol);
    }

    @Override
    protected void onActive() {
        mStockManager.requestPriceUpdates(mListener);
    }

    @Override
    protected void onInactive() {
        mStockManager.removeUpdates(mListener);
    }
}

本示例中的价格监听器的实现包括以下重要方法：

• 当LiveData对象具有处于活跃期的观察者时，将调用onActive（）方法。这意味着您需要开始观察此方法的价格更新。
• 当LiveData对象没有任何active期间的观察者时，将调用onInactive（）方法。由于没有观察员在监听，因此没有理由保持连接到StockManager服务。
• setValue（T）方法更新LiveData实例的值并通知任何活跃的观察者有关更改。

您可以使用StockLiveData类如下所示：

public class MyFragment extends Fragment {
    @Override
    public void onActivityCreated(Bundle savedInstanceState) {
        super.onActivityCreated(savedInstanceState);
        LiveData<BigDecimal> myPriceListener = ...;
        myPriceListener.observe(this, price -> {
            // Update the UI.
        });
    }
}

observe（）方法将把实现了LifecycleOwner实例的Fragment作为第一个参数传递。这样做表示此观察者被绑定到与所有者关联的生命周期对象，这意味着：

• 如果生命周期对象不处于活跃状态，则即使值发生更改，也不会调用观察者。
• 生命周期对象被销毁后，观察者被自动删除。t

LiveData对象支持生命周期意味着您可以在多个Activity，Fragment和Service之间共享它们。为了保持示例简单，您可以按如下方式将LiveData类实现为单例：

public class StockLiveData extends LiveData<BigDecimal> {
    private static StockLiveData sInstance;
    private StockManager mStockManager;

    private SimplePriceListener mListener = new SimplePriceListener() {
        @Override
        public void onPriceChanged(BigDecimal price) {
            setValue(price);
        }
    };

    @MainThread
    public static StockLiveData get(String symbol) {
        if (sInstance == null) {
            sInstance = new StockLiveData(symbol);
        }
        return sInstance;
    }

    private StockLiveData(String symbol) {
        mStockManager = new StockManager(symbol);
    }

    @Override
    protected void onActive() {
        mStockManager.requestPriceUpdates(mListener);
    }

    @Override
    protected void onInactive() {
        mStockManager.removeUpdates(mListener);
    }
}

您可以再Fragment中使用它，如下所示：

public class MyFragment extends Fragment {
    @Override
    public void onActivityCreated(Bundle savedInstanceState) {
        StockLiveData.get(getActivity()).observe(this, price -> {
            // Update the UI.
        });
    }
}

多个Fragment和Activity可以观察MyPriceListener实例。如果LiveData只有一个或多个可见并处于活动状态，则LiveData仅连接到系统服务。

转换LiveData

您可能希望在LiveData更改为观察者之前更改存储在LiveData对象中的，或者您可能需要基于另一个LiveData实例的值返回不同的LiveData实例。Lifecycle软件包提供Transformations类，其中包括支持这些场景的帮助方法。
Transformations.map()
在存储在LiveData对象中的值上使用函数，并向下游传播结果。

LiveData<User> userLiveData = ...;
LiveData<String> userName = Transformations.map(userLiveData, user -> {
    user.name + " " + user.lastName
});

Transformations.switchMap()

与map（）类似，将函数应用于存储在LiveData对象中的值，并展开并向下游分派结果。传递给switchMap（）的函数必须返回一个LiveData对象，如下例所示：

private LiveData<User> getUser(String id) {
  ...;
}

LiveData<String> userId = ...;
LiveData<User> user = Transformations.switchMap(userId, id -> getUser(id) );

您可以使用转换方法在观察者的生命周期中传递信息。除非观察者正在观察返回的LiveData对象，否则不会计算转换。由于转换是懒加载的，因此与生命周期相关的行为会隐式传递，而不需要额外的显式调用或依赖关系。

如果您认为您需要ViewModel对象中的Lifecycle对象，则转换可能是更好的解决方案。例如，假设您有一个接受地址并返回该地址的邮政编码的UI组件。您可以为此组件实现native的ViewModel，如以下示例代码所示：

class MyViewModel extends ViewModel {
    private final PostalCodeRepository repository;
    public MyViewModel(PostalCodeRepository repository) {
       this.repository = repository;
    }

    private LiveData<String> getPostalCode(String address) {
       // DON'T DO THIS
       return repository.getPostCode(address);
    }
}

在这种情况下，postalCode是public的和fina的，因为该字段永远不会改变。postalCode字段定义为addressInput的转换，这意味着addressInput发生更改时将调用repository.getPostCode（）方法。如果存在活动观察者，那么这是真实的，如果在repository.getPostCode（）被调用时没有活跃的观察者，则在添加观察者之前不进行计算。

该机制允许版本较低的应用程序创建按需延迟计算的LiveData对象。ViewModel对象可以轻松获得对LiveData对象的引用，然后在其上定义转换规则。

创建新的转换

有十几种不同的特定转换可能在您的应用中很有用，但它们不是默认提供的。要实现自己的转换，您可以使用MediatorLiveData类，它监听其他LiveData对象并处理它们发出的事件。MediatorLiveData将其状态正确传播到源LiveData对象。要了解有关此模式的更多信息，请参阅Transformations类的参考文档。

合并多个LiveData源

MediatorLiveData是LiveData的一个子类，允许您合并多个LiveData源。MediatorLiveData对象的观察者随后会在任何原始LiveData源对象更改时触发。

例如，如果您的UI中有一个可从本地数据库或网络更新的LiveData对象，则可以将以下资源添加到MediatorLiveData对象：

• 与存储在数据库中的数据关联的LiveData对象。
• 与从网络访问的数据关联的LiveData对象。

您的活动只需观察MediatorLiveData对象即可从两个来源接收更新。有关详细示例，请参阅应用程序体系结构指南的附录：展示网络状态部分。

其他资源

有关在Snackbar消息，导航事件和其他事件中使用LiveData的其他信息，请阅读此文章。