Android Jetpack ViewModel由淺入深

附上官網鏈接：https://developer.android.google.cn/topic/libraries/architecture/viewmodel

ViewModel簡介

該ViewModel類被設計用來存儲和管理UI界面相關的數據生命周期中的意識的方式。ViewModel類允許生存數據配置更改,如屏幕旋轉。

生命周期.png

存在的意義（解決痛點）

1. 數據的持久化

eg: 當系統銷毀或重新創建UI控制器（Activity、fragment、View等），則您存儲在其中的所有與UI相關的瞬時數據都將丟失。
activity 的onSaveInstanceState()機制可以用來保存和恢復數據。
缺點：此方法僅適用于可以先序列化然后反序列化的少量數據，不適用于潛在的大量數據，例如用戶列表或位圖。

生命周期.png 的ViewModel生命周期可以看到，它的生命周期橫跨Activity的所有生命周期，包括旋轉等出現的重新創建的生命周期，直到 Activity 真正意義上銷毀后才會結束。這樣子數據存儲在ViewModel中時，便可以保證在生命周期中數據不會丟失

2. UI控制器（Activity、fragment等）異步調用，導致的潛在內存泄漏

面對請求網絡、讀取IO、或者操作數據庫等異步操作，有些操作相當耗時，在UI控制器中我們設置這些回調等待結果，有可能在UI控制器銷毀的時候才返回。

在ViewModel中處理數據的回調，當Activity銷毀的時候，ViewModel也會跑onCleared()清理數據這樣子就不會存在Activity內存泄漏的問題。

3.分擔UI控制器的負擔

類似MVP中的P層，MVVM中VM存在意義就是替UI 控制器減輕負擔。UI控制器只用于相應用戶操作，展示數據，將具體的數據邏輯操作（eg：加載網絡、數據庫數據...等）放到VM層做處理。分工更加明確，也方便測試。

4.在Fragment之間共享數據

比如Activity在兩或多個Fragment中，你使用一個Fragment跟另外的Fragment通信，常見的操作是定義接口在Activity中根據接口返回邏輯調用到另外的Fragmet，也有其他可以用EventBus 廣播等其它的處理方式，但是前者耦合度高，后者也是相對繁瑣

在ViewModel中，你可以獲取同一個Activity綁定的ViewModel并監聽數據的變化進而實現通信下面是官網的例子

class SharedViewModel : ViewModel() {
    val selected = MutableLiveData<Item>()

    fun select(item: Item) {
        selected.value = item
    }
}

class MasterFragment : Fragment() {

    private lateinit var itemSelector: Selector

    private lateinit var model: SharedViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        model = activity?.run {
            ViewModelProviders.of(this)[SharedViewModel::class.java]
        } ?: throw Exception("Invalid Activity")
        itemSelector.setOnClickListener { item ->
            // Update the UI
        }
    }
}

class DetailFragment : Fragment() {

    private lateinit var model: SharedViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        model = activity?.run {
            ViewModelProviders.of(this)[SharedViewModel::class.java]
        } ?: throw Exception("Invalid Activity")
        model.selected.observe(this, Observer<Item> { item ->
            // Update the UI
        })
    }
}

好處：

Activity不需要知道兩者間的交互也不需要做什么，解耦
Fragment 不需要判斷對方是否存在等問題，也不需要持有對方的引用，不影響本身的任何工作，對其生命周期無感。

重點關注的點！！！
在ViewModel中不要持有Activity的引用
在ViewModel中不要持有Activity的引用
在ViewModel中不要持有Activity的引用
（重要的事情說三遍，因為生命周期比Activity略長會導致Activity被挾持！！！）
如果需要context對象，可以自行導入Application的context
官方也提供一個含有context的ViewModel的子類,AndroidViewModel 你可以直接繼承它

public class AndroidViewModel extends ViewModel {
    @SuppressLint("StaticFieldLeak")
    private Application mApplication;

    public AndroidViewModel(@NonNull Application application) {
        mApplication = application;
    }

    /**
     * Return the application.
     */
    @SuppressWarnings({"TypeParameterUnusedInFormals", "unchecked"})
    @NonNull
    public <T extends Application> T getApplication() {
        return (T) mApplication;
    }
}

簡單使用

導入庫

   implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:${var}"

創建子類繼承ViewModel()的

class NameViewModel :ViewModel(){
    // 創建Livedata的字符串
    val currencyName : MutableLiveData<String> = MutableLiveData()
    val totalMemory : MutableLiveData<String> = MutableLiveData()
    val remainMemory : MutableLiveData<String> = MutableLiveData()

}

