Jetpack ViewModel

在说起Jetpack的ViewModel时,我们第一反应都会想到它就是MVVM中的VM。然而这两者并不是等价关系,Jetpack的ViewModel它只是官方为我们提供的一个具体工具,他的作用其实就是一个数据管理容器。而MVVM是一种构架思想,VM是这里面的一层,用来链接V与M层。
由于Jetpack的ViewModel的独有特性我们可以对它进行拓展,使它充当MVVM的VM角色。

1.ViewModel的使用

创建ViewModel

public class MyViewModel extends ViewModel { 
    public int count;
    public int getCount() {
        return count;
    }
    public void setCount(int count) {
        this.count = count;
    }
}

获取ViewModel对象

public class ViewModelActivity extends AppCompatActivity {
    private MyViewModel viewModel;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        viewModel = ViewModelProviders.of(this).get(MyViewModel.class);
        viewModel.setCount(2);
        viewModel.getCount();
    }
}

当然上面的示例代码没有具体意义,但是纯粹使用ViewModel就是这么简单,先抛开ViewModel在MVVM中的使用,我们可以用ViewModel来做些什么呢,它有怎样的优势?

2.ViewModel的使用场景

2.1.横竖屏切换时,Activity重新创建,可以通过ViewModel保存数据。

ViewModel与Activity生命周期关系如下:


image.png

可以看到,在屏幕旋转Activity重新创建的过程中,ViewModel一直保持存活。

2.2.同一个Activity下,Fragment之间的数据共享。

我们可以将数据存放到Activity的ViewModel中,在Activity中的Fragment中通过以下代码获取到Activity中的ViewModel,实现数据共享。

    viewModel = ViewModelProviders.of(activity).get(MyViewModel.class);

3.ViewModel的实现原理

(下面的源码分析都基于在Activity中使用ViewModel,旨在理清流程,在Fragmeng中的原理大致相同)

3.1.ViewModel的获取

ViewModelProviders.of(activity).get(MyViewModel.class)
--ViewModelProviders.java
public static ViewModelProvider of(@NonNull FragmentActivity activity,
            @Nullable Factory factory) {
    Application application = checkApplication(activity);
    if (factory == null) {
        factory = ViewModelProvider.AndroidViewModelFactory.getInstance(application);
    }
    return new ViewModelProvider(activity.getViewModelStore(), factory);
}

这里需要注意activity.getViewModelStore(),它是一个ViewModelStore对象,ViewModelStore的实现非常简单,内部维护一个HashMap用来存放ViewModel。

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());
    }
    public final void clear() {
        for (ViewModel vm : mMap.values()) {
            vm.clear();
        }
        mMap.clear();
    }
}

ViewModelProviders.of(activity)获取到ViewModelProvider后,通过ViewModelProvider.get(modelClass)获取ViewModel。

--ViewModelProvider.java

private static final String DEFAULT_KEY =
            "androidx.lifecycle.ViewModelProvider.DefaultKey";

 public <T extends ViewModel> T get(@NonNull Class<T> modelClass) {
    String canonicalName = modelClass.getCanonicalName();
    if (canonicalName == null) {
        throw new IllegalArgumentException("Local and anonymous classes can not be ViewModels");
    }
    return get(DEFAULT_KEY + ":" + canonicalName, modelClass);
}

public <T extends ViewModel> T get(@NonNull String key, @NonNull Class<T> modelClass) {
    ViewModel viewModel = mViewModelStore.get(key);
    if (modelClass.isInstance(viewModel)) {
        return (T) viewModel;
    } else {
        if (viewModel != null) {      
        }
    }
    if (mFactory instanceof KeyedFactory) {
        viewModel = ((KeyedFactory) (mFactory)).create(key, modelClass);
    } else {
        viewModel = (mFactory).create(modelClass);
    }
    mViewModelStore.put(key, viewModel);
    return (T) viewModel;
}

这里的mViewModelStore就是上面new ViewModelProvider(activity.getViewModelStore(), factory)时传入的activity的ViewModelStore。
整体流程:在获取ViewModel时,先从Acactivitytivity中的ViewModelStore容器中获取,
获取的key为DEFAULT_KEY +ViewModel.class.getCanonicalName()。没有获取到时通过Factory创建对应ViewModel,并添加到Acactivitytivity中的ViewModelStore容器中,下次可以直接获取到。
所以在一个Activity中同一个class对应的ViewModel只会存在一个,这也就是上面场景2的使用基础。

3.2.清楚ViewModel的获取流程后,接下来看ViewModel怎样做到旋转屏幕依然保持存活的。

我们知道Activity在屏幕旋转时默认会重新创建Activity,新的Activity是不会保存原Activity的数据的,那ViewModel是怎样跨Activity对象得到保存的呢?
根据3.1我们知道ViewModel存放在Activity的ViewModelStore中,我们看一下activity.getViewModelStore():

    --ComponentActivity.java

    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.");
        }
        if (mViewModelStore == null) {
            NonConfigurationInstances nc =
                    (NonConfigurationInstances) getLastNonConfigurationInstance();
            if (nc != null) {
                mViewModelStore = nc.viewModelStore;
            }
            if (mViewModelStore == null) {
                mViewModelStore = new ViewModelStore();
            }
        }
        return mViewModelStore;
    }

第一次获取ViewModelStore时,会先调用getLastNonConfigurationInstance()获取到一个NonConfigurationInstances对象,并尝试从NonConfigurationInstances中获取ViewModelStore,没有获取到时才会创建一个ViewModelStore;

    --ComponentActivity.java

   NonConfigurationInstances mLastNonConfigurationInstances;

   public Object getLastNonConfigurationInstance() {
        return mLastNonConfigurationInstances != null
                ? mLastNonConfigurationInstances.activity : null;
    }

   final void attach(Context context, ActivityThread aThread,
            Instrumentation instr, IBinder token, int ident,
            Application application, Intent intent, ActivityInfo info,
            CharSequence title, Activity parent, String id,
            NonConfigurationInstances lastNonConfigurationInstances,
            Configuration config, String referrer, IVoiceInteractor voiceInteractor,
            Window window, ActivityConfigCallback activityConfigCallback, IBinder assistToken) {
        ......
        mLastNonConfigurationInstances = lastNonConfigurationInstances;
        ......
    }

mLastNonConfigurationInstances是ComponentActivity中的一个变量,它在Activity创建时attach()中被系统传入。
mLastNonConfigurationInstances.activity的保存发生在

     public final Object onRetainNonConfigurationInstance() {
        Object custom = onRetainCustomNonConfigurationInstance();
        ViewModelStore viewModelStore = mViewModelStore;
        if (viewModelStore == null) {
            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;
    }

最后还有一个小细节,在androidx.activity.ComponentActivity的构造方法中对当前Activity的生命周期进行了监听。

    androidx.activity.ComponentActivity.java

    public ComponentActivity() {
        ......
        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在Destroy时,如果不是屏幕旋转才会清空tViewModelStore()中的ViewModel。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,254评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,875评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,682评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,896评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,015评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,152评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,208评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,962评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,388评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,551评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,186评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2 351

推荐阅读更多精彩内容