Android ViewModel的使用總結

2021-06-23 10:00:03

基本使用

MainRepository

class MainRepository {
    suspend fun getNameList(): List<String> {
        return withContext(Dispatchers.IO) {
            listOf("張三", "李四")
        }
    }
}

MainViewModel

class MainViewModel: ViewModel() {
    private val nameList = MutableLiveData<List<String>>()
    val nameListResult: LiveData<List<String>> = nameList
    private val mainRepository = MainRepository()
    
    fun getNames() {
        viewModelScope.launch {
            nameList.value = mainRepository.getNameList()
        }
    }
}

MainActivity

class MainActivity : AppCompatActivity() {
    // 建立 ViewModel 方式 1
    // 通過 kotlin 委託特性建立 ViewModel
    // 需新增依賴 implementation 'androidx.activity:activity-ktx:1.2.3'
    // viewModels() 內部也是通過 建立 ViewModel 方式 2 來建立的 ViewModel
    private val mainViewModel: MainViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate  (savedInstanceState)
        setContentView(R.layout.activity_main)
        // 建立 ViewModel 方式 2
        val mainViewModel = ViewModelProvider(this).get(MainViewModel::class.java)
        mainViewModel.nameListResult.observe(this, {
            Log.i("MainActivity", "mainViewModel: nameListResult: $it")
            Log.i("MainActivity", "MainActivity: ${this@MainActivity} mainViewModel: $mainViewModel  mainViewModel.nameListResult: ${mainViewModel.nameListResult}")
        })
        mainViewModel.getNames()
    }
}

測試步驟：開啟app -> 正常看到紀錄檔

18:03:02.575 : mainViewModel: nameListResult: [張三, 李四]
18:03:02.575 : com.yqy.myapplication.MainActivity@7ffa77 mainViewModel: com.yqy.myapplication.MainViewModel@29c0057  mainViewModel.nameListResult: androidx.lifecycle.MutableLiveData@ed0d744

接著測試步驟：開啟設定更換系統語言 -> 切換到當前app所在的任務再看紀錄檔

18:03:59.622 : mainViewModel: nameListResult: [張三, 李四]
18:03:59.622 : com.yqy.myapplication.MainActivity@49a4455 mainViewModel: com.yqy.myapplication.MainViewModel@29c0057  mainViewModel.nameListResult: androidx.lifecycle.MutableLiveData@ed0d744

神奇！MainActivity 被重建了，而 ViewModel 的範例沒有變，並且 ViewModel 物件裡的 LiveData 物件範例也沒變。這就是 ViewModel 的特性。

ViewModel 出現之前，Activity 可以使用 onSaveInstanceState() 方法儲存，然後從 onCreate() 中的 Bundle 恢復資料，但此方法僅適合可以序列化再反序列化的少量資料（IPC 對 Bundle 有 1M 的限制），而不適合數量可能較大的資料，如使用者資訊列表或點陣圖。 ViewModel 的出現完美解決這個問題。

我們先看看 ViewModel 怎麼建立的：通過上面的範例程式碼，最終 ViewModel 的建立方法是

val mainViewModel = ViewModelProvider(this).get(MainViewModel::class.java)

神奇！MainActivity 被重建了，而 ViewModel 的範例沒有變，並且 ViewModel 物件裡的 LiveData 物件範例也沒變。這就是 ViewModel 的特性。

我們先看看 ViewModel 怎麼建立的：通過上面的範例程式碼，最終 ViewModel 的建立方法是

val mainViewModel = ViewModelProvider(this).get(MainViewModel::class.java)

建立 ViewModelProvider 物件並傳入了 this 引數，然後通過 ViewModelProvider#get 方法，傳入 MainViewModel 的 class 型別，然後拿到了 mainViewModel 範例。

ViewModelProvider 的構造方法

    public ViewModelProvider(@NonNull ViewModelStoreOwner owner) {
    	// 獲取 owner 物件的 ViewModelStore 物件
        this(owner.getViewModelStore(), owner instanceof HasDefaultViewModelProviderFactory
                ? ((HasDefaultViewModelProviderFactory) owner).getDefaultViewModelProviderFactory()
                : NewInstanceFactory.getInstance());
    }