Activity中使用

class MyActivity : AppCompatActivity() {

override fun onCreate(savedInstanceState: Bundle?) {
//1.先獲取一個ViewModel對象
val  mViewModel = ViewModelProviders.of(this).get(NameViewModel::class.java)
//2.定義一個觀察者
val nameObserver = Observer<String> { newName ->
   name_text.text = newName
}
//3.通過使用ViewModel對象進行監聽
mViewModel.currencyName.observe(this, nameObserver)
}

上面的展示了最基本的使用方式，先獲取到mViewModel對象，然后ViewModel.currencyName.observe(this, nameObserver)進行監聽Observer<String> { newName -> name_text.text = newName }當數據改變的時候，便會回調監聽的內容，并且傳入新的newName的值

基礎封裝

下面對基本項目上用到的ViewModel進行基本的封裝
先封裝 BaseViewModel BaseActivity
（以下的封裝只涉及ViewModel,基本的類根據自己的需求進行其他的封裝）
BaseViewModel

open class BaseViewModel :ViewModel(){
    //處理異常
    val mException:MutableLiveData<Throwable> = MutableLiveData()
}

BaseActivity

open class BaseActivity<VM:BaseViewModel> : AppCompatActivity(), LifecycleObserver {

    lateinit var mViewModel: VM

    override fun onCreate(savedInstanceState: Bundle?) {
        initVM()
        super.onCreate(savedInstanceState)
        startObserver()
    }

    open fun  startObserver(){
    }

    open fun providerVMClass():Class<VM>? = null

    private fun initVM() {
        providerVMClass()?.let {
            mViewModel =  ViewModelProviders.of(this).get(it)
        }
    }
}

使用：

class MainActivity : BaseActivity<NameViewModel>() {
  //提供 NameViewModel
    override fun providerVMClass(): Class<NameViewModel>? = NameViewModel::class.java
    val job = Job()
    val ioScope = CoroutineScope(Dispatchers.IO + job)
    var licycleObserver = MyObserver()

    companion object {
        val TAG = "memory"
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main_mvvm2)
     
        initViewModel()
        btn1.setOnClickListener {
            ioScope.launch {
                withContext(Dispatchers.Main) {
                    mViewModel.remainMemory.value = "沒有cancel的"
                }
            }
        }
    }

     private fun initViewModel() {

        //獲取viewmodel
        mViewModel = ViewModelProviders.of(this).get(NameViewModel::class.java)
        //創建監聽 更新UI
        val nameObserver = Observer<String> { newName ->
            name_text.text = newName
        }
        val memoryObserver = Observer<String> { totalMemory ->
            total_memory.text = totalMemory
        }
        val remainMemoryObserver = Observer<String> { remainMemory ->
            remain_memory.text = remainMemory
        }

        mViewModel.currencyName.observe(this, nameObserver)
        mViewModel.totalMemory.observe(this, memoryObserver)
        mViewModel.remainMemory.observe(this, remainMemoryObserver)
    }


}

構造器有參數的ViewModel

當ViewModel構造函數帶有參數的時候，就不能像上面那種實例化，而是要借助ViewModelProvider的Fatory進行實例化

對上面的ViewModel基礎使用改動一波

class NameViewModel(val currencyName:MutableLiveData<String>) :BaseViewModel(){
    // 創建Livedata的字符串

    val totalMemory : MutableLiveData<String> = MutableLiveData()
    val remainMemory : MutableLiveData<String> = MutableLiveData()
  // 創建工廠對象類
    class NameViewModelFactory(private val current:MutableLiveData<String>):ViewModelProvider.NewInstanceFactory(){
        override fun <T : ViewModel?> create(modelClass: Class<T>): T {
            return NameViewModel(current) as T
        }
    }

}

使用獲取一個ViewModel對象

//1.先獲取一個ViewModel對象
ViewModelProviders.of(this,NameViewModel.NameViewModelFactory(MutableLiveData("total"))).get(NameViewModel::class.java)

相比第一次獲取實例的方式是調用了ViewModelProvider of(@NonNull FragmentActivity activity, @Nullable Factory factory)增加多了一個工廠對象其它的數據監聽跟基本的不帶參數實例化ViewModel的用法一致

源碼跟蹤解讀

從最開始的ViewModelProviders.of開始追蹤

ViewModelProviders方法圖.png

從上圖可以看到ViewModelProviders主要是用于生成跟返回實例化的ViewModelProvider對象的。
看最本篇文章簡單在Activity中使用的時候

