2. 程式人生 > >剖析 Android 架構元件之 ViewModel

剖析 Android 架構元件之 ViewModel

阿新 • • 發佈：2018-11-15

ViewModel 是 Android 架構元件之一，用於分離 UI 邏輯與 UI 資料。在發生 Configuration Changes 時，它不會被銷燬。在介面重建後，方便開發者呈現介面銷燬前的 UI 狀態。

本文主要分析 ViewModel 的以下3個方面：

  • 獲取和建立過程。
  • Configuration Changes 存活原理。
  • 銷燬過程。

1. 依賴庫

implementation "androidx.fragment:fragment:1.0.0"
implementation "androidx.lifecycle:lifecycle-viewmodel:2.0.0"
 

implementation "androidx.lifecycle:lifecycle-extensions:2.0.0"
複製程式碼

2. 主要類與介面

import androidx.fragment.app.Fragment;
import androidx.fragment.app.FragmentActivity;
import androidx.lifecycle.ViewModel;
import androidx.lifecycle.AndroidViewModel;
import androidx.lifecycle.ViewModelProvider;
import androidx.lifecycle.ViewModelProvider.Factory;
import
 
 androidx.lifecycle.ViewModelProviders;
import androidx.lifecycle.ViewModelStore;
import androidx.lifecycle.ViewModelStoreOwner;
複製程式碼

3. ViewModel

ViewModel 是一個抽象類，類中只定義了一個空實現的 onCleared() 方法。

public abstract class ViewModel {
    /**
     * This method will be called when this ViewModel is no longer used and will be destroyed.
     * <p>
     * It is useful when ViewModel observes some data and you need to clear this subscription to
     * prevent a leak of this ViewModel.
     */
 

    @SuppressWarnings("WeakerAccess")
    protected void onCleared() {
    }
}
複製程式碼

3.1 AndroidViewModel

AndroidViewModel 類擴充套件了 ViewModel 類，增加了 Application 欄位，在構造方法初始化，並提供了 getApplication() 方法。

public class AndroidViewModel extends ViewModel {
    private Application mApplication;

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

    /**
     * Return the application.
     */
    @NonNull
    public <T extends Application> T getApplication() {
        return (T) mApplication;
    }
}
複製程式碼

4. 獲取和建立過程分析

獲取 ViewModel 物件程式碼如下：

ViewModelProviders.of(activityOrFragment).get(ViewModel::class.java)
複製程式碼

4.1 ViewModelProviders

ViewModelProviders 類提供了4個靜態工廠方法 of() 建立新的 ViewModelProvider 物件。

ViewModelProviders.of(Fragment)
ViewModelProviders.of(FragmentActivity)
ViewModelProviders.of(Fragment, Factory)
ViewModelProviders.of(FragmentActivity, Factory)
複製程式碼

4.2 ViewModelProvider

ViewModelProvider 負責提供 ViewModel 物件，類中定義了以下兩個欄位：

private final Factory mFactory;
private final ViewModelStore mViewModelStore;
複製程式碼

先說說這兩個類的功能。

4.3 ViewModelProvider.Factory

Factory 介面定義了一個建立 ViewModel 的介面 create()，ViewModelProvider 在需要時呼叫該方法新建 ViewModel 物件。

public interface Factory {
    <T extends ViewModel> T create(@NonNull Class<T> modelClass);
}
複製程式碼

Android 已經內建了2個 Factory 實現類，分別是：

  • AndroidViewModelFactory 實現類，可以建立 ViewModel 和 AndroidViewModel 子類物件。
  • NewInstanceFactory 類，只可以建立 ViewModel 子類物件。

它們的實現都是通過反射機制呼叫 ViewModel 子類的構造方法建立物件。

public static class NewInstanceFactory implements Factory {
    @Override
    public <T extends ViewModel> T create(Class<T> modelClass) {
        try {
            return modelClass.newInstance();
        } catch (InstantiationException e) {
            throw new RuntimeException("Cannot create an instance of " + modelClass, e);
        } catch (IllegalAccessException e) {
            throw new RuntimeException("Cannot create an instance of " + modelClass, e);
        }
    }
}
複製程式碼

AndroidViewModelFactory 繼承 NewInstanceFactory 類，是個單例，支援建立 AndroidViewModel 子類物件。

public static class AndroidViewModelFactory extends ViewModelProvider.NewInstanceFactory {

    private static AndroidViewModelFactory sInstance;

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

    private Application mApplication;

    public AndroidViewModelFactory(Application application) {
        mApplication = application;
    }

    @Override
    public <T extends ViewModel> T create(Class<T> modelClass) {
        if (AndroidViewModel.class.isAssignableFrom(modelClass)) {
            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);
    }
}
複製程式碼

4.4 ViewModelStore