ViewModelProvider 構造方法的引數型別是 ViewModelStoreOwner ？ViewModelStoreOwner 是什麼？我們明明傳入的 MainActivity 物件呀！看看 MainActivity 的父類別們發現

public class ComponentActivity extends androidx.core.app.ComponentActivity implements
        ...
        // 實現了 ViewModelStoreOwner 介面
        ViewModelStoreOwner,
        ...{
    private ViewModelStore mViewModelStore;

	// 重寫了 ViewModelStoreOwner 介面的唯一的方法 getViewModelStore()
    @NonNull
    @Override
    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.");
        }
        ensureViewModelStore();
        return mViewModelStore;
    }

ComponentActivity 類實現了 ViewModelStoreOwner 介面。奧 ~~ 剛剛的問題解決了。

再看看剛剛的 ViewModelProvider 構造方法裡呼叫了 this(ViewModelStore, Factory)，將 ComponentActivity#getViewModelStore 返回的 ViewModelStore 範例傳了進去，並快取到 ViewModelProvider 中

    public ViewModelProvider(@NonNull ViewModelStore store, @NonNull Factory factory) {
        mFactory = factory;
        // 快取 ViewModelStore 物件
        mViewModelStore = store;
    }

接著看 ViewModelProvider#get 方法做了什麼

    @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);
    }

獲取 ViewModel 的 CanonicalName , 呼叫了另一個 get 方法

    @MainThread
    public <T extends ViewModel> T get(@NonNull String key, @NonNull Class<T> modelClass) {
    	// 從 mViewModelStore 快取中嘗試獲取
        ViewModel viewModel = mViewModelStore.get(key);
		// 命中快取
        if (modelClass.isInstance(viewModel)) {
            if (mFactory instanceof OnRequeryFactory) {
                ((OnRequeryFactory) mFactory).onRequery(viewModel);
            }
            // 返回快取的 ViewModel 物件
            return (T) viewModel;
        } else {
            //noinspection StatementWithEmptyBody
            if (viewModel != null) {
                // TODO: log a warning.
            }
        }
        // 使用工廠模式建立 ViewModel 範例
        if (mFactory instanceof KeyedFactory) {
            viewModel = ((KeyedFactory) mFactory).create(key, modelClass);
        } else {
            viewModel = mFactory.create(modelClass);
        }
        // 將建立的 ViewModel 範例放進 mViewModelStore 快取中
        mViewModelStore.put(key, viewModel);
        // 返回新建立的 ViewModel 範例
        return (T) viewModel;
    }

mViewModelStore 是啥？通過 ViewModelProvider 的構造方法知道 mViewModelStore 其實是我們 Activity 裡的 mViewModelStore 物件，它在 ComponentActivity 中被宣告。看到了 put 方法，不難猜它內部用了 Map 結構。

public class ViewModelStore {
	// 果不其然，內部有一個 HashMap
    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();
        }
    }

	// 通過 key 獲取 ViewModel 物件
    final ViewModel get(String key) {
        return mMap.get(key);
    }

    Set<String> keys() {
        return new HashSet<>(mMap.keySet());
    }

    /**
     *  Clears internal storage and notifies ViewModels that they are no longer used.
     */
    public final void clear() {
        for (ViewModel vm : mMap.values()) {
            vm.clear();
        }
        mMap.clear();
    }
}

到這兒正常情況下 ViewModel 的建立流程看完了，似乎沒有解決任何問題~ 簡單總結：ViewModel 物件存在了 ComponentActivity 的 mViewModelStore 物件中。第二個問題解決了：ViewModel 的範例快取到哪兒了

轉換思路 mViewModelStore 出現頻率這麼高，何不看看它是什麼時候被建立的呢？

記不記得剛才看 ViewModelProvider 的構造方法時，獲取 ViewModelStore 物件時，實際呼叫了 MainActivity#getViewModelStore() ，而 getViewModelStore() 實現在 MainActivity 的父類別 ComponentActivity 中。

	// ComponentActivity#getViewModelStore()
    @Override
    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.");
        }
        ensureViewModelStore();
        return mViewModelStore;
    }

