android viewmodel的作用深入讲解-kb88凯时官网登录

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 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 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  create(modelclass: class): 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  get(key: string, modelclass: class): 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销毁时自动清除和销毁重建显示之前数据。