android ViewModel 是如何存储/恢复数据的

QA

  • 配置变更时 ViewModel、onSaveIntanceState 对于数据的保存和恢复有什么区别?
  • onSaveInstanceState和ViewModel在数据缓存方面的区别?
  • ViewModel 是如何在配置变化重建恢复数据的?
  • SaveStateHandle 的作用?

ViewModel 创建

获取实例时通过下面这个方法:

kotlin 复制代码
ViewModelProvider(this).get(MyViewModel::class.java)

public ViewModelProvider(ViewModelStoreOwner owner, Factory factory) {
    // activity/fragment 是直接创建 ViewModelStore 或者 恢复时系统赋值的
    this(owner.getViewModelStore(), factory);
}

public <T extends ViewModel> T get(String key, Class<T> modelClass) {
    //ViewModelStore 内部维护了一个用于储存VM的HashMap。
    ViewModel viewModel = mViewModelStore.get(key);

    if (modelClass.isInstance(viewModel)) {
        if (mFactory instanceof OnRequeryFactory) {
            ((OnRequeryFactory) mFactory).onRequery(viewModel);
        }
        // 缓存里有直接结束
        return (T) viewModel;
    } else {
    }
    if (mFactory instanceof KeyedFactory) {
        //如果无缓存直接通过 factory 创建
        viewModel = ((KeyedFactory) (mFactory)).create(key, modelClass);
    } else {
        viewModel = (mFactory).create(modelClass);
    }
    //然后放到 缓存里
    mViewModelStore.put(key, viewModel);
    return (T) viewModel;
}

// 默认的 factory 创建实例。
private fun <T : ViewModel> create(modelClass: Class<T>, app: Application): T {
    return if (AndroidViewModel::class.java.isAssignableFrom(modelClass)) {
        try {
            modelClass.getConstructor(Application::class.java).newInstance(app)
        } catch (e: NoSuchMethodException) {
            RuntimeException("Cannot create an instance of $modelClass", e)
        }
    } else super.create(modelClass)
}
  • ViewModelStoreOwner: 接口,AppCompatActivity/Fragment实现了该接口。
  • vm 的实例是 ViewModelStore 中拿的,ViewModelStor 内部维护了一个用于储存VM的HashMap。
  • ViewModelStore 是被 activity/fragment 持有的,每个 Activity(Fragment) 都会拥有一个 ViewModelStore 实例。

所以关键问题是看 ViewModelStore 创建路径。

ViewModel 的恢复

ComponentActivity getViewModelStore:

ini 复制代码
public ViewModelStore getViewModelStore() {
    if (mViewModelStore == null) {
        NonConfigurationInstances nc = (NonConfigurationInstances) getLastNonConfigurationInstance();
        if (nc != null) {
            // Restore the ViewModelStore from NonConfigurationInstances
            mViewModelStore = nc.viewModelStore;
        }
        if (mViewModelStore == null) {
            mViewModelStore = new ViewModelStore();
        }
    }
    return mViewModelStore;
}
  • 如果有的话直接从NonConfigurationInstances获取。
  • 否则,创建一个新的ViewModelStore对象。

NonConfigurationInstances是什么东西?NonConfigurationInstances 用来缓存不受配置更改影响的数据,

同时,我们还可以在ComponentActivity里面看到一段代码:

less 复制代码
getLifecycle().addObserver(new LifecycleEventObserver() {
    @Override
    public void onStateChanged(@NonNull LifecycleOwner source,
                               @NonNull Lifecycle.Event event) {
        if (event == Lifecycle.Event.ON_DESTROY) {
            if (!isChangingConfigurations()) { // 非配置变化造成的销毁
                getViewModelStore().clear();
            }
        }
    }
});

如果Activity是因为配置更改导致onDestroy方法的回调,并不会清空ViewModelStore里面的内容, 即 ViewModel 的缓存。

NonConfigurationInstances 的赋值是在 Activity 的 attach 方法,系统将上次的 NonConfigurationInstances赋值给了新的Activity对象。

ViewModel 的保存

NonConfigurationInstances为啥能保证Activity重建前后,ViewModeStore是同一个对象呢?

performDestroyActivity方法最后会回调到Activity的onDestroy方法,我们可以通过这个方法可以找到ActivtyThread在Activity onDestroy之前做了保存操作。

ini 复制代码
 public final Object onRetainNonConfigurationInstance() {
     //配置变化时缓存viewModelStore 到 NonConfigurationInstances
    ViewModelStore viewModelStore = mViewModelStore;
    if (viewModelStore == null) {
        // No one called getViewModelStore(), so see if there was an existing
        // ViewModelStore from our last NonConfigurationInstance
        NonConfigurationInstances nc =
                (NonConfigurationInstances) getLastNonConfigurationInstance();
        if (nc != null) {
            viewModelStore = nc.viewModelStore;
        }
    }

    NonConfigurationInstances nci = new NonConfigurationInstances();
    nci.custom = custom;
    nci.viewModelStore = viewModelStore;
    return nci;
}