ViewModelStore 類中維護一個 Map<String, ViewModel> 物件儲存已建立的 ViewModel 物件，並提供 put() 和 get() 方法。

public class ViewModelStore {
    private final HashMap<String, ViewModel> mMap = new HashMap<>();
    
    final void put(String key, ViewModel viewModel) {
        ViewModel oldViewModel = mMap.put(key, viewModel);
    }

    final ViewModel get(String key) {
        return mMap.get(key);
    }
}
複製程式碼

4.5 ViewModelStoreOwner

ViewModelStore 是來自於 FragmentActivity 和 Fragment，它們實現了 ViewModelStoreOwner 介面，返回當前 UI 作用域裡的 ViewModelStore 物件。

public interface ViewModelStoreOwner {
    ViewModelStore getViewModelStore();
}
複製程式碼

在 Fragment 類中的實現如下：

public ViewModelStore getViewModelStore() {
    if (getContext() == null) {
        throw new IllegalStateException("Can't access ViewModels from detached fragment");
    }
    if (mViewModelStore == null) {
        mViewModelStore = new ViewModelStore();
    }
    return mViewModelStore;
}
複製程式碼

在 FragmentActivity 類中的實現如下：

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) {
        mViewModelStore = new ViewModelStore();
    }
    return mViewModelStore;
}
複製程式碼

4.6 建立 ViewModelProvider

回到 of() 方法的實現。

public static ViewModelProvider of(FragmentActivity activity, Factory factory) {
    Application application = checkApplication(activity);
    if (factory == null) {
        factory = ViewModelProvider.AndroidViewModelFactory.getInstance(application);
    }
    return new ViewModelProvider(activity.getViewModelStore(), factory);
}
複製程式碼

在建立 ViewModelProvider 物件時需要傳入 ViewModelStore 和 Factory 物件。若 factory 為 null，將使用 AndroidViewModelFactory 單例物件。

4.7 獲取 ViewModel 物件

呼叫 ViewModelProvider 物件的 get() 方法獲取 ViewModel 物件，如果在 ViewModelStore 裡不存在，則使用 Factory 建立一個新的物件並存放到 ViewModelStore 裡。

public <T extends ViewModel> T get(String key, Class<T> modelClass) {
    ViewModel viewModel = mViewModelStore.get(key);

    if (modelClass.isInstance(viewModel)) {
        return (T) viewModel;
    }

    viewModel = mFactory.create(modelClass);
    mViewModelStore.put(key, viewModel);

    return (T) viewModel;
}
複製程式碼

5. Configuration Changes 存活原理

當 Activity 或 Fragment 被系統重建時，ViewModel 物件不會被銷燬，新的 Activity 或 Fragment 物件拿到的是同一個 ViewModel 物件。

在 FragmentActivity#onRetainNonConfigurationInstance() 方法中，會將 ViewModelStore 物件保留起來。

public final Object onRetainNonConfigurationInstance() {
    Object custom = onRetainCustomNonConfigurationInstance();

    FragmentManagerNonConfig fragments = mFragments.retainNestedNonConfig();

    if (fragments == null && mViewModelStore == null && custom == null) {
        return null;
    }

    NonConfigurationInstances nci = new NonConfigurationInstances();
    nci.custom = custom;
    nci.viewModelStore = mViewModelStore;
    nci.fragments = fragments;
    return nci;
}
複製程式碼

然後在 onCreate() 方法能獲取之前保留起來的 ViewModelStore 物件。

protected void onCreate(Bundle savedInstanceState) {
    mFragments.attachHost(null /*parent*/);
    super.onCreate(savedInstanceState);

    NonConfigurationInstances nc = (NonConfigurationInstances) getLastNonConfigurationInstance();
    if (nc != null) {
        mViewModelStore = nc.viewModelStore;
    }
    // ...
}
複製程式碼

那 Fragment 作用域裡是如何實現的呢？在 FragmentActivity 的 onRetainNonConfigurationInstance() 方法中裡有這樣一句程式碼：

FragmentManagerNonConfig fragments = mFragments.retainNestedNonConfig();
複製程式碼

實現保留的機制是一樣的，只不過放在 FragmentManagerNonConfig 物件中。是在 FragmentManager#saveNonConfig() 方法中將 ViewModelStore 物件儲存到 FragmentManagerNonConfig 裡的。

