ViewModel

我們都知道ViewModel在配置更改的時候,可以保存數(shù)據(jù)而不被銷毀,這是怎么做到的呢?今天我們來見證一下。

我們可以想一下,如果我們要自己實現(xiàn)數(shù)據(jù)在配置更改后,不會銷毀,我們會怎么做,那首先我們肯定要知道配置更改的時機,然后把數(shù)據(jù)存儲起來,然后重建后在把數(shù)據(jù)取出來。那我們?nèi)绾沃琅渲酶牧四兀肯到y(tǒng)已經(jīng)提供了,在Activity中重寫以下兩個方法即可。

//配置更改時會調(diào)用該方法
override fun onRetainCustomNonConfigurationInstance(): Any? {
        return super.onRetainCustomNonConfigurationInstance()
    }

//獲取配置
override fun getLastNonConfigurationInstance(): Any? {
        return super.getLastNonConfigurationInstance()
    }

明確了上面這個信息后,我們繼續(xù)往下看,看源碼最直接一種方式就是通過使用的api進行查看,我們先看下ViewModel的使用

//這是我們常用獲取ViewModel的方式
ViewModelProvider(this).get(TestViewModel :: class.java)

public ViewModelProvider(@NonNull ViewModelStoreOwner owner) {
        this(owner.getViewModelStore(), owner instanceof HasDefaultViewModelProviderFactory
                ? ((HasDefaultViewModelProviderFactory) owner).getDefaultViewModelProviderFactory()
                : NewInstanceFactory.getInstance());
    }

//最終調(diào)用到
public ViewModelProvider(@NonNull ViewModelStore store, @NonNull Factory factory) {
        mFactory = factory;
        //記住這個ViewModelStore類型變量
        mViewModelStore = store;
    }

//然后我們看get方法做了什么
 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");
        }
        //以name+DEFAULT_KEY和class對象作為參數(shù),調(diào)用重載方法
        return get(DEFAULT_KEY + ":" + canonicalName, modelClass);
    }

 public <T extends ViewModel> T get(@NonNull String key, @NonNull Class<T> modelClass) {
        //這里先通過mViewModelStore去獲取ViewModel對象
        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.
            }
        }
        //這里通過反射創(chuàng)建ViewModel對象 具體細節(jié)就不看了
        if (mFactory instanceof KeyedFactory) {
            viewModel = ((KeyedFactory) mFactory).create(key, modelClass);
        } else {
            viewModel = mFactory.create(modelClass);
        }
        //存儲到mViewModelStore
        mViewModelStore.put(key, viewModel);
        return (T) viewModel;
    }

在上面的代碼中,我們發(fā)現(xiàn)了ViewModel在創(chuàng)建后會被存儲到mViewModelStore對象中,那么是不是數(shù)據(jù)可以恢復的秘密就在這里呢?答案是確實如此,下面我們看看具體是怎么恢復的。

首先我們看下ViewModelStore是個什么東東

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() {
        //循環(huán)遍歷調(diào)用ViewModel的clear()
        for (ViewModel vm : mMap.values()) {
            vm.clear();
        }
        mMap.clear();
    }
}

我們發(fā)現(xiàn)ViewModelStore其實就是HashMap,下面我們看下mViewModelStore是怎么獲取到的。在上面的代碼我們可以知道是mViewModelStore通過owner.getViewModelStore()獲取的,而getViewModelStore其實調(diào)用的就是ComponentActivity的getViewModelStore()方法,下面我們看下代碼

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

    void ensureViewModelStore() {
        if (mViewModelStore == null) {
            //上面我們說過getLastNonConfigurationInstance是獲取配置的方法
            NonConfigurationInstances nc =
                    (NonConfigurationInstances) getLastNonConfigurationInstance();
            //如果配置不為空,那么通過NonConfigurationInstances獲取viewModelStore
            if (nc != null) {
                // Restore the ViewModelStore from NonConfigurationInstances
                mViewModelStore = nc.viewModelStore;
            }
           //第一次的時候沒有配置過肯定會走這里 直接進行創(chuàng)建
            if (mViewModelStore == null) {
                mViewModelStore = new ViewModelStore();
            }
        }
    }

下面我們看下NonConfigurationInstances這個對象是個什么東東。

//ComponentActivity中聲明的
static final class NonConfigurationInstances {
        //我們自己在配置更改時存儲數(shù)據(jù)使用
        Object custom;
        //找到你了吧
        ViewModelStore viewModelStore;
    }

我們已經(jīng)找到了數(shù)據(jù)恢復的時機了,那么我們下面就要看看數(shù)據(jù)是何時存儲的了,我們直接看onRetainCustomNonConfigurationInstance()方法,上面說過了這里是配置更改會調(diào)用的地方。

//ComponentActivity
public final Object onRetainNonConfigurationInstance() {
        // 我們可以重寫這個方法,在配置更改時,存儲我們需要存儲的數(shù)據(jù)
        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;
        }
        
        /**
        *創(chuàng)建NonConfigurationInstances對象,保存了viewModelStore
        *通過getLastNonConfigurationInstance就可以獲取到了
        */
        NonConfigurationInstances nci = new NonConfigurationInstances();
        nci.custom = custom;
        nci.viewModelStore = viewModelStore;
        return nci;
    }

這里其實就已經(jīng)保存好數(shù)據(jù)了,只不過時AMS通過binder調(diào)用保存的,這里不看具體的保存流程了,我們在看下getLastNonConfigurationInstance方法

//Activity中
 @Nullable
    public Object getLastNonConfigurationInstance() {
        return mLastNonConfigurationInstances != null
                ? mLastNonConfigurationInstances.activity : null;
    }

上面保存的時候其實就是保存到mLastNonConfigurationInstances這個對象中了

最后我們總結下整體的流程和思想:
主要是通過onRetainNonConfigurationInstance方法在配置更改時,保存viewModelStore到mLastNonConfigurationInstances對象,然后ViewModelProvider初始化的時候通過getLastNonConfigurationInstance()方法獲取到了之前保存的mLastNonConfigurationInstances對象,mLastNonConfigurationInstances又持有著ViewModelStore,ViewModel又存儲在ViewModelStore中,這樣就達到了恢復數(shù)據(jù)的目的。

在上面我們看ViewModelStore的源碼的時候有一個clear()方法,用來循環(huán)遍歷調(diào)用ViewModel的clear()方法,在Activity銷毀的時候,可以觸發(fā),我們可以在里面做一些回收資源的操作,那么clear()又是怎么被觸發(fā)的呢?直接上代碼

 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();
                    // 如果不是配置更改,那么調(diào)用ViewModelStore的clear()
                    if (!isChangingConfigurations()) {
                        getViewModelStore().clear();
                    }
                }
            }
        });
...
}
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容