ActivityClientRecord performDestroyActivity(IBinder token, boolean finishing, int configChanges, boolean getNonConfigInstance, String reason) {
    if (getNonConfigInstance) {
        // ······
        // retainNonConfigurationInstances方法的作用就是创建一个对象
        r.lastNonConfigurationInstances= r.activity.retainNonConfigurationInstances();
        // ······
    }
    // Activity的onDestroy方法回调
    mInstrumentation.callActivityOnDestroy(r.activity);
    return r;
}

配置变化时会回调onRetainNonConfigurationInstance方法,将mViewModelStore保存在NonConfigurationInstances,同时performDestroyActivity时将NonConfigurationInstances记录到ActivityClientRecord中去。

小结:VM -> ViewModelStore->NonConfigurationInstances -> ActivityThread 中的 ActivityClientRecord。中间通过 activity 来处理保存、恢复。

onSaveInstanceState和ViewModel

两者在数据处理方面的不同:

  • ViewModel最终是交给 ActivityThread 中的 ActivityClientRecord 暂存的,进程被回收ViewModel 也就被回收。
  • ViewModel能恢复因配置变更导致重建的数据,并不能恢复因资源限制(比如内存限制,电量限制等)进程杀死导致的数据恢复。
  • onSaveInstanceState 可以保存因系统限制进程被杀或者配置变化的数据,这些数据存储在内存中,而不是硬盘上,由android 系统来管理。
  • ViewModel支持保存大量和复杂的数据,比如说RecyclerView的data(ActivityThread持有)。

SavedStateHandle

ViewModel 通过SavedStateHandle类处理数据与onSaveInstanceState()的方式没有任何区别

kotlin 复制代码
class MyViewModel(private val saveStateHandle: SavedStateHandle) : ViewModel() {
    val info = saveStateHandle.get<String>("KEY_INFO") // 取值
    val infoFlow = saveStateHandle.getStateFlow("KEY_INFO", "") // 以 flow 形式

    fun setInfo(info: String) { // 设置值
        saveStateHandle.set("KEY_INFO", info)
    }
}

//通过AbstractSavedStateViewModelFactory或者SavedStateViewModelFactory创建ViewModel对象:
private val viewModel by lazy {
    ViewModelProvider(
        this, SavedStateViewModelFactory(application, this)
    )[MyViewModel::class.java]
}

比如在Fragment中是如何save的?

scss 复制代码
// 触发销毁时
void performSaveInstanceState(Bundle outState) {
    ......
    onSaveInstanceState(outState);
    mSavedStateRegistryController.performSave(outState);
    ......
}

//也是保存到bundle里
void performSave(@NonNull Bundle outBundle) {
    Bundle components = new Bundle();
    if (mRestoredState != null) {
        components.putAll(mRestoredState);
    }
    for (Iterator<Map.Entry<String, SavedStateProvider>> it =
            mComponents.iteratorWithAdditions(); it.hasNext(); ) {
        Map.Entry<String, SavedStateProvider> entry1 = it.next();
        components.putBundle(entry1.getKey(), entry1.getValue().saveState());
    }
    outBundle.putBundle(SAVED_COMPONENTS_KEY, components);
}
相关推荐
aqi0011 分钟前
FFmpeg开发笔记(九十七)国产的开源视频剪辑工具AndroidVideoEditor
android·ffmpeg·音视频·直播·流媒体
stevenzqzq19 分钟前
Android Koin 注入入门教程
android·kotlin
炼金术1 小时前
SkyPlayer v1.1.0 - 在线视频播放功能更新
android·ffmpeg
用户276038157811 小时前
鲲鹏+昇腾:开启 AI for Science 新范式——基于PINN的流体仿真加速实践
android
此去正年少1 小时前
编写adb脚本工具对Android设备上的闪退问题进行监控分析
android·adb·logcat·ndk·日志监控
落羽凉笙2 小时前
Python基础(4)| 玩转循环结构:for、while与嵌套循环全解析(附源码)
android·开发语言·python
十幺卜入2 小时前
Unity3d C# 基于安卓真机调试日志抓取拓展包(Android Logcat)
android·c#·unity 安卓调试·unity 安卓模拟·unity排查问题
frontend_frank2 小时前
脱离 Electron autoUpdater:uni-app跨端更新:Windows+Android统一实现方案
android·前端·javascript·electron·uni-app
薛晓刚3 小时前
MySQL的replace使用分析
android·adb
DengDongQi3 小时前
Jetpack Compose 滚轮选择器
android