刚入坑架构组件没多久，发现很多基础性的东西理解起来是没什么问题的，但是一到具体使用就各种问题，相关实践文章也比较少，更多的只能靠自己解决 = =。今天无意间了解了AndroidViewModel的一个使用场景和实现原理，特地记录下来。
前言
一开始，跟着官方文档，ViewModel我们是这样实现的：
public class MyViewModel entends ViewModel {
//...
}
然后是创建实例对象:
MyViewModel viewModel = ViewModelProviders.of(this).get(MyViewModel.class);
可以注意到，我们定义的ViewModel是没有构造函数的，也就是说如果遇到比较复杂情况下（需要在创建ViewModel时赋一些初始值），应该怎么办呢？总不能自己加一个构造函数，然后new出来吧，或者通过set方法一个一个加也行，但是这样就有点low了。于是，我发现了一个类AndroidViewModel
AndroidViewModel
AndroidViewModel这个类的定义很简单，它继承自ViewModel，然后添加了一个application私有属性：
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时需要传递一些参数，例如Activity中的一些参数等，但是根据ViewModel的生命周期我们知道，ViewModel中是不能传入Activity等实例对象的，因为在ViewModel存活的过程中，Activity是有可能会被销毁的。因此，Google爸爸推荐我们传入application。
下面是AndroidViewModel的一个使用示例，其实我们只需要将ViewModel改为继承AndroidViewModel就可以了：
public class MyViewModel extends AndroidViewModel {
public MyViewModel(@NonNull Application application) {
super(application);
}
//...
}
使用的话还是一样的：
MyViewModel viewModel = ViewModelProviders.of(this).get(MyViewModel.class);
AndroidViewModel实现原理
到了这里，疑问就来了，我创建实例的时候并依然没有传递任何参数，那么那个application是怎么来的呢，下面我们来看下源码中是怎么实现的：
//ViewModelProviders.java
@NonNull
@MainThread
public static ViewModelProvider of(@NonNull FragmentActivity activity) {
return of(activity, null);
}
@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);
}
ViewModelProviders中有很多of的重载方法，这里暂时只需要关注上面这两个即可，可以看到，application是从我们传入的activity中获取到的，并且此时还创建了一个factory实例对象（划重点，后面会用到）。默认情况下（传递的factory为null），那么会自动创建一个AndroidViewModelFactory ,AndroidViewModelFactory 是ViewModelProvider中的一个静态内部类。
接着我们来看get方法：
//ViewModelProvider.java
@NonNull
@MainThread
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);
}
@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;
}
可以看到，最终生成的ViewModel是通过(mFactory).create方法生成的，这个factory就是上面所提到的，然后在去看他的create方法实现：
//ViewModelProvider.java
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);
}
}
转到AndroidViewModelFactory的实现，可以看到默认生成的factory的create方法中使用反射调用了ViewModel的构造函数，至此，整个过程就还原了。
自定义ViewModel构造函数
了解了AndroidViewModel的整个实现流程后，自定义流程就好办了，思路是一致的，需要借助一个Factory来实现：
public class MyViewModel2 extends ViewModel {
private String name;
public MyViewModel2(String name) {
this.name = name;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
//...
}
public class MyViewModelFactory implements ViewModelProvider.Factory {
@SuppressWarnings("unchecked")
@NonNull
@Override
public <T extends ViewModel> T create(@NonNull Class<T> modelClass) {
if (modelClass.isAssignableFrom(MyViewModel2.class)) {
return (T) new MyViewModel2("Tom");
}
throw new RuntimeException("unknown class :" + modelClass.getName());
}
}
MyViewModel2 myViewModel2 = ViewModelProviders.of(this, new MyViewModelFactory()).get(MyViewModel2.class);
Log.d("TAG", "onCreate: name = "+myViewModel2.getName());
大功告成。
虽然这里只是一个简单的例子，但是既然思路已经出来了，剩下的就是八仙过海各显神通了。
还在踩坑阶段，如有什么解释不当的地方欢迎指正。(▽)
