Android ViewModel的作用深入讲解

ViewModel它的作用是什么呢

ViewModel 类旨在以注重生命周期的方式存储和管理界面相关数据。ViewModel 类让数据可在发生屏幕旋转等配置更改后继续留存(官方解释)

看到这里我们就可以总结viewmodel的两个作用点，第一viewmodel在activity和fragment销毁时自己也会被清除掉，第二点viewmodel在屏幕旋转activity销毁后重建可以显示之前数据。

那么问题就来了viewmodel是怎么保存数据的以及自动释放掉内存？ 这两个问题弄懂了viewmodel的面纱也就被我们揭开了。

那我们就直接从最简单的使用viewmodel开始说起

class UserViewModel : ViewModel() {
    var age: Int = 0
}
class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val userViewModel =
            ViewModelProvider(this, ViewModelProvider.NewInstanceFactory())[UserViewModel::class.java]
        val mView = ActivityMainBinding.inflate(layoutInflater)
        setContentView(mView.root)
        mView.tv.text = userViewModel.age.toString()
        var sum = 0
        mView.tv.setOnClickListener {
            sum = sum.inc()
            userViewModel.age = sum
        }
    }
}

随着我们不停的点击 sum会越来越大 当我们旋转屏幕的时候 activity会重建  但是我们获取的age却是最后一次点击的值，这就证明了我们数据是被保存了下来。那么viewmodel是怎么做到的呢？我们从源码角度去分析

以下源码分析是从Android13分析的

看源码viewmodel是一个抽象类，并不能看出什么。那么我们就得换一个思路去思考了。既然viewmodel是和activity有关系，而且在activity旋转销毁时还能做到复用，那么我们就从activity中去寻找。

一级一级寻找发现在ComponentActivity实现了一个ViewModelStoreOwner接口 看命名是和viewmodel有点关系看下这个接口内部有什么

public interface ViewModelStoreOwner {
    /**
     * Returns owned {@link ViewModelStore}
     *
     * @return a {@code ViewModelStore}
     */
    @NonNull
    ViewModelStore getViewModelStore();
}
//代码很简洁 一个抽象方法 返回值ViewModelStore 顾名思义这个类的功能也就呼之欲出，存储viewmodel，那我们就看实现类中怎么处理的
//ComponentActivity中实现 
  @NonNull
    @Override
    public ViewModelStore getViewModelStore() {
        if (getApplication() == null) {
            throw new IllegalStateException("Your activity is not yet attached to the "
                    + "Application instance. You can't request ViewModel before onCreate call.");
        }
        ensureViewModelStore();
        return mViewModelStore;
    }
//我们直接看ensureViewModelStore()方法
void ensureViewModelStore() {
        if (mViewModelStore == null) {
            NonConfigurationInstances nc =
                    (NonConfigurationInstances) getLastNonConfigurationInstance();
            if (nc != null) {
                // Restore the ViewModelStore from NonConfigurationInstances
                mViewModelStore = nc.viewModelStore;
            }
            if (mViewModelStore == null) {
                mViewModelStore = new ViewModelStore();
            }
        }
    }
 //ensureViewModelStore方法看来是为了获取ViewModelStore，那我们在具体看下ViewModelStore内部做了什么?
public class ViewModelStore {
    private final HashMap<String, ViewModel> mMap = new HashMap<>();
    final void put(String key, ViewModel viewModel) {
        ViewModel oldViewModel = mMap.put(key, viewModel);
        if (oldViewModel != null) {
            oldViewModel.onCleared();
        }
    }
    final ViewModel get(String key) {
        return mMap.get(key);
    }
    Set<String> keys() {
        return new HashSet<>(mMap.keySet());
    }
    /**
     *  Clears internal storage and notifies ViewModels that they are no longer used.
     */
    public final void clear() {
        for (ViewModel vm : mMap.values()) {
            vm.clear();
        }
        mMap.clear();
    }
}
//看到这里就明了了，果然和我们猜想的一样，ViewModelStore是用来缓存ViewModel的

经过我们分析已经明白了viewmodel是被ViewModelStore缓存起来的，那么又是如何做到在activity不正常销毁时去恢复数据的呢？

在ComponentActivity在发现还有另一个方法中使用了ViewModelStore

onRetainNonConfigurationInstance方法

