Android Jetpack架構組件（六）一文帶你瞭解ViewModel的使用和原理

本文首發於微信公衆號「後廠村碼農」

前言

在本系列的第4和第5篇文章中，介紹了LiveData的使用和原理，LiveData和ViewModel是一對好搭檔，這篇文章咱們一塊兒來學習什麼是ViewModel、ViewModel基本使用、ViewModel的原理。

1.什麼是ViewModel

在說ViewModel前，咱們須要解一下MVVM和DataBinding，在Android進階三部曲第一部《Android進階之光》中，我簡單介紹了下MVVM和DataBinding。MVVM最先於2005年被微軟的架構師John Gossman提出，在2015年Google I/O大會上發佈了MVVM的支持庫DataBinding，DataBinding遭到了一些開發者的詬病，主要是綁定數據時若是出現問題會很難排查，這樣就沒有一個合適的ViewModel規範來幫助開發者來實現MVVM。 在2017年的Google I/O大會上，谷歌推出了ViewModel組件，來規範化ViewModel層。

ViewModel顧名思義，是以感知生命週期的形式來存儲和管理視圖相關的數據。ViewModel主要有如下的特色：

1.當Activity被銷燬時，咱們可使用onSaveInstanceState()方法恢復其數據，這種方法僅適用於恢復少許的支持序列化、反序列化的數據，不適用於大量數據，如用戶列表或位圖。而ViewModel不只支持大量數據，還不須要序列化、反序列化操做。 2.Activity/Fragment（視圖控制器）主要用於顯示視圖數據，若是它們也負責數據庫或者網絡加載數據等操做，那麼一旦邏輯過多，會致使視圖控制器臃腫，ViewModel能夠更容易，更有效的將視圖數據相關邏輯和視圖控制器分離開來。 3.視圖控制器常常須要一些時間纔可能返回的異步調用，視圖控制器須要管理這些調用，在合適的時候清理它們，以確保它們的生命週期不會大於自身，避免內存泄漏。而ViewModel偏偏能夠避免內存泄漏的發生。

2.ViewModel基本使用

添加依賴 在Android Jetpack架構組件（二）帶你瞭解Lifecycle（使用篇）這篇文章中講過，通常狀況只須要添加以下代碼就能夠：

implementation "android.arch.lifecycle:extensions:1.1.1"
複製代碼

因爲Gradle默認支持依賴傳遞，添加這一句代碼就依賴了不少庫。若是不懂Gradle的依賴傳遞，能夠查看 Android Gradle （二）簽名配置和依賴管理這篇文章。

若是須要其餘特性，好比kotlin的支持，再另行添加。

自定義ViewModel 繼承ViewMode，實現自定義ViewModel。

import android.arch.lifecycle.LiveData;
import android.arch.lifecycle.MutableLiveData;
import android.arch.lifecycle.ViewModel;

public class MyViewModel extends ViewModel {
    private MutableLiveData<String> name;
    public LiveData<String> getName() {
        if (name == null) {
            name = new MutableLiveData<String>();
            addName();
        }
        return name;
    }
    private void addName() {
        name.setValue("Android進階解密");
    }
}
複製代碼

getName方法中建立一個MutableLiveData，並經過MutableLiveData的setValue方法來更新數據。

使用ViewModel 而後就能夠在Activity中使用MyViewModel了，以下所示。

import android.arch.lifecycle.Observer;
import android.arch.lifecycle.ViewModelProviders;
import android.support.annotation.Nullable;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;

public class MainActivity extends AppCompatActivity {
    private static final String TAG = "MainActivity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        MyViewModel model = ViewModelProviders.of(this).get(MyViewModel.class);
        model.getName().observe(this, new Observer<String>() {
            @Override
            public void onChanged(@Nullable String s) {
                   Log.d(TAG, "暢銷書："+s);
            }
        });
    }
}
複製代碼

經過ViewModelProviders就能夠得到MyViewModel的實例，而後配合LiveData就能夠觀察Name的變化。打印結果爲： D/MainActivity: 書名爲Android進階解密

3.ViewModel的生命週期

在旋轉設備屏幕時，Activity會被銷燬從新建立，而ViewModel卻不會這樣，它的生命週期以下所示。

能夠看到，Activity的生命週期不斷變化，經歷了被銷燬從新建立，而ViewModel的生命週期沒有發生變化。

4.ViewModel的原理

要講解原理，咱們須要先從一個點入手，那就是第2節例子中的：

MyViewModel model = ViewModelProviders.of(this).get(MyViewModel.class);
複製代碼

由於咱們是在Activity中調用的，所以this的值爲Activity，咱們還能夠在Fragment中調用上面的方法，那麼this的值爲Fragment，所以ViewModelProviders.of()有多個構造方法，咱們以在Activity中調用爲例。