在返回 mViewModelStore 物件之前呼叫了 ensureViewModelStore()

    void ensureViewModelStore() {
        if (mViewModelStore == null) {
            NonConfigurationInstances nc =
                    (NonConfigurationInstances) getLastNonConfigurationInstance();
            if (nc != null) {
                // Restore the ViewModelStore from NonConfigurationInstances
                mViewModelStore = nc.viewModelStore;
            }
            if (mViewModelStore == null) {
                mViewModelStore = new ViewModelStore();
            }
        }
    }

當 mViewModelStore == null 呼叫了 getLastNonConfigurationInstance() 獲取 NonConfigurationInstances 物件 nc，當 nc != null 時將 mViewModelStore 賦值為 nc.viewModelStore，最終 viewModelStore == null 時，才會建立 ViewModelStore 範例。

不難發現，之前建立的 viewModelStore 物件被快取在 NonConfigurationInstances 中

	// 它是 ComponentActivity 的靜態內部類
    static final class NonConfigurationInstances {
        Object custom;
        // 果然在這兒
        ViewModelStore viewModelStore;
    }

不難發現，之前建立的 viewModelStore 物件被快取在 NonConfigurationInstances 中

	// 它是 ComponentActivity 的靜態內部類
    static final class NonConfigurationInstances {
        Object custom;
        // 果然在這兒
        ViewModelStore viewModelStore;
    }

NonConfigurationInstances 物件通過 getLastNonConfigurationInstance() 來獲取的

	// Activity#getLastNonConfigurationInstance
    /**
     * Retrieve the non-configuration instance data that was previously
     * returned by {@link #onRetainNonConfigurationInstance()}.  This will
     * be available from the initial {@link #onCreate} and
     * {@link #onStart} calls to the new instance, allowing you to extract
     * any useful dynamic state from the previous instance.
     *
     * <p>Note that the data you retrieve here should <em>only</em> be used
     * as an optimization for handling configuration changes.  You should always
     * be able to handle getting a null pointer back, and an activity must
     * still be able to restore itself to its previous state (through the
     * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this
     * function returns null.
     *
     * <p><strong>Note:</strong> For most cases you should use the {@link Fragment} API
     * {@link Fragment#setRetainInstance(boolean)} instead; this is also
     * available on older platforms through the Android support libraries.
     *
     * @return the object previously returned by {@link #onRetainNonConfigurationInstance()}
     */
    @Nullable
    public Object getLastNonConfigurationInstance() {
        return mLastNonConfigurationInstances != null
                ? mLastNonConfigurationInstances.activity : null;
    }

好長一段註釋，大概意思有幾點：

onRetainNonConfigurationInstance 方法和 getLastNonConfigurationInstance 是成對出現的，跟 onSaveInstanceState 機制類似，只不過它是僅用作處理設定更改的優化。
返回的是 onRetainNonConfigurationInstance 返回的物件

onRetainNonConfigurationInstance 和 getLastNonConfigurationInstance 的呼叫時機在本篇文章不做贅述，後續文章會進行解釋。

看看 onRetainNonConfigurationInstance 方法

	/**
	* 保留所有適當的非設定狀態
	*/
    @Override
    @Nullable
    @SuppressWarnings("deprecation")
    public final Object onRetainNonConfigurationInstance() {
        // Maintain backward compatibility.
        Object custom = onRetainCustomNonConfigurationInstance();

        ViewModelStore viewModelStore = mViewModelStore;
        // 若 viewModelStore 為空，則嘗試從 getLastNonConfigurationInstance() 中獲取
        if (viewModelStore == null) {
            // No one called getViewModelStore(), so see if there was an existing
            // ViewModelStore from our last NonConfigurationInstance
            NonConfigurationInstances nc =
                    (NonConfigurationInstances) getLastNonConfigurationInstance();
            if (nc != null) {
                viewModelStore = nc.viewModelStore;
            }
        }
		// 依然為空，說明沒有需要快取的，則返回 null
        if (viewModelStore == null && custom == null) {
            return null;
        }
		
		// 建立 NonConfigurationInstances 物件，並賦值 viewModelStore
        NonConfigurationInstances nci = new NonConfigurationInstances();
        nci.custom = custom;
        nci.viewModelStore = viewModelStore;
        return nci;
    }