void saveNonConfig() {
    ArrayList<Fragment> fragments = null;
    ArrayList<FragmentManagerNonConfig> childFragments = null;
    ArrayList<ViewModelStore> viewModelStores = null;
    if (mActive != null) {
        for (int i=0; i<mActive.size(); i++) {
            Fragment f = mActive.valueAt(i);
            if (f != null) {
                if (f.mRetainInstance) {
                    if (fragments == null) {
                        fragments = new ArrayList<Fragment>();
                    }
                    fragments.add(f);
                    f.mTargetIndex = f.mTarget != null ? f.mTarget.mIndex : -1;
                    if (DEBUG) Log.v(TAG, "retainNonConfig: keeping retained " + f);
                }
                FragmentManagerNonConfig child;
                if (f.mChildFragmentManager != null) {
                    f.mChildFragmentManager.saveNonConfig();
                    child = f.mChildFragmentManager.mSavedNonConfig;
                } else {
                    // f.mChildNonConfig may be not null, when the parent fragment is
                    // in the backstack.
                    child = f.mChildNonConfig;
                }

                if (childFragments == null && child != null) {
                    childFragments = new ArrayList<>(mActive.size());
                    for (int j = 0; j < i; j++) {
                        childFragments.add(null);
                    }
                }

                if (childFragments != null) {
                    childFragments.add(child);
                }
                if (viewModelStores == null && f.mViewModelStore != null) {
                    viewModelStores = new ArrayList<>(mActive.size());
                    for (int j = 0; j < i; j++) {
                        viewModelStores.add(null);
                    }
                }

                if (viewModelStores != null) {
                    viewModelStores.add(f.mViewModelStore);
                }
            }
        }
    }
    if (fragments == null && childFragments == null && viewModelStores == null) {
        mSavedNonConfig = null;
    } else {
        mSavedNonConfig = new FragmentManagerNonConfig(fragments, childFragments,
        viewModelStores);
    }
}
複製程式碼

該方法的呼叫順序是：FragmentActivity#onSaveInstanceState() -> FragmentManager#saveAllState() -> FragmentManager#saveNonConfig()。

6. 銷燬過程

在 FragmentActivity 類的 onDestory() 方法中。

@Override
protected void onDestroy() {
    super.onDestroy();
    if (mViewModelStore != null && !isChangingConfigurations()) {
        mViewModelStore.clear();
    }
    mFragments.dispatchDestroy();
}
複製程式碼

在 Fragment 類的 onDestory() 方法中。

public void onDestroy() {
    mCalled = true;
    FragmentActivity activity = getActivity();
    boolean isChangingConfigurations = activity != null && activity.isChangingConfigurations();
    if (mViewModelStore != null && !isChangingConfigurations) {
        mViewModelStore.clear();
    }
}
複製程式碼

先判斷是否有發生 Configuration Changes，如果沒有則會呼叫 ViewModelStore 的 clear() 方法，再一一呼叫每一個 ViewModel 的 onCleared() 方法。

public final void clear() {
    for (ViewModel vm : mMap.values()) {
        vm.onCleared();
    }
    mMap.clear();
}
複製程式碼

7. 總結

以上便是 ViewModel 3個主要過程的剖析，這裡做一下總結。

  • 通過 ViewModelProviders 建立 ViewModelProvider 物件，呼叫該物件的 get() 方法獲取 ViewModel 物件。 當 ViewModelStore 裡不存在想要的物件，ViewModelProvider 會使用 Factory 新建一個物件並存放到 ViewModelStore 裡。
  • 當發生 發生 Configuration Changes 時，FragmentActivity 利用 getLastNonConfigurationInstance()、onRetainNonConfigurationInstance() 方法實現 ViewModelStore 的保留與恢復，進而實現 ViewModel 物件的保活。
  • 當 FragmentActivity 和 Fragment 被銷燬時，會根據是否發生 Configuration Changes 來決定是否銷燬 ViewModel。

相關推薦

剖析 Android 架構元件之 ViewModel

ViewModel 是 Android 架構元件之一，用於分離 UI 邏輯與 UI 資料。在發生 Configuration Changes 時，它不會被銷燬。在介面重建後，方便開發者呈現介面銷燬前的 UI 狀態。 本文主要分析 ViewModel 的以下3個方面： 獲取和建立過程。 Confi

Android Jetpack架構元件之 Paging（使用、原始碼篇）

1、前言 最近簡單看了下google推出的框架Jetpack，感覺此框架的內容可以對平時的開發有很大的幫助，也可以解決很多開發中的問題，對程式碼的資料邏輯和UI介面深層解耦，實現資料驅動型的ui。 Android Architecture元件是Android Jetpac

深入剖析Android四大元件(九)——Activity之AppCompatActivity與toolbar的結合

對於技術類的部落格，我們永遠追尋最新API腳步，在API22之前我們使用標題欄基本都是在ActionBarActivity的Activity中處理的，而API22之後，谷歌遺棄了ActionBarActivity，推薦我們也可以說是強制我們使用AppCompatActivit

Android 官方架構元件之 Lifecycle的學習

Lifecycle:官方介紹 Lifecycle is a class that holds the information about the lifecycle state of a component (like an activity or a fragment) and all

Android Jetpack架構元件之 Lifecycle（原始碼篇）