val  mViewModel = ViewModelProviders.of(this).get(NameViewModel::class.java)

調用了

public class ViewModelProviders {
  //...省略其他方法
//關鍵代碼1：
  @NonNull
    @MainThread
    public static ViewModelProvider of(@NonNull FragmentActivity activity) {
        return of(activity, null);
    }
//關鍵代碼2：
    @NonNull
    @MainThread
    public static ViewModelProvider of(@NonNull FragmentActivity activity,
            @Nullable Factory factory) {
//關鍵代碼3:
        Application application = checkApplication(activity);

        if (factory == null) {
//關鍵代碼5
            factory = ViewModelProvider.AndroidViewModelFactory.getInstance(application);
        }
//關鍵代碼6
        return new ViewModelProvider(activity.getViewModelStore(), factory);
    }
//關鍵代碼4:
    private static Application checkApplication(Activity activity) {
        Application application = activity.getApplication();
        if (application == null) {
            throw new IllegalStateException("Your activity/fragment is not yet attached to "
                    + "Application. You can't request ViewModel before onCreate call.");
        }
        return application;
    }
//關鍵代碼7
        @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);
        }
}

可以看到在關鍵代碼2的方法中先是對Activity進行Application判空邏輯(關鍵代碼4 )，我們傳進來的factory是空的，則ViewModelProvider.AndroidViewModelFactory.getInstance(application)(關鍵代碼5)獲得一個factory,再調用關鍵代碼6 進而返回一個ViewModelProvider
關鍵代碼7 我們傳進來的ViewModel類通過反射的形式創建ViewModel對象并返回
先跟蹤關鍵代碼5進去看看factory是怎么來的

    public static class AndroidViewModelFactory extends ViewModelProvider.NewInstanceFactory {

        private static AndroidViewModelFactory sInstance;

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

    }

這里返回了一個單例對象AndroidViewModelFactory

返回上面的關鍵代碼6 return new ViewModelProvider(activity.getViewModelStore(), factory); 跟蹤一下

    public ViewModelProvider(@NonNull ViewModelStore store, @NonNull Factory factory) {
        mFactory = factory;
        mViewModelStore = store;
    }

這里將mViewModelStore跟mFactory實例化了
mViewModelStore是從activity.getViewModelStore()得到的

public class ComponentActivity extends androidx.core.app.ComponentActivity implements
        LifecycleOwner,
        ViewModelStoreOwner,
        SavedStateRegistryOwner,
        OnBackPressedDispatcherOwner {
    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) {
          //先獲取是否存在`ViewModelStore`
            NonConfigurationInstances nc =
                    (NonConfigurationInstances) getLastNonConfigurationInstance();
            if (nc != null) {
                // Restore the ViewModelStore from NonConfigurationInstances
                mViewModelStore = nc.viewModelStore;
            }
            if (mViewModelStore == null) {
              //這里新建了`ViewModelStore`
                mViewModelStore = new ViewModelStore();
            }
        }
        return mViewModelStore;
    }
}

看到上面已經生成了ViewModelStore接下來跟蹤一下 ViewModelProviders.of(this).get(NameViewModel::class.java)的get()方法看看

public class ViewModelProvider {

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

    @NonNull
    @MainThread
    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)) {
            if (mFactory instanceof OnRequeryFactory) {
                ((OnRequeryFactory) mFactory).onRequery(viewModel);
            }
            return (T) viewModel;
        } else {
            //noinspection StatementWithEmptyBody
            if (viewModel != null) {
                // TODO: log a warning.
            }
        }
        if (mFactory instanceof KeyedFactory) {
            viewModel = ((KeyedFactory) (mFactory)).create(key, modelClass);
        } else {
            viewModel = (mFactory).create(modelClass);
        }
        mViewModelStore.put(key, viewModel);
        return (T) viewModel;
    }
}

上面的代碼解釋一下：先從mViewModelStore.get(key);獲取出來ViewModel，如果有則返回，沒有的話就調用之前擁有的工廠對象mFactory類去viewModel = (mFactory).create(modelClass)或者((KeyedFactory) (mFactory)).create(key, modelClass) ，最終調用mViewModelStore.put(key, 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();
    }
}

看到上面的代碼了嗎?
最終返回的viewModel,返回前先調用了mViewModelStore.put(key, viewModel)將這個
viewModel存到mViewModelStore中的HashMap
既然mViewModelStore是存儲ViewModel的地方那我們也看一下ViewModelStore中的clear()是在哪里被調用的

image.png