到這兒我們大概明白了，Activity 在因設定更改而銷燬重建過程中會先呼叫 onRetainNonConfigurationInstance 儲存 viewModelStore 範例。在重建後可以通過 getLastNonConfigurationInstance 方法獲取之前的 viewModelStore 範例。

現在解決了第一個問題：為什麼Activity旋轉螢幕後ViewModel可以恢復資料

再看第三個問題：什麼時候 ViewModel#onCleared() 會被呼叫

public abstract class ViewModel {
    protected void onCleared() {
    }

    @MainThread
    final void clear() {
        mCleared = true;
        // Since clear() is final, this method is still called on mock objects
        // and in those cases, mBagOfTags is null. It'll always be empty though
        // because setTagIfAbsent and getTag are not final so we can skip
        // clearing it
        if (mBagOfTags != null) {
            synchronized (mBagOfTags) {
                for (Object value : mBagOfTags.values()) {
                    // see comment for the similar call in setTagIfAbsent
                    closeWithRuntimeException(value);
                }
            }
        }
        onCleared();
    }
}

onCleared() 方法被 clear() 呼叫了。剛才看 ViewModelStore 原始碼時好像是呼叫了 clear() ，回顧一下：

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());
    }

    /**
     *  Clears internal storage and notifies ViewModels that they are no longer used.
     */
    public final void clear() {
        for (ViewModel vm : mMap.values()) {
            vm.clear();
        }
        mMap.clear();
    }
}

onCleared() 方法被 clear() 呼叫了。剛才看 ViewModelStore 原始碼時好像是呼叫了 clear() ，回顧一下：

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());
    }

    /**
     *  Clears internal storage and notifies ViewModels that they are no longer used.
     */
    public final void clear() {
        for (ViewModel vm : mMap.values()) {
            vm.clear();
        }
        mMap.clear();
    }
}

在 ViewModelStore 的 clear() 中，遍歷 mMap 並呼叫 ViewModel 物件的 clear() ，再看 ViewModelStore 的 clear() 什麼時候被呼叫的：

	// ComponentActivity 的構造方法
    public ComponentActivity() {
        ... 
        getLifecycle().addObserver(new LifecycleEventObserver() {
            @Override
            public void onStateChanged(@NonNull LifecycleOwner source,
                    @NonNull Lifecycle.Event event) {
                if (event == Lifecycle.Event.ON_DESTROY) {
                    // Clear out the available context
                    mContextAwareHelper.clearAvailableContext();
                    // And clear the ViewModelStore
                    if (!isChangingConfigurations()) {
                        getViewModelStore().clear();
                    }
                }
            }
        });
        ...
    }

觀察當前 activity 生命週期，當 Lifecycle.Event == Lifecycle.Event.ON_DESTROY，並且 isChangingConfigurations() 返回 false 時才會呼叫 ViewModelStore#clear 。

	// Activity#isChangingConfigurations()
    /**
     * Check to see whether this activity is in the process of being destroyed in order to be
     * recreated with a new configuration. This is often used in
     * {@link #onStop} to determine whether the state needs to be cleaned up or will be passed
     * on to the next instance of the activity via {@link #onRetainNonConfigurationInstance()}.
     *
     * @return If the activity is being torn down in order to be recreated with a new configuration,
     * returns true; else returns false.
     */
    public boolean isChangingConfigurations() {
        return mChangingConfigurations;
    }

isChangingConfigurations 用來檢測當前的 Activity 是否因為 Configuration 的改變被銷燬了, 設定改變返回 true，非設定改變返回 false。

總結，在 activity 銷燬時，判斷如果是非設定改變導致的銷燬， getViewModelStore().clear() 才會被呼叫。

第三個問題：什麼時候 ViewModel#onCleared() 會被呼叫解決！

以上就是Android ViewModel的使用總結的詳細內容，更多關於Android ViewModel的使用的資料請關注it145.com其它相關文章！

Android ViewModel的使用總結

目錄

基本使用

MainRepository

MainViewModel

MainActivity

熱門文章