ViewModel源码解析

0.前言

viewModel是什么？
官方解释：

The ViewModel class is designed to store and manage UI-related data in a lifecycle conscious way. The ViewModel class allows data to survive configuration changes such as screen rotations.
ViewModel类旨在以生命周期有意识的方式存储和管理ui相关的数据。ViewModel类允许数据在配置更改(如屏幕旋转)之后存活。

这里明确指出，ViewModel可以感知activity生命周期，并在配置更改后允许数据存活（原理是内部类HolderFragment调用了setRetainInstance(true)，从而当屏幕旋转时，activity重绘但Fragment不重绘），与viewModel绑定的Activity必须继承于FragmentActivity。
官方网址
以及关于ViewModel与Activity生命周期的关联图：

viewmodel-lifecycle.png

1.使用

ViewModel一般与LiveData结合使用：
添加依赖

// ViewModel and LiveData
implementation "android.arch.lifecycle:extensions:1.1.1"
// alternatively, just ViewModel
implementation "android.arch.lifecycle:viewmodel:1.1.1"
// alternatively, just LiveData
implementation "android.arch.lifecycle:livedata:1.1.1"

package foolish

import android.arch.lifecycle.LifecycleOwner
import android.arch.lifecycle.MutableLiveData
import android.arch.lifecycle.Observer
import android.arch.lifecycle.ViewModel
import beans.response.TaskBean
import com.uber.autodispose.AutoDispose
import com.uber.autodispose.android.lifecycle.AndroidLifecycleScopeProvider
import comment.LogUit
import io.reactivex.Observable
import io.reactivex.android.schedulers.AndroidSchedulers
import io.reactivex.observers.DisposableObserver
import io.reactivex.schedulers.Schedulers


class TestModel:ViewModel(){
    val taskLiveData= MutableLiveData<Observable<TaskBean>>()//ViewModel内部持有LiveData
    fun initData( lifecycleOwner: LifecycleOwner){
        //此处选择在TestModel内部处理LiveData（网上教程很多是把LiveData放在View中处理）
        taskLiveData.observe(lifecycleOwner,object : Observer<Observable<TaskBean>>{
            override fun onChanged(observable: Observable<TaskBean>?) {
                observable!!.subscribeOn(Schedulers.io())
                        .observeOn(AndroidSchedulers.mainThread())
                        .`as`(AutoDispose.autoDisposable(AndroidLifecycleScopeProvider.from(lifecycleOwner)))//使用AutoDispose绑定lifecycleOwner，自动取消订阅
                        .subscribe(object : DisposableObserver<TaskBean>() {
                            override fun onComplete() {

                            }

                            override fun onNext(t: TaskBean) {
                                LogUit.printI("TaskPresentPrint", "t=${t.toString()}")
                            }

                            override fun onError(e: Throwable) {
                                //处理网略错误
                            }

                        })
            }

        })
    }


}

Activity中调用：

 private val registerOrLoginModel by lazy { ViewModelProviders.of(this).get(TestModel::class.java) }

2.源码分析

先来看看of做了什么

@NonNull
    @MainThread
    public static ViewModelProvider of(@NonNull FragmentActivity activity) {
        //如果没有传递factory过来，默认null
        return of(activity, null);
    }

 @NonNull
    @MainThread
    public static ViewModelProvider of(@NonNull FragmentActivity activity,
            @Nullable Factory factory) {
        Application application = checkApplication(activity);
        //如果没有传递factory过来，就自己新建一个
        if (factory == null) {
            factory = ViewModelProvider.AndroidViewModelFactory.getInstance(application);
        }
        //从ViewModelStores里面取出对应Activity的ViewModelProvider
        return new ViewModelProvider(ViewModelStores.of(activity), factory);
    }

在查看ViewModelProvider源码之前，先来看看ViewModelStores：

  • ViewModelStores
/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.arch.lifecycle;

import static android.arch.lifecycle.HolderFragment.holderFragmentFor;

import android.support.annotation.MainThread;
import android.support.annotation.NonNull;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentActivity;

/**
 * Factory methods for {@link ViewModelStore} class.
 */
@SuppressWarnings("WeakerAccess")
public class ViewModelStores {

    private ViewModelStores() {
    }

    /**
     * Returns the {@link ViewModelStore} of the given activity.
     *
     * @param activity an activity whose {@code ViewModelStore} is requested
     * @return a {@code ViewModelStore}
     */
    @NonNull
    @MainThread
    public static ViewModelStore of(@NonNull FragmentActivity activity) {
        if (activity instanceof ViewModelStoreOwner) {
            //如果已经存在ViewModelStore，直接返回它
            return ((ViewModelStoreOwner) activity).getViewModelStore();
        }
        //否则，新建一个
        return holderFragmentFor(activity).getViewModelStore();
    }

    /**
     * Returns the {@link ViewModelStore} of the given fragment.
     *
     * @param fragment a fragment whose {@code ViewModelStore} is requested
     * @return a {@code ViewModelStore}
     */
    @NonNull
    @MainThread
    public static ViewModelStore of(@NonNull Fragment fragment) {
        if (fragment instanceof ViewModelStoreOwner) {
            return ((ViewModelStoreOwner) fragment).getViewModelStore();
        }
        return holderFragmentFor(fragment).getViewModelStore();
    }
}

只有两个of方法和一个构造方法，只接受FragmentActivity 和Fragment，没骗你吧。