public final Object onRetainNonConfigurationInstance() {
        // Maintain backward compatibility.
        Object custom = onRetainCustomNonConfigurationInstance();
        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;
            }
        }
        if (viewModelStore == null && custom == null) {
            return null;
        }
        NonConfigurationInstances nci = new NonConfigurationInstances();
        nci.custom = custom;
        nci.viewModelStore = viewModelStore;
        return nci;
    }

方法体内的代码也很容易理解 如果viewModelStore为null 就去给它赋值。那么这个方法是在什么时候执行的呢？经过一番debug发现在activity切换横竖屏的时候 这个方法就被触发了 而getViewModelStore方法在activity创建的时候就执行了。我们现在知道了viewModelStore的创建时机,那么viewmodel是如何存储到viewModelStore中的呢？

还记得我们写的示例代码吗？

  val userViewModel =
            ViewModelProvider(this, ViewModelProvider.NewInstanceFactory())
                .get(UserViewModel::class.java)

我们就从ViewModelProvider入手

 public constructor(owner: ViewModelStoreOwner, factory: Factory) : this(
        owner.viewModelStore,
        factory,
        defaultCreationExtras(owner)
    )

第一个入参就是我们activity实例 然后拿到我们自己的viewModelStore，这个时候的viewModelStore已经创建好了，看第二个参数是Factory 我们传递的是NewInstanceFactory这个一看就是单例，内部实现了一个create方法

  public open class NewInstanceFactory : Factory {
        @Suppress("DocumentExceptions")
        override fun <T : ViewModel> create(modelClass: Class<T>): T {
            return try {
                modelClass.newInstance()
            } catch (e: InstantiationException) {
                throw RuntimeException("Cannot create an instance of $modelClass", e)
            } catch (e: IllegalAccessException) {
                throw RuntimeException("Cannot create an instance of $modelClass", e)
            }
        }

一个泛型方法返回一个自定义的viewmodel实例，但是还是没看到如何存储的viewmodel,别急

我们再来看最后调用的get方法

 @MainThread
    public open operator fun <T : ViewModel> get(key: String, modelClass: Class<T>): T {
        val viewModel = store[key]
        if (modelClass.isInstance(viewModel)) {
            (factory as? OnRequeryFactory)?.onRequery(viewModel)
            return viewModel as T
        } else {
            @Suppress("ControlFlowWithEmptyBody")
            if (viewModel != null) {
                // TODO: log a warning.
            }
        }
        val extras = MutableCreationExtras(defaultCreationExtras)
        extras[VIEW_MODEL_KEY] = key
        // AGP has some desugaring issues associated with compileOnly dependencies so we need to
        // fall back to the other create method to keep from crashing.
        return try {
            factory.create(modelClass, extras)
        } catch (e: AbstractMethodError) {
            factory.create(modelClass)
        }.also { store.put(key, it) }
    }

首选会从ViewModelStore中获取viewmodel ，看if语句内部就可以看出直接返回的是缓存的viewmodel，如果不存在则根据创建的factory去实例化viewmodel然后并存储到ViewModelStore中。

经过我们的源码分析，我们现在已经明白了viewmodel的存储过程和如何在activity销毁时获取的流程。

那么viewmodel又是如何销毁的呢？还记得viewmodel中的onCleared方法吗？注释就写明了当这个ViewModel不再使用并被销毁时，这个方法将被调用。 那么就来看这个方法在什么时候调用的

内部有一个clear该方法又被ViewModelStore的clear方法调用，接着又被ComponentActivity内部

 getLifecycle().addObserver(new LifecycleEventObserver() {
            @Override
            public void onStateChanged(@NonNull LifecycleOwner source,
                    @NonNull Lifecycle.Event event) {
                if (event == Lifecycle.Event.ON_DESTROY) {
                    // Clear out the available context
                    mContextAwareHelper.clearAvailableContext();
                    // And clear the ViewModelStore
                    if (!isChangingConfigurations()) {
                        getViewModelStore().clear();
                    }
                }
            }
        });

用到了Lifecycle去监听生命周期当activity不正常销毁时，则清除掉缓存的viewmodel。至此我们就搞懂了viewmodel是如何实现了对数据的存储和以及数据的获取。

这里还有一点需要额外说明，ViewModelStore也是从缓存中取得, 在getViewModelStore方法和onRetainNonConfigurationInstance方法中 都能看到getLastNonConfigurationInstance方法的身影。不为null,就获取缓存的ViewModelStore，那就自然能获取到之前存储的viewModel 至于怎么缓存的各位大佬自己研究吧！

至此 ，我们已经搞懂了viewmodel是如何做到在activity销毁时自动清除和销毁重建显示之前数据。