Android-Jetpack组件ViewModel基本使用和原理分析【建议收藏】

最新推荐文章于 2024-09-23 16:38:04 发布

2401_84003809

最新推荐文章于 2024-09-23 16:38:04 发布

阅读量365

点赞数 3

本文链接：https://blog.csdn.net/2401_84003809/article/details/137370462

版权

程序员专栏收录该内容

287 篇文章 1 订阅

订阅专栏

3.2.两个 Fragment

class FirstFragment : Fragment() {
private val TAG = javaClass.simpleName

override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
val userViewModel = ViewModelProvider(activity as ViewModelStoreOwner)[UserViewModel::class.java]
“userViewModel = $userViewModel”.logWithTag(TAG)
return super.onCreateView(inflater, container, savedInstanceState)
}
}

class SecondFragment : Fragment() {
private val TAG = javaClass.simpleName

在 FirstFragment和SecondFragment的onCreateView方法中实例化UserViewModel对象
其中的参数都为activity as ViewModelStoreOwner其实也就是ViewModelActivity2
打印UserViewModel对象的地址值，来看日志

3.3.结果日志

E/FirstFragment: userViewModel = com.jhb.awesomejetpack.viewmodel.UserViewModel@9940311
E/SecondFragment: userViewModel = com.jhb.awesomejetpack.viewmodel.UserViewModel@9940311

可以看到两个 Fragment 中 UserViewModel是同一个对象。

可以这两个 Fragment 可以使用其 Activity 范围共享 ViewModel 来处理此类通信

4.抛出问题

ViewModel为什么不会随着Activity的屏幕旋转而销毁；
为什么在对应的作用域内，保正只生产出对应的唯一实例，保证UI组件间的通信
onCleared方法在什么调用

5.分析源码前的准备工作

5.1ViewModel 的生命周期

5.2.几个类的感性认识

ViewModelStoreOwner：是一个接口，用来获取一个ViewModelStore对象
ViewModelStore：存储多个ViewModel，一个ViewModelStore的拥有者( Activity )在配置改变，重建的时候，依然会有这个实例
ViewModel：一个对 Activity、Fragment 的数据管理类，通常配合 LiveData 使用
ViewModelProvider：创建一个 ViewModel 的实例，并且在给定的ViewModelStoreOwner中存储 ViewModel

6.源码分析

再看上面第一个例子中的代码

class ViewModelActivity : AppCompatActivity() {

//初始化 UserViewModel 通过 ViewModelProvider
private val userViewModel by lazy { ViewModelProvider(this)[UserViewModel::class.java] }

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val button = Button(this)
setContentView(button)

//观察 User 数据,并打印
userViewModel.userLiveData.observe(this, Observer { user ->
“User = $user”.log()
})

//点击按钮更新 User 信息
button.setOnClickListener {
userViewModel.updateUser()
}
}
}

首先看下UserViewModel的初始化过程。

private val userViewModel by lazy { ViewModelProvider(this)[UserViewModel::class.java] }

注：上面代码类似数组的写法是 Kotlin 的写法，其实是 ViewModelProvider 的get方法

7.ViewModelProvider的构造方法，以及 get 方法

7.1ViewModelProvider构造方法

先看ViewModelProvider构造方法，传入的参数为当前的 AppCompatActivity

//ViewModelProvider.java

private final Factory mFactory;
private final ViewModelStore mViewModelStore;

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

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

通过 ViewModelStoreOwner获取ViewModelStore对象并给 mViewModelStore赋值
给mFactory赋值，这里赋值的是NewInstanceFactory这个对象

7.2.ViewModelProvider的 get 方法

//ViewModelProvider.java

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

public T get(@NonNull Class modelClass) {
String canonicalName = modelClass.getCanonicalName();
if (canonicalName == null) {
throw new IllegalArgumentException(“Local and anonymous classes can not be ViewModels”);
}
//1
return get(DEFAULT_KEY + “:” + canonicalName, modelClass);
}

注释1：

调用了两个参数的 get 方法
第一个参数是字符串的拼接，用来以后获取对应 ViewModel 实例的，保证了同一个 Key 取出是同一个 ViewModel
第二参数是 UserViewModel 的字节码文件对象

看下两个参数的get方法

//ViewModelProvider.java
public T get(@NonNull String key, @NonNull Class modelClass) {
ViewModel viewModel = mViewModelStore.get(key);//1
//2
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.
}
}
//3
if (mFactory instanceof KeyedFactory) {
viewModel = ((KeyedFactory) (mFactory)).create(key, modelClass);
} else {
viewModel = (mFactory).create(modelClass);
}
//4
mViewModelStore.put(key, viewModel);
return (T) viewModel;
}

注释 1：从ViewModelStore中，根据 key，取一个 ViewModel，ViewModelStore源码下文分析

注释 2：判断取出来的 ViewModel 实例和传进来的是否是一个，是同一个，直接返回此缓存中实例

注释 3：通过Factory创建一个ViewModel

注释 4：把新创建的ViewModel用ViewModelStore存储起来，以备下次使用，最后返回新创建的ViewModelStore

这里看一下ViewModel是怎么通过Factory创建出来的