这里，holderFragmentFor是包内定义好的一个Fragment类，继承于Fragment实现ViewModelStoreOwner接口（里面包含ViewModelStore getViewModelStore();方法，主要就是为了实现这个方法，符合接口隔离原则），HolderFragment的构造方法里面：

public HolderFragment() {
     setRetainInstance(true);
}

调用 setRetainInstance(true)了！，没骗你吧

  • holderFragmentFor方法
 /**
     * @hide
     */
    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
    public static HolderFragment holderFragmentFor(FragmentActivity activity) {
        //调用静态内部类HolderFragmentManager的holderFragmentFor
        return sHolderFragmentManager.holderFragmentFor(activity);
    }

  ......
  /*省略部分代码，在HolderFragment 里面：*/
   HolderFragment holderFragmentFor(FragmentActivity activity) {
            FragmentManager fm = activity.getSupportFragmentManager();
            HolderFragment holder = findHolderFragment(fm);//获取holder（holder是Fragment）
            //非空立刻返回holder
            if (holder != null) {
                return holder;
            }
            //mNotCommittedActivityHolders是HolderFragmentManager内部用于存储<Activity, HolderFragment>键值对的变量
            holder = mNotCommittedActivityHolders.get(activity);
            //非空返回，用于防止重复执行
            if (holder != null) {
                return holder;
            }

            if (!mActivityCallbacksIsAdded) {
                mActivityCallbacksIsAdded = true;
                activity.getApplication().registerActivityLifecycleCallbacks(mActivityCallbacks);
            }
            holder = createHolderFragment(fm);//新建一个
            mNotCommittedActivityHolders.put(activity, holder);
            return holder;
        }
//新建HolderFragment 
 private static HolderFragment createHolderFragment(FragmentManager fragmentManager) {
            HolderFragment holder = new HolderFragment();
            fragmentManager.beginTransaction().add(holder, HOLDER_TAG).commitAllowingStateLoss();
            return holder;
        }

 private static HolderFragment findHolderFragment(FragmentManager manager) {
            if (manager.isDestroyed()) {
                throw new IllegalStateException("Can't access ViewModels from onDestroy");
            }

            Fragment fragmentByTag = manager.findFragmentByTag(HOLDER_TAG);
            if (fragmentByTag != null && !(fragmentByTag instanceof HolderFragment)) {
                throw new IllegalStateException("Unexpected "
                        + "fragment instance was returned by HOLDER_TAG");
            }
            return (HolderFragment) fragmentByTag;
        }

findHolderFragment和createHolderFragment代码都比较简单，就不解释了。
这一步主要就是为了获得HolderFragment，回到ViewModelStores.of方法，接着主要还是要获取它的ViewModelStore，ViewModelStore内部维护了一个HashMap<String, ViewModel>，实现get,put，clear方法，这里就不贴代码了，把它当做Map的一部分就行，主要用于存放ViewModel。
如此一来，就获取到ViewModelStore了，然后再回到 ViewModelProvider.of里面，将它传递给ViewModelProvider

return new ViewModelProvider(ViewModelStores.of(activity), factory);
  • ViewModelProvider
 public ViewModelProvider(@NonNull ViewModelStore store, @NonNull Factory factory) {
        mFactory = factory;
        this.mViewModelStore = store;
    }

ViewModelProvider把这两个家伙给存储起来以供调用，如此一来，刚才那段代码

ViewModelProviders.of(this).get(TestModel::class.java)

of到这里就结束了，接下来看get：

 @NonNull
    @MainThread
    public <T extends ViewModel> T get(@NonNull Class<T> modelClass) {
        String canonicalName = modelClass.getCanonicalName();//获取ViewModel的名字
        if (canonicalName == null) {
            //如果为空，抛异常
            throw new IllegalArgumentException("Local and anonymous classes can not be ViewModels");
        }
        //否则获取ViewModel
        //这里DEFAULT_KEY 是默认值，
        return get(DEFAULT_KEY + ":" + canonicalName, modelClass);
    }

@NonNull
    @MainThread
    public <T extends ViewModel> T get(@NonNull String key, @NonNull Class<T> modelClass) {
        ViewModel viewModel = mViewModelStore.get(key);//从mViewModelStore里面获取viewModel 
        //如果已存在，返回
        if (modelClass.isInstance(viewModel)) {
            //noinspection unchecked
            return (T) viewModel;
        } else {
            //noinspection StatementWithEmptyBody
            if (viewModel != null) {
                // TODO: log a warning.
            }
        }
        //从工厂里面创建出ViewModel并返回
        viewModel = mFactory.create(modelClass);
        mViewModelStore.put(key, viewModel);
        //noinspection unchecked
        return (T) viewModel;
    }

这里的工厂就是我们传递进来的那个啦，如果不传，则默认会新建一个， ViewModelProvider.of已经说明。
由此就可以获取到ViewModel啦！

ViewModel.png

以上！

总结

获取ViewModel的方法

ViewModelProviders.of(this).get(TestModel::class.java)

分为两个步骤：
1.of获取到ViewModelProvider,而获取ViewModelProvider需要先获取ViewModelStores
2.从ViewModelProvider中获取ViewModel
原创文章，转载请附上https://www.jianshu.com/p/123051a328ba

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 205,386评论 6赞 479
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 87,939评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,851评论 0赞 341
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,953评论 1赞 278
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,971评论 5赞 369
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,784评论 1赞 283
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,126评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,765评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,148评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,479评论 4赞 322
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,080评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2赞 343