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()
方法运翼,我們可以在該方法中做一些清理的工作。