一、前言

本篇文章主要涉及以下三個問題：

• ViewModel 在 Activity 發生旋轉等配置發生變化所導致的重建，能恢復資料嗎？
• 如果 1 能，從原始碼角度分析，資料存在哪？怎麼儲存的？怎麼讀取的？
• 當 Activity 切換到後臺，被系統殺死（程序存活），此時回到 Activity 導致的重建，ViewModel 的資料能恢復嗎？為什麼？

作者

付十一

二、案例解答

首先我們來看一下問題一：ViewModel在Activity發生旋轉重建時，能恢復資料嗎？

舉個栗子。

我們建立一個ViewModel，內部管理一個Int型資料，並且使用者在介面點選按鈕就開始進行自增操作，使用LiveData通知UI更新資料。

class ViewModelTest : ViewModel() {
    val countLiveData = MutableLiveData<Int>()
    var count: Int = 0
    fun addCount() {
        count++
        countLiveData.postValue(count)
    }
}

UI則只有一個TextView和一個Button，TextView展示資料，Button進行數字自增操作，LiveData對資料進行觀察。

val viewModel = ViewModelProvider(this).get(ViewModelTest::class.java)

viewModel.countLiveData.observe(this, object : Observer<Int> {
    override fun onChanged(t: Int?) {
        text.text = t?.toString()
    }
})

findViewById<Button>(R.id.bt_add).setOnClickListener {
    viewModel.addCount()
}
 

準備好後便開始驗證：

從上面視訊可以看到，當手機橫豎屏切換時，Activity會發生重建，但資料並沒有重新更新。

所以對於問題一，答案顯而易見，ViewModel在Activity發生旋轉等配置發生變化所導致的重建，可以恢復資料。

三、原理解析

第二節從案例出發找到了答案，但為什麼ViewModel可以恢復資料，資料存在哪？怎麼儲存的？怎麼讀取的？ 這就要開始去原始碼裡一探究竟。

首先我們想一下，研究的目的是為了瞭解ViewModel的資料為什麼沒有被清除掉，ViewModel是儲存資料的地方，既然資料沒變，那麼必然在橫豎屏切換時，ViewModel的例項也是沒有變的。那麼就可以從橫豎屏後是怎麼獲取ViewModel例項的角度來入手，也就是ViewModel的建立。

val viewModel = ViewModelProvider(this).get(ViewModelTest::class.java)

ViewModel的建立很簡單，一共兩步，第一步 ViewModelProvider(this) 例項化了ViewModelProvider物件，第二步get() 就是利用該ViewModelProvider根據viewModel類直接拿或者建立ViewModel例項。

建立ViewModel的重點在get()方法裡，直接看：

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

    if (mFactory instanceof KeyedFactory) {
        viewModel = ((KeyedFactory) mFactory).create(key, modelClass);
    } else {
        viewModel = mFactory.create(modelClass);
    }
    mViewModelStore.put(key, viewModel);
    return (T) viewModel;
}

第一句就發現ViewModel物件是從ViewModelStore里根據key拿出來的。接著就開始拿著這個ViewModel物件和開發者傳進的viewModel物件進行比較，如果一致，則就直接返回ViewModelStore裡的viewModel，反之，則重新建立ViewModel，並且將新ViewModel物件儲存到ViewModelStore中。

看到這是不是有點快取內味，先從快取裡拿資料，如果有資料就返回，如果快取裡沒有就重新建立資料，並且將資料put到快取中。

這裡有個類：ViewModelStore ，是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());
    }

    /**
     *  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是儲存ViewModel的類，內部其實實現了一個HashMap，根據key拿ViewModel例項。在手機橫豎屏Activity重建時，因為ViewModelStore之前儲存了該ViewModel物件，重建後就直接取出來了。ViewModel的例項沒變，資料也就可以再次恢復。

瞭解了ViewModel物件是儲存在ViewModelStore中，那ViewModelStore又是從哪裡建立的？

是否還記得在UI層建立ViewModel時分為兩步，還有第一步ViewModelProvider(this)沒有分析，而ViewModelStore的建立就是在這個方法中，直接跟到建立的地方。

#ComponentActivity

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) {
            // Restore the ViewModelStore from NonConfigurationInstances
            mViewModelStore = nc.viewModelStore;
        }
        if (mViewModelStore == null) {
            mViewModelStore = new ViewModelStore();
        }
    }
    return mViewModelStore;
}

在ComponentActivity裡實現了ViewModelStore的建立。可以看到一開始在mViewModelStore等於null時，則先獲取了NonConfigurationInstances物件。

static final class NonConfigurationInstances {
    Object custom;
    ViewModelStore viewModelStore;
}

NonConfigurationInstances是用來儲存ViewModelStore的一個類。當NonConfigurationInstances物件不為null時，先直接從NonConfigurationInstances拿ViewModelStore，如果拿不到則就直接new 一個ViewModelStore物件。這就是獲取ViewModelStore的過程。

這裡有一個NonConfigurationInstances ，其物件是由呼叫getLastNonConfigurationInstance()獲取，而getLastNonConfigurationInstance所返回的例項是由 onRetainNonConfigurationInstance返回的。

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

    ViewModelStore viewModelStore = mViewModelStore;
    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;
        }
    }

    if (viewModelStore == null && custom == null) {
        return null;
    }

    NonConfigurationInstances nci = new NonConfigurationInstances();
    nci.custom = custom;
    nci.viewModelStore = viewModelStore;
    return nci;
}

首先提一點，onRetainNonConfigurationInstance的觸發是在手機橫豎屏時，處於onStop和onDestory之間。

從原始碼裡看它的作用就是將viewModelStore儲存到NonConfigurationInstances中。 也就是在Activity銷燬之前，就把viewModelStore儲存起來了

和前面相結合，一切都說得通了。我們再來捋一捋viewModel儲存、恢復資料的過程。

1. 第一次建立ViewModel時，ViewModelStore利用HashMap將新建立的ViewModel物件儲存了起來；

2. 在手機橫豎屏時，Activity被銷燬之前，會觸發onRetainNonConfigurationInstance，對ViewModelStore進行儲存；

3. Activity重建後，Activity會重新走onCreate生命週期，並且會再次去獲取ViewModel物件。而這次ViewModel的獲取與第一次建立不同，它會通過ViewModelStoreOwner先獲取該Activity重建之前所儲存的ViewModelStore，接著在ViewModelStore中根據Key，找到重建之前的ViewModel，進而恢復資料。

四、Activity切換到後臺，被系統殺，ViewModel能否恢復資料？

這個問題還是以案例的形式模擬一下。還是第一節的例子，只不過在模擬器設定裡將後臺程序設定為 ‘不允許後臺程序’，當我們將app回到後臺後發現，此時並沒有觸發onRetainNonConfigurationInstance。

我們從上面的原理解析就知道，onRetainNonConfigurationInstance是Activity銷燬前儲存ViewModel的關鍵。被系統殺死，沒有觸發它，也就無法儲存ViewModel，無法恢復資料。

Android高階開發系統進階筆記、最新面試複習筆記PDF，我的GitHub

文末

您的點贊收藏就是對我最大的鼓勵！
歡迎關注我分享Android乾貨，交流Android技術。
對文章有何見解，或者有何技術問題，歡迎在評論區一起留言討論！