JetPack之ViewModel源碼解析

我們認識中的ViewModel是什么

Viewmodel其實就是activity中一個普通的實體。Activity持有viewmodel的引用,業(yè)務邏輯在viewmodel進行,關于界面和ui的操作在activity中進行,而添加和釋放資源和viewmodel有關的那么就在viewmodel中設置函數(shù),然后在activity中調(diào)用。ViewModel作為Activity/Fragment與其他組件的連接器,負責轉(zhuǎn)換和聚合Model中返回的數(shù)據(jù),使這些數(shù)據(jù)易于顯示,并把這些數(shù)據(jù)改變及時的通知給Activity/Fragment。

ViewModel的生命周期

只要viewmodel依附的activity沒有發(fā)生onDestory,那viewmodel就會一直存在。

ViewModel的優(yōu)點

1、 ViewModel當Activity的Configuration變更(例如橫豎屏切換)或者各種原因?qū)е碌匿N毀重建時,會自動保留對象,當Activity重建后可立即使用,不需要重新獲取數(shù)據(jù)。
2、ViewModel的生命周期避免了內(nèi)存泄露問題。在Activity.onDestroy時會關聯(lián)ViewModel.onCleared()方法,從而在這里釋放內(nèi)存。
3、ViewModel在處理Fragment共享數(shù)據(jù)方面很好用,同一個Activity下不同的Fragment可以共享同一個ViewModel對象。

從創(chuàng)建一個viewModel入手分析源碼:
MyViewModel myViewModel = ViewModelProviders.of(this).get(MyViewModel.class);

進入ViewModelProviders.of(this)方法:

    @NonNull
    @MainThread
    public static ViewModelProvider of(@NonNull FragmentActivity activity) {
        return of(activity, null);
    }

    @NonNull
    @MainThread
    public static ViewModelProvider of(@NonNull Fragment fragment, @Nullable Factory factory) {
        Application application = checkApplication(checkActivity(fragment));
        if (factory == null) {
            factory = ViewModelProvider.AndroidViewModelFactory.getInstance(application);
        }
        return new ViewModelProvider(fragment.getViewModelStore(), factory);
    }

    @NonNull
    @MainThread
    public static ViewModelProvider of(@NonNull FragmentActivity activity,
            @Nullable Factory factory) {
        Application application = checkApplication(activity);
        if (factory == null) {
            factory = ViewModelProvider.AndroidViewModelFactory.getInstance(application);
        }
        return new ViewModelProvider(activity.getViewModelStore(), factory);
    }

checkApplication(activity)會獲取該activity所屬的application。
ViewModelProvider.AndroidViewModelFactory.getInstance(application)會創(chuàng)建一個單例的AndroidViewModelFactory,并從activity中獲取viewmodelstore,作為兩個個參數(shù)傳入ViewModelProvider構造方法,最后會新建一個ViewModelProvider作為返回。

在ComponentActivity中的getViewModelStore方法:
    @Override
    public ViewModelStore getViewModelStore() {
        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;
    }

ViewModelStore代碼實現(xiàn)如下:

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<String,ViewModel>的形式被緩存起來了,ViewModelStore就是用作存儲的類,有put、get、clear這三個存、取、清空方法。

ViewModel與頁面之間沒有直接的關聯(lián),它們通過ViewModelProvider進行關聯(lián)。當頁面需要ViewModel時,會向ViewModelProvider索要,ViewModelProvider檢查該ViewModel是否已經(jīng)存在于緩存中,若存在,則直接返回,若不存在,則實例化一個。因此,Activity由于配置變化導致的銷毀重建并不會影響ViewModel,ViewModel是獨立于頁面而存在的。也正因為此,我們在使用ViewModel時,需要特別注意,不要向ViewModel中傳入任何類型的Context或帶有Context引用的對象,這可能會導致頁面無法被銷毀,從而引發(fā)內(nèi)存泄漏。

AndroidViewModelFactory類代碼如下:

    public static class AndroidViewModelFactory extends ViewModelProvider.NewInstanceFactory {

        private static AndroidViewModelFactory sInstance;

        /**
         * Retrieve a singleton instance of AndroidViewModelFactory.
         *
         * @param application an application to pass in {@link AndroidViewModel}
         * @return A valid {@link AndroidViewModelFactory}
         */
        @NonNull
        public static AndroidViewModelFactory getInstance(@NonNull Application application) {
            if (sInstance == null) {
                sInstance = new AndroidViewModelFactory(application);
            }
            return sInstance;
        }

        private Application mApplication;

        /**
         * Creates a {@code AndroidViewModelFactory}
         *
         * @param application an application to pass in {@link AndroidViewModel}
         */
        public AndroidViewModelFactory(@NonNull Application application) {
            mApplication = application;
        }

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

ViewModel是抽象類,AndroidViewModel繼承于ViewModel,AndroidViewModelFactory從它的create方法可以看出,通過反射生成ViewModel的實現(xiàn)類。

get(MyViewModel.class)部分

進入到了ViewModelProvider進行執(zhí)行,ViewModelProvider代碼如下:

public class ViewModelProvider {

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

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

    @NonNull
    @MainThread
    public <T extends ViewModel> T get(@NonNull Class<T> modelClass) {
        String canonicalName = modelClass.getCanonicalName();    //注釋1
        if (canonicalName == null) {
            throw new IllegalArgumentException("Local and anonymous classes can not be ViewModels");
        }
        return get(DEFAULT_KEY + ":" + canonicalName, modelClass);  //注釋2
    }

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

        if (modelClass.isInstance(viewModel)) {
            //noinspection unchecked
            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);
        //noinspection unchecked
        return (T) viewModel;
    }
}

過程分析:注釋1處得到類的名稱,對這個名稱進行字符串拼接,拼接上前綴androidx.lifecycle.ViewModelProvider.DefaultKey,作為注釋2處方法的參數(shù),作為key值去ViewModelStore中獲取viewmodel實例。如果ViewModel能轉(zhuǎn)換為modelClass類的對象,直接返回該ViewModel。否則就會通過AndroidViewModelFactory的create方法通過反射創(chuàng)建一個ViewModel,并將其存儲到ViewModelStore中。

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

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

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

在使用ViewModel時,不能將任何類型的Context或含有Context引用的對象傳入ViewModel,因為這可能會導致內(nèi)存泄漏。但如果你希望在ViewModel中使用Context,該怎么辦呢?可以讓你的viewmodel繼承AndroidViewModel類,它繼承自ViewModel,并接收Application作為Context。這意味著,它的生命周期和Application是一樣的,那么這就不算是一個內(nèi)存泄漏了。

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

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