一、前言 最近簡單看了下google推出的框架Jetpack，感覺此框架的內容可以對平時的開發有很大的幫助，也可以解決很多開發中的問題，對程式碼的邏輯和UI介面實現深層解耦，打造資料驅動型UI介面。 Android Architecture元件是Android Jetpa

Android架構師之路 網絡層架構設計與實戰

安卓 第1章 課前須知介紹如何去學習，課程適合的人群、怎麽才能融會貫通第2章 主流網絡框架分析常用網絡框架介紹，分析volley 、Android-async-http、Afinal框架、xUtils、okhttp、retrofit、優有點缺點、教會選擇一個框架的標準是什麽？第3章 http協議詳解介紹htt

Android控制元件之LabelView

          最近研究android控制元件開發，學習無捷徑，逛github，看到一個LabelView的demo,感覺還是挺不錯，也比較實用，所以拿來學習了一下。         附上源專案的地址：

Android控制元件之圓形進度條

Android-自定義ProgressBar實現圓弧進度條 在之前的專案中用到過這個,感覺還是非常實用的,我實現的是額度的增長. 繼承於ProgressBar實現，保留了Progressbar的特性，原始碼在文尾。

Android 四大元件之Service的啟動、繫結小述

一、概述 學習過Android的小夥伴就不可能不知道Service是什麼，因為Service是Android四大元件之一，聲名赫赫有木有，所以在這裡我就不詳細介紹了，本節主要還是充當筆記的作用，因為我待記性如初戀，記性虐我千百遍。 二、Service的建立 Service是一

Android 四大元件之——Service(一)

一、什麼是服務        服務，是Android四大元件之一， 屬於 計算型元件。   長期後臺執行的沒有介面的元件 ，特點是無使用者介面、在後臺執行、生命週期長 二，什麼時候使用服務？  

Android 四大元件之——Acitivity(四) Activity是如何載入顯示內容的？

1. 在Activity呼叫onCreate（）等生命週期之前，Activity會呼叫attach()方法，而在attach（）方法中會呼叫如下程式碼 onAttach() { PolicyManager.makeNewWindow(this) }而makeNewWindow實際

Android 四大元件之——Acitivity(三) 深入瞭解Activity的啟動流程

上圖為整個Activity的啟動流程 接下來我們大概分析  在我們的Android系統中，應用程式是由Launcher這個應用啟動起來的。當我們安裝好應用程式之後，就會在Launcher的介面上生成一個圖示，我們點選圖示時Launch就會啟動我們的應用程式。 1.點選

Android 四大元件之——Acitivity(二) 啟動模式

Activity的啟動模式共有4種 分別為   standard、singleTop、singleTask、singleInstance ； 四種啟動模式的配置都在Manifest檔案中配置，配置模板為 <activity

Android 四大元件之——Acitivity(一)

一，什麼是Activity activity是Android元件中最基本也是最為常見用的四大元件之一。Android四大元件有Activity，Service服務，Content Provider內容提供，BroadcastReceiver廣播接收器。 Activity中所有操作都與使用

Android--四大元件之BroadCastReceiver（生命週期、實現原理及使用等）

####1. BroadCastReceiver是什麼？ ####2. 廣播型別 ######1). 有序廣播 ######2). 無序廣播 ####3. 生命週期 ####4. 實現原理 ####5. 使用方法 ####6. 許可權問題(安全性) ####7. LocalBroad

Android--四大元件之Service

####1. Service是什麼？ ####2. 啟動方式 ######1). 差異 ######2). 關聯 ####3. 生命週期 ######1). startService ######2). bindService ####4.本地服務與遠端服務 ####5.Intent

Android--四大元件之Activity（一）

####1. Activity是什麼？ ####2. 生命週期 ######1). Activity跳轉 ######2). 從後臺啟動 ######3). 橫豎屏切換 ####3. 啟動模式 ######1). 任務棧 ######2). laucherMode ######3).

Android四大元件之ContentProvider（二）

上節提到的四大元件之ContentProvider的簡單使用，在這篇文章中詳細的介紹其中的一些方法。 1.String getType(Uri uri)方法 首先看看官方對它的解釋： /** * Implement this to handle requests

Android四大元件之ContentProvider（一）

1.什麼是ContentProvider? 內容提供程式管理對資料結構化資料集的訪問。它們封裝資料，並提供用於定義資料安全性的機制。內容提供者是連線一個程序中的資料與另一個程序中執行的程式碼的標準介面。 是不同應用程式之間進行資料交換的標準API，以某種Uri的形式對外提供資料，

Android控制元件之ListView（初識）

ListView 控制元件可使用四種不同檢視顯示專案。通過此控制元件，可將專案組成帶有或不帶有列標頭的列，並顯示伴隨的圖示和文字。 ListView有四種模式： 其作用是新增選擇按鈕框。 設定單選框 Lv.setChoiceMode(ListView.CHOICE_MOD