通过 7.1 小节可以知道，这个Factory的实例是NewInstanceFactory

7.3.NewInstanceFactory的create方法

//ViewModelProvider.java 中的 AndroidViewModelFactory.java
public T create(@NonNull Class modelClass) {
//noinspection TryWithIdenticalCatches
try {
return modelClass.newInstance();
} catch (InstantiationException e) {
throw new RuntimeException("Cannot create an instance of " + modelClass, e);
} catch (IllegalAccessException e) {
throw new RuntimeException("Cannot create an instance of " + modelClass, e);
}
}

简单粗暴，通过反射，直接创建了ViewModel对象。

这里扩展一个，在实例UserViewModel的时候

private val userViewModel by lazy { ViewModelProvider(this,ViewModelProvider.AndroidViewModelFactory.getInstance(application))[UserViewModel::class.java] }

也可以通过两个参数的构造方法，来实例化，其中第二个参数就是Factory类型。然后就会用 AndroidViewModelFactory来实例化UserViewModel，我们来具体看下代码

AndroidViewModelFactory是NewInstanceFactory的子类

//ViewModelProvider.java 中的 AndroidViewModelFactory
public T create(@NonNull Class 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);
}

如果我们创建的UserViewModel当初继承的是AndroidViewModel类就走modelClass.getConstructor(Application.class).newInstance(mApplication);实例化方法，否则就走父类的实例化方法，也就是NewInstanceFactory的create方法

在开发中建议使用AndroidViewModel类，它会提供给一个Application级别的 Context。

接下来看一下ViewModelStoreOwner是什么，以及它的具体实现

8.ViewModelStoreOwner

public interface ViewModelStoreOwner {
/**

Returns owned {@link ViewModelStore}
@return a {@code ViewModelStore}
*/
@NonNull
ViewModelStore getViewModelStore();
}
一个接口，里面一个方法返回了ViewModelStore对象
它的实现类在 AndroidX 中ComponentActivity和 Fragment

ComponentActivity的关键代码

//ComponentActivity.java
public class ComponentActivity extends androidx.core.app.ComponentActivity implements ViewModelStoreOwner,XXX{

private ViewModelStore mViewModelStore;

@NonNull
@Override
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;
}
}

创建了一个ViewModelStore并返回了

来看下这个ViewModelStore类

9.ViewModelStore

9.1.ViewModelStore的源码

我下面贴的是完整代码，对你没看错。

public class ViewModelStore {
//1
private final HashMap<String, ViewModel> mMap = new HashMap<>();
//2
final void put(String key, ViewModel viewModel) {
ViewModel oldViewModel = mMap.put(key, viewModel);
if (oldViewModel != null) {
oldViewModel.onCleared();
}
}
//3
final ViewModel get(String key) {
return mMap.get(key);
}

Set keys() {
return new HashSet<>(mMap.keySet());
}

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

注释 1 ：声明一个 Map 来存储ViewModel

注释 2：存储ViewModel，这个方法我们在7.2 小节ViewModelProvider的 get 方法中用到过

注释 3：取出 ViewModel，这个方法我们在7.2 小节ViewModelProvider的 get 方法中用到过。注意在从 Map中去 ViewModel 的时候是根据 Key，也就是7.2小节注释 1 拼接的那个字符串DEFAULT_KEY + “:” + canonicalName。这也就解释了第 4 节的疑问 为什么在对应的作用域内，保正只生产出对应的唯一实例

注释 4：这个是一个重点方法了，表明要清空存储的数据，还会调用到ViewModel的 clear 方法，也就是最终会调用带 ViewModel 的onCleared()方法

那么这个ViewModelStore的 clear 方法，什么时候会调用呢？

9.2.ComponentActivity的构造方法

//ComponentActivity.java
public ComponentActivity() {
Lifecycle lifecycle = getLifecycle();

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

}

在ComponentActivity的构造方法中，我们看到，在 Activity 的生命周期为 onDestory的时候，并且当前不是，配置更改（比如横竖屏幕切换）就会调用ViewModelStore 的 clear 方法，进一步回调用 ViewModel 的onCleared方法。

这就回答了第四节提出的问题onCleared方法在什么调用

最后看一下 ViewModel 的源码，以及其子类AndroidViewModel

10.ViewModel 的源码

ViewModel类其实更像是更规范化的抽象接口

public abstract class ViewModel {
private volatile boolean mCleared = false;

@SuppressWarnings(“WeakerAccess”)
protected void onCleared() {
}

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

}

ViewModel 的子类AndroidViewModel

public class AndroidViewModel extends ViewModel {
@SuppressLint(“StaticFieldLeak”)
private Application mApplication;

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

/**

Return the application.
*/
@SuppressWarnings({“TypeParameterUnusedInFormals”, “unchecked”})
@NonNull
public T getApplication() {
return (T) mApplication;
}
}

提供了一个规范，提供了一个 Application 的 Context

到现在整个源码过程就看了，包括前面，我们提到的那几个关键类的源码。

到目前为止，我们第 4 节抛出的问题，已经解决了，两个了，还有一个ViewModel为什么不会随着Activity的屏幕旋转而销毁；