Jetpack-ViewModel

Jetpack-Lifecycle

Jetpack-LiveData

ViewModel

ViewModel是以能感知生命周期的方式存儲和管理界面相關(guān)數(shù)據(jù)的組件炬藤。感知生命周期是說當(dāng)Activity或Fragment創(chuàng)建第一個實(shí)例的時候,它開始創(chuàng)建碴里,當(dāng)Activity銷毀或者Fragment分離的時候沈矿,它自動清理。比如:當(dāng)屏幕旋轉(zhuǎn)時咬腋,它不會被重新創(chuàng)建羹膳,數(shù)據(jù)能夠被恢復(fù)。

當(dāng)Activity配置發(fā)生變化時根竿,我們也可以通過onSaveInstanceState() 方法保存數(shù)據(jù)陵像,從 onCreate()onRestoreInstanceState方法中恢復(fù)其數(shù)據(jù),但這種方式僅適合可以序列化再反序列化的少量數(shù)據(jù)寇壳,而不適合較大數(shù)量的數(shù)據(jù)醒颖,如用戶列表;而ViewModel可以壳炎。

Activity或Fragment主要用于界面的展示泞歉,如果數(shù)據(jù)存儲和恢復(fù)的相關(guān)邏輯放在其中,會使Activity或Fragment變得臃腫匿辩。使用ViewModel可以將它們分離開來腰耙。

使用

class MyViewModel : ViewModel() {
    private val users: MutableLiveData<List<User>> by lazy {
        MutableLiveData().also {
            it.value = loadUsers()
        }
    }

    fun getUsers(): LiveData<List<User>> {
        return users
    }

    private fun loadUsers():List<User> {
        //todo
    }
}
class MyActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        //通過ViewModelProviders獲取ViewModel實(shí)例
        val model = ViewModelProviders.of(this)[MyViewModel::class.java]
        model.getUsers().observe(this, Observer<List<User>>{ users ->
            //todo
        })
    }
}

ViewModel還存在一個子類:AndroidViewModel,它的構(gòu)造方法接收一個Application類型的參數(shù)铲球,方便在ViewModel中使用Context挺庞。

//定義
class MyViewModel(application:Application) : AndroidViewModel(application) {}

//獲取實(shí)例
mViewModel = ViewModelProviders.of(this,ViewModelProvider.AndroidViewModelFactory(application)).get(MyViewModel::class.java)

從上面看到當(dāng)ViewModel的構(gòu)造方法中有參數(shù)時,在獲取實(shí)例的時候睬辐,傳入了一個參數(shù):ViewModelProvider.factory挠阁,那么這個Factory的作用是什么呢宾肺?當(dāng)我們調(diào)用ViewModelProviders.of(activity)獲取ViewModel實(shí)例的時候,它內(nèi)部會默認(rèn)調(diào)用ViewModel無參構(gòu)造方法來創(chuàng)建實(shí)例侵俗;但是當(dāng)ViewModel的構(gòu)造方法有依賴時锨用,這時候就需要我們自定義Factory來實(shí)例化ViewModel。比如:ViewModel的構(gòu)造方法含有一個Int類型的參數(shù)隘谣,Factory的實(shí)現(xiàn)如下:

class MyViewModel(id: Int) : ViewModel() {}

//自定義Factory 
class MyViewModelFactory(private val arg: Int) : ViewModelProvider.Factory {

    override fun <T : ViewModel?> create(modelClass: Class<T>): T {
        return modelClass.getConstructor(Int::class.java).newInstance(arg)
    }
}

生命周期

ViewModel的存在是從第一次獲取ViewModel實(shí)例一直到Activity完全銷毀或者Fragment分離增拥,Activity因配置發(fā)生變化而重新創(chuàng)建時,ViewModel是不會重新創(chuàng)建的寻歧。

當(dāng)ViewModel銷毀的時候掌栅,它會調(diào)用onCleared()方法,來清理相關(guān)的資源码泛。

因?yàn)閂iewModel比Activity的生命周期要長猾封,所以ViewMode一定不能持有View的引用。

實(shí)現(xiàn)原理

我們要使用ViewModel噪珊,首先調(diào)用ViewModelProviders.of(this).get(MyViewModel::class.java)來獲取實(shí)例晌缘。我們就以此為分析的入口,看一下該方法的實(shí)現(xiàn):

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

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

從上面可以看出最終都會調(diào)用兩個參數(shù)的方法痢站,new ViewModelProvider(activity.getViewModelStore(), factory);磷箕,第一個參數(shù)通過Activity獲取一個ViewModelStore對象,該方法是在ComponentActivity中實(shí)現(xiàn)的:

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

Activity在配置發(fā)生變化時阵难,如橫豎屏切換會觸發(fā)onSaveInstanceState()方法來保存狀態(tài)岳枷,除此之外Activity還提供了一個方法onRetainNonConfigurationInstance來保存狀態(tài),最大的不同在于這個方法可以返回一個包含有狀態(tài)信息的Object呜叫。該方法是在onSaveInstanceState()方法之后調(diào)用空繁,該方法不允許重寫。

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

Activity在配置發(fā)生變化的時候保存了viewModelStore怀偷,放到了NonConfigurationInstances中家厌。上面的操作都圍繞著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());
    }

    public final void clear() {
        for (ViewModel vm : mMap.values()) {
            vm.clear();
        }
        mMap.clear();
    }
}