frameworks/support/lifecycle/extensions/src/main/java/androidx/lifecycle/ViewModelProviders.java

@NonNull
    @MainThread
    public static ViewModelProvider of(@NonNull FragmentActivity activity) {
        return of(activity, null);
    }
    
    @NonNull
    @MainThread
    public static ViewModelProvider of(@NonNull FragmentActivity activity, @Nullable Factory factory) {
        Application application = checkApplication(activity);//1
        if (factory == null) {
            factory = ViewModelProvider.AndroidViewModelFactory.getInstance(application);//3
        }
        return new ViewModelProvider(activity.getViewModelStore(), factory);
    }
複製代碼

ViewModelProvider的of方法有多個構造方法， 註釋1處內部會調用activity.getApplication()來返回該Activity對應的Application。 註釋2處的代碼來建立AndroidViewModelFactory實例。最後會新建一個ViewModelProvider，將AndroidViewModelFactory做爲參數傳進去，AndroidViewModelFactory的代碼以下所示。

public static class AndroidViewModelFactory extends ViewModelProvider.NewInstanceFactory {

        private static AndroidViewModelFactory sInstance;
        @NonNull
        public static AndroidViewModelFactory getInstance(@NonNull Application application) {
            if (sInstance == null) {
                sInstance = new AndroidViewModelFactory(application);
            }
            return sInstance;
        }
        private Application mApplication;
        public AndroidViewModelFactory(@NonNull Application application) {
            mApplication = application;
        }

        @NonNull
        @Override
        public <T extends ViewModel> T create(@NonNull Class<T> modelClass) {
            if (AndroidViewModel.class.isAssignableFrom(modelClass)) {
                //noinspection TryWithIdenticalCatches
                try {
                    return modelClass.getConstructor(Application.class).newInstance(mApplication);
                } catch (NoSuchMethodException e) {
                    throw new RuntimeException("Cannot create an instance of " + modelClass, e);
                } catch (IllegalAccessException e) {
                    throw new RuntimeException("Cannot create an instance of " + modelClass, e);
                } catch (InstantiationException e) {
                    throw new RuntimeException("Cannot create an instance of " + modelClass, e);
                } catch (InvocationTargetException e) {
                    throw new RuntimeException("Cannot create an instance of " + modelClass, e);
                }
            }
            return super.create(modelClass);
        }
    }
複製代碼

AndroidViewModelFactory是一個單例，講這個類前，須要知道ViewModel類自己是一個抽象類，咱們經過繼承ViewModel，來實現自定義ViewModel，那麼AndroidViewModelFactory的create方法的做用，就是經過反射生成ViewModel的實現類。 接着回頭看ViewModelProvider.get方法。 frameworks/support/lifecycle/viewmodel/src/main/java/androidx/lifecycle/ViewModelProvider.java

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

        if (modelClass.isInstance(viewModel)) {
            //noinspection unchecked
            return (T) viewModel;
        } else {
            //noinspection StatementWithEmptyBody
            if (viewModel != null) {
                // TODO: log a warning.
            }
        }

        viewModel = mFactory.create(modelClass);
        mViewModelStore.put(key, viewModel);
        //noinspection unchecked
        return (T) viewModel;
    }
複製代碼

註釋1處獲得類的名稱，對這個名稱進行字符串拼接，做爲註釋2處方法的參數，DEFAULT_KEY的值爲： "androidx.lifecycle.ViewModelProvider.DefaultKey"。 所以，註釋3處的key值實際上就是"androidx.lifecycle.ViewModelProvider.DefaultKey"+類名。根據這個key值從ViewModelStore獲取ViewModel（ViewModel的實現類）。若是ViewModel能轉換爲modelClass類的對象，直接返回該ViewModel。不然會經過Factory建立一個ViewModel，並將其存儲到ViewModelStore中。這裏的Factory指的是AndroidViewModelFactory，它在ViewModelProvider建立時做爲參數傳進來。 到此爲止，咱們已經知道了ViewModel的實現類是如何建立的了。

當建立完ViewModel的實現類後，在第2小節咱們還會調用以下代碼。

MyViewModel model = ViewModelProviders.of(this).get(MyViewModel.class);
        model.getName().observe(this, new Observer<String>() {
            @Override
            public void onChanged(@Nullable String s) {
                   Log.d(TAG, "暢銷書："+s);
            }
        });
複製代碼

model.getName()會返回一個MutableLiveData，接着調用了MutableLiveData的observe方法，這個在Android Jetpack架構組件（五）帶你瞭解LiveData(原理篇）這篇文章中講過，就再也不贅述。

更多的內容請關注個人獨立博客的知識體系:
liuwangshu.cn/system/

---

這裏不只分享大前端、Android、Java等技術，還有程序員成長類文章。