深入理解与运用Android Jetpack ViewModel

Rouse

发布于 2023-08-31 14:21:29

3300

发布于 2023-08-31 14:21:29

在Android开发中，数据与界面的分离一直是一项重要的挑战。为了解决这个问题，Google推出了Android Jetpack组件之一的ViewModel。ViewModel是一种用于管理UI相关数据的架构组件，它能够帮助开发者实现优雅的数据驱动和生命周期管理。本文将深入浅出地介绍ViewModel的使用和原理，带你一步步掌握这个强大的组件。

什么是ViewModel

ViewModel是Android Jetpack组件之一，它的主要目的是将UI控制器（如Activity和Fragment）与数据相关的业务逻辑分开，使得UI控制器能够专注于展示数据和响应用户交互，而数据的获取和处理则交由ViewModel来管理。这种分离能够使代码更加清晰、易于测试和维护。

ViewModel的原理

ViewModel的原理其实并不复杂。在设备配置发生变化（如屏幕旋转）导致Activity或Fragment重建时，ViewModel不会被销毁，而是保留在内存中。这样，UI控制器可以在重建后重新获取之前的ViewModel实例，并继续使用其中的数据，从而避免数据丢失和重复加载。

ViewModelStore和ViewModelStoreOwner

ViewModel的原理涉及两个核心概念：ViewModelStore和ViewModelStoreOwner。

ViewModelStore是一个存储ViewModel实例的容器，它的生命周期与UI控制器的生命周期关联。在UI控制器（Activity或Fragment）被销毁时，ViewModelStore会清理其中的ViewModel实例，避免内存泄漏。

ViewModelStoreOwner是拥有ViewModelStore的对象，通常是Activity或Fragment。ViewModelProvider通过ViewModelStoreOwner来获取ViewModelStore，并通过ViewModelStore来管理ViewModel的生命周期。

ViewModelProvider

ViewModelProvider是用于创建和获取ViewModel实例的工具类。它负责将ViewModel与ViewModelStoreOwner关联，并确保ViewModel在合适的时机被销毁。

在Activity中获取ViewModel实例：

viewModel = new ViewModelProvider(this).get(MyViewModel.class);

在Fragment中获取ViewModel实例：

viewModel = new ViewModelProvider(this).get(MyViewModel.class);

使用ViewModel

添加ViewModel依赖

首先，确保你的项目已经使用了AndroidX，并在build.gradle中添加ViewModel依赖：

dependencies {
    implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.1"
}

创建ViewModel

创建ViewModel非常简单，只需继承ViewModel类并在其中定义数据和相关操作。

public class MyViewModel extends ViewModel {
    private MutableLiveData<String> data = new MutableLiveData<>();

    public LiveData<String> getData() {
        return data;
    }

    public void fetchData() {
        // 模拟异步数据获取
        new Handler().postDelayed(() -> {
            data.setValue("Hello, ViewModel!");
        }, 2000);
    }
}

在UI控制器中使用ViewModel

在Activity或Fragment中获取ViewModel的实例，并观察数据变化：

viewModel = new ViewModelProvider(this).get(MyViewModel.class);
viewModel.getData().observe(this, data -> {
    // 更新UI
    textView.setText(data);
});

viewModel.fetchData(); // 触发数据获取操作

ViewModel与跨组件通信

ViewModel不仅仅用于在单个UI控制器内部共享数据，它还可以用于在不同UI控制器之间共享数据，实现跨组件通信。例如，一个Fragment中的数据可以通过ViewModel传递给Activity。

在Activity中共享数据：

sharedViewModel = new ViewModelProvider(this).get(SharedViewModel.class);
sharedViewModel.getData().observe(this, data -> {
    // 更新UI
    textView.setText(data);
});

在Fragment中共享数据：

sharedViewModel = new ViewModelProvider(requireActivity()).get(SharedViewModel.class);

注意：在跨组件通信时，需要使用同一个ViewModelProvider获取相同类型的ViewModel实例。在Activity中，使用this作为ViewModelProvider的参数，在Fragment中，使用requireActivity()作为参数。

ViewModel与SavedState

有时，我们可能希望在ViewModel中保存一些与UI控制器生命周期无关的数据，以便在重建时恢复状态。ViewModel提供了SavedState功能，它可以让我们在ViewModel中持久化保存数据。

示例代码：

public class MyViewModel extends ViewModel {
    private SavedStateHandle savedStateHandle;

    public MyViewModel(SavedStateHandle savedStateHandle) {
        this.savedStateHandle = savedStateHandle;
    }

    public LiveData<String> getData() {
        return savedStateHandle.getLiveData("data");
    }

    public void setData(String data) {
        savedStateHandle.set("data", data);
    }
}

使用SavedStateViewModelFactory创建带有SavedState功能的ViewModel：

public class MyActivity extends AppCompatActivity {
    private MyViewModel viewModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        ViewModelProvider.Factory factory = new SavedStateViewModelFactory(getApplication(), this);
        viewModel = new ViewModelProvider(this, factory).get(MyViewModel.class);

        viewModel.getData().observe(this, data -> {
            // 更新UI
            textView.setText(data);
        });

        if (savedInstanceState == null) {
            // 第一次创建时，触发数据获取操作
            viewModel.fetchData();
        }
    }
}