ViewModelStore的代碼很簡單,就是用一個HashMap來存儲ViewModel蜀踏。那么ViewModel又是從什么時候存進(jìn)去的呢维蒙?那就要從ViewModel的創(chuàng)建說起,我們獲取ViewModel的實(shí)例調(diào)用的是ViewModelProvider的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");
    }
    return get(DEFAULT_KEY + ":" + canonicalName, modelClass);
}

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

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

get()方法的實(shí)現(xiàn)也比較簡單:先判斷緩存中是否存在ViewModel颅痊,如果不存在就使用Factory創(chuàng)建一個實(shí)例,然后加入到緩存中局待。

ViewModel存儲在ViewModelStore中斑响,而ViewModelStore在Activity配置變化的時候會在onRetainNonConfigurationInstance()方法中保存起來菱属,也就是說ViewModelStore不會因?yàn)锳ctivity配置發(fā)生變化而重新創(chuàng)建。所以ViewModel也不會重新創(chuàng)建舰罚。

那么ViewModel是在什么時候銷毀的呢纽门?ViewModel存儲在ViewModelStore里面的mMap中,它中有一個clear()方法,用來清除這個mMap营罢,也就是清除ViewModel赏陵,那么我們就看一下這個方法是在哪里調(diào)用的?

public ComponentActivity() {
    ...
    getLifecycle().addObserver(new LifecycleEventObserver() {
        @Override
        public void onStateChanged(@NonNull LifecycleOwner source,
                @NonNull Lifecycle.Event event) {
            if (event == Lifecycle.Event.ON_DESTROY) {
                if (!isChangingConfigurations()) {
                    getViewModelStore().clear();
                }
            }
        }
    });
    ...
}

在Activity創(chuàng)建的時候會通過Lifecycle添加一個觀察者饲漾,觀察Activity的ON_DESTROY狀態(tài)蝙搔。當(dāng)處于該狀態(tài)時,判斷是否是配置變化觸發(fā)的考传,如果不是則調(diào)用ViewModelStore的clear()方法吃型。從這里也可以看出,當(dāng)Activity配置變化的時候并不會清理ViewModel僚楞。在Jetpack-Lifecycle中我們知道勤晚,當(dāng)Activity調(diào)用onDestroy()時,狀態(tài)會變?yōu)?strong>ON_DESTROY镜硕。

public final void clear() {
    for (ViewModel vm : mMap.values()) {
        vm.clear();
    }
    mMap.clear();
}

clear()方法中會調(diào)用ViewModel的clear()方法

final void clear() {
    mCleared = true;
    if (mBagOfTags != null) {
        synchronized (mBagOfTags) {
            for (Object value : mBagOfTags.values()) {
                // see comment for the similar call in setTagIfAbsent
                closeWithRuntimeException(value);
            }
        }
    }
    onCleared();
}

protected void onCleared() {
}

所以在ViewModel即將銷毀的時候會回調(diào)它的onCleared()方法运翼,我們可以在該方法中做一些清理的工作。

KotlinAndroid

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末兴枯,一起剝皮案震驚了整個濱河市血淌,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌财剖,老刑警劉巖悠夯,帶你破解...
    沈念sama閱讀 216,544評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異躺坟,居然都是意外死亡沦补,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,430評論 3 392
  • 文/潘曉璐 我一進(jìn)店門咪橙,熙熙樓的掌柜王于貴愁眉苦臉地迎上來夕膀,“玉大人,你說我怎么就攤上這事美侦〔瑁” “怎么了?”我有些...
    開封第一講書人閱讀 162,764評論 0 353
  • 文/不壞的土叔 我叫張陵菠剩,是天一觀的道長易猫。 經(jīng)常有香客問我,道長具壮,這世上最難降的妖魔是什么准颓? 我笑而不...
    開封第一講書人閱讀 58,193評論 1 292
  • 正文 為了忘掉前任哈蝇,我火速辦了婚禮,結(jié)果婚禮上攘已,老公的妹妹穿的比我還像新娘炮赦。我一直安慰自己,他們只是感情好贯被,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,216評論 6 388
  • 文/花漫 我一把揭開白布眼五。 她就那樣靜靜地躺著,像睡著了一般彤灶。 火紅的嫁衣襯著肌膚如雪看幼。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,182評論 1 299
  • 那天幌陕,我揣著相機(jī)與錄音诵姜,去河邊找鬼。 笑死搏熄,一個胖子當(dāng)著我的面吹牛棚唆,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播心例,決...
    沈念sama閱讀 40,063評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼宵凌,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了止后?” 一聲冷哼從身側(cè)響起瞎惫,我...
    開封第一講書人閱讀 38,917評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎译株,沒想到半個月后瓜喇,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,329評論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡歉糜,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,543評論 2 332
  • 正文 我和宋清朗相戀三年乘寒,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片匪补。...
    茶點(diǎn)故事閱讀 39,722評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡伞辛,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出夯缺,到底是詐尸還是另有隱情始锚,我是刑警寧澤,帶...
    沈念sama閱讀 35,425評論 5 343
  • 正文 年R本政府宣布喳逛,位于F島的核電站,受9級特大地震影響棵里,放射性物質(zhì)發(fā)生泄漏润文。R本人自食惡果不足惜姐呐,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,019評論 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望典蝌。 院中可真熱鬧曙砂,春花似錦、人聲如沸骏掀。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,671評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽截驮。三九已至笑陈,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間葵袭,已是汗流浹背涵妥。 一陣腳步聲響...
    開封第一講書人閱讀 32,825評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留坡锡,地道東北人蓬网。 一個月前我還...
    沈念sama閱讀 47,729評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像鹉勒,于是被迫代替她去往敵國和親帆锋。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,614評論 2 353

推薦閱讀更多精彩內(nèi)容