我們跟蹤一下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();
                    }
                }
            }
        });

上面可以看到在Lifecycle.Event.ON_DESTROY為的狀態時調用getViewModelStore().clear();方法。也就說在Activity的生命周期到onDestory的時候將本Activity所有的ViewmModel清除掉

這篇文章只是對基本的使用到這個調用的開始到結束，進行源碼的一個追蹤，對ViewModel有個比較深刻的印象，里面還有很多細節可以考究，只是本人技術有限，如果讀者有沒什么疑問可以在評論中說一下~

?著作權歸作者所有,轉載或內容合作請聯系作者

人面猴
序言：七十年代末，一起剝皮案震驚了整個濱河市，隨后出現的幾起案子，更是在濱河造成了極大的恐慌，老刑警劉巖，帶你破解...
沈念sama閱讀 227,663評論 6贊 531
死咒
序言：濱河連續發生了三起死亡事件，死亡現場離奇詭異，居然都是意外死亡，警方通過查閱死者的電腦和手機，發現死者居然都...
沈念sama閱讀 98,125評論 3贊 414
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人，你說我怎么就攤上這事。” “怎么了？”我有些...
開封第一講書人閱讀 175,506評論 0贊 373
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵，是天一觀的道長。經常有香客問我，道長，這世上最難降的妖魔是什么？我笑而不...
開封第一講書人閱讀 62,614評論 1贊 307
?港島之戀（遺憾婚禮）
正文為了忘掉前任，我火速辦了婚禮，結果婚禮上，老公的妹妹穿的比我還像新娘。我一直安慰自己，他們只是感情好，可當我...
茶點故事閱讀 71,402評論 6贊 404
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布。她就那樣靜靜地躺著，像睡著了一般。火紅的嫁衣襯著肌膚如雪。梳的紋絲不亂的頭發上，一...
開封第一講書人閱讀 54,934評論 1贊 321
城市分裂傳說
那天，我揣著相機與錄音，去河邊找鬼。笑死，一個胖子當著我的面吹牛，可吹牛的內容都是我干的。我是一名探鬼主播，決...
沈念sama閱讀 43,021評論 3贊 440
雙鴛鴦連環套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了？” 一聲冷哼從身側響起，我...
開封第一講書人閱讀 42,168評論 0贊 287
萬榮殺人案實錄
序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后，有當地人在樹林里發現了一具尸體，經...
沈念sama閱讀 48,690評論 1贊 333
?護林員之死
正文獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛以下內容為張勛視角年9月15日...
茶點故事閱讀 40,596評論 3贊 354
?白月光啟示錄
正文我和宋清朗相戀三年，在試婚紗的時候發現自己被綠了。大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
茶點故事閱讀 42,784評論 1贊 369
活死人
序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖，靈堂內的尸體忽然破棺而出，到底是詐尸還是另有隱情，我是刑警寧澤，帶...
沈念sama閱讀 38,288評論 5贊 357
?日本核電站爆炸內幕
正文年R本政府宣布，位于F島的核電站，受9級特大地震影響，放射性物質發生泄漏。R本人自食惡果不足惜，卻給世界環境...
茶點故事閱讀 44,027評論 3贊 347
男人毒藥：我在死后第九天來索命
文/蒙蒙一、第九天我趴在偏房一處隱蔽的房頂上張望。院中可真熱鬧，春花似錦、人聲如沸。這莊子的主人今日做“春日...
開封第一講書人閱讀 34,404評論 0贊 25
一樁弒父案，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽。三九已至，卻和暖如春，著一層夾襖步出監牢的瞬間，已是汗流浹背。一陣腳步聲響...
開封第一講書人閱讀 35,662評論 1贊 280
情欲美人皮
我被黑心中介騙來泰國打工，沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人。一個月前我還...
沈念sama閱讀 51,398評論 3贊 390
代替公主和親
正文我出身青樓，卻偏偏與公主長得像，于是被迫代替她去往敵國和親。傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當晚...
茶點故事閱讀 47,743評論 2贊 370

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

Android Jetpack ViewModel由淺入深

Android Jetpack ViewModel由淺入深

ViewModel簡介

存在的意義（解決痛點）

簡單使用

基礎封裝

構造器有參數的ViewModel

源碼跟蹤解讀

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美 国产 综合 欧美 视频

Android Jetpack ViewModel由淺入深

ViewModel簡介

存在的意義 （解決痛點）

簡單使用

基礎封裝

構造器有參數的ViewModel

源碼跟蹤解讀

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

存在的意義（解決痛點）