ViewModel 源码解析

时间  2021-08-14
标签 java android api markdown app ide 函数 oop this spa 栏目 Java 繁體版
原文   原文链接

ViewModel 概述

ViewModel 类旨在以注重生命周期的方式存储和管理界面的数据，让数据能够在发生屏幕旋转等配置更改后继续保留。它还处理界面与应用其余部分的通讯（例如，调用业务逻辑类）。界面应该可以观察ViewModel 中的更改，一般经过LiveData 或者 DataBinding 公开此信息，它决不能拥有界面的引用。java

ViewModel 源码解析

public abstract class ViewModel {
    // Can't use ConcurrentHashMap, because it can lose values on old apis (see b/37042460)
    @Nullable
    private final Map<String, Object> mBagOfTags = new HashMap<>();
    private volatile boolean mCleared = false;

    /** * ViewModel 被清除是会调用这个方法 * 咱们能够重写这个方法在里面作一些回收工做 */
    @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();
    }

    
    @SuppressWarnings("unchecked")
    <T> T setTagIfAbsent(String key, T newValue) {
        T previous;
        synchronized (mBagOfTags) {
            previous = (T) mBagOfTags.get(key);
            if (previous == null) {
                mBagOfTags.put(key, newValue);
            }
        }
        T result = previous == null ? newValue : previous;
        if (mCleared) {
            closeWithRuntimeException(result);
        }
        return result;
    }

    /** * Returns the tag associated with this viewmodel and the specified key. */
    @SuppressWarnings({"TypeParameterUnusedInFormals", "unchecked"})
    <T> T getTag(String key) {
        if (mBagOfTags == null) {
            return null;
        }
        synchronized (mBagOfTags) {
            return (T) mBagOfTags.get(key);
        }
    }

    private static void closeWithRuntimeException(Object obj) {
        if (obj instanceof Closeable) {
            try {
                ((Closeable) obj).close();
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
    }
}
复制代码

能够看到 ViewModel 的源码其实很简单，就是维护mBagOfTags 这个HashMap和clear() 这个函数。接着咱们看下clear() 在哪里被调用android

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 的clear() 里面被调用了。能够看到ViewModelStore 这个类就是管理ViewModel。而ViewModelStore 的clear()是在Activity 的构造方法中被调用api

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 onDistroy 的时候且不是更改配置的状况下就会调用 getViewModelStore().clear() 这样ViewModel 就会被清除。 接着咱们看下是谁把ViewModel put 进来的。markdown

public class ViewModelProvider {
    private static final String DEFAULT_KEY =
            "androidx.lifecycle.ViewModelProvider.DefaultKey";
    //省略代码...

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

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

        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.
            }
        }
        if (mFactory instanceof KeyedFactory) {
            viewModel = ((KeyedFactory) (mFactory)).create(key, modelClass);
        } else {
            viewModel = (mFactory).create(modelClass);
        }
        mViewModelStore.put(key, viewModel);
        return (T) viewModel;
    }
    
    //省略代码...

}
复制代码

能够看到get方法大体就是若是存在就直接返回，若是没有就建立有个ViewModel保存并返回。这里用到了mViewModelStore、mFactory 两个对象，这两个对象ViewModelProvider 类在构造方法中实例化的，咱们接着看下它的构造方法。app

public class ViewModelProvider {
    //省略代码...
    private final Factory mFactory;
    private final ViewModelStore mViewModelStore;
    //构造函数1
    public ViewModelProvider(@NonNull ViewModelStoreOwner owner) {
        this(owner.getViewModelStore(), owner instanceof HasDefaultViewModelProviderFactory
                ? ((HasDefaultViewModelProviderFactory) owner).getDefaultViewModelProviderFactory()
                : NewInstanceFactory.getInstance());
    }
   
    public ViewModelProvider(@NonNull ViewModelStoreOwner owner, @NonNull Factory factory) {
        this(owner.getViewModelStore(), factory);
    }
   
    public ViewModelProvider(@NonNull ViewModelStore store, @NonNull Factory factory) {
        mFactory = factory;
        mViewModelStore = store;
    }
    //省略代码...
}
复制代码

咱们一般用的都是“构造函数1” 须要传入ViewModelStoreOwner 对象，这是一个接口类ide

@SuppressWarnings("WeakerAccess")
public interface ViewModelStoreOwner {
    /** * Returns owned {@link ViewModelStore} * * @return a {@code ViewModelStore} */
    @NonNull
    ViewModelStore getViewModelStore();
}
复制代码

咱们使用的时候传入的是Activity/Fragment，因此可知 Activity/Fragment 都实现了这个接口。 能够看到 “owner instanceof HasDefaultViewModelProviderFactory” 说明同时还可能实现了HasDefaultViewModelProviderFactory 这个接口。函数

public class ComponentActivity extends androidx.core.app.ComponentActivity implements LifecycleOwner, ViewModelStoreOwner, HasDefaultViewModelProviderFactory, SavedStateRegistryOwner, OnBackPressedDispatcherOwner {
复制代码

果真是这样的，这里咱们就先看下HasDefaultViewModelProviderFactory 这个接口oop

public interface HasDefaultViewModelProviderFactory {
    /** * Returns the default {@link ViewModelProvider.Factory} that should be * used when no custom {@code Factory} is provided to the * {@link ViewModelProvider} constructors. * * @return a {@code ViewModelProvider.Factory} */
    @NonNull
    ViewModelProvider.Factory getDefaultViewModelProviderFactory();
}
复制代码

接这个咱们看下Activity 对ViewModelStoreOwner、HasDefaultViewModelProviderFactory 接口方法的实现this

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) {
                //恢复viewModelStore
                mViewModelStore = nc.viewModelStore;
            }
            if (mViewModelStore == null) {
                mViewModelStore = new ViewModelStore();
            }
        }
        return mViewModelStore;
    }
    
    public ViewModelProvider.Factory getDefaultViewModelProviderFactory() {
        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 (mDefaultFactory == null) {
            mDefaultFactory = new SavedStateViewModelFactory(
                    getApplication(),
                    this,
                    getIntent() != null ? getIntent().getExtras() : null);
        }
        return mDefaultFactory;
    }

复制代码

咱们先看 getViewModelStore() 正常状况下在第一次调用时建立实例，下次调用直接获取。NonConfigurationInstances 这个类主要做用是，在发生屏幕旋转等配置更改会将一些须要保存的实例放在这里面，并传递给下一个Activity(恢复的Activity)，这样就能保证这些实例在这种状况下无需从新建立；好比ViewModelStorespa

getDefaultViewModelProviderFactory() 第一次调用的时候会建立一个SavedStateViewModelFactory 对象。顾名思义，就是 保存状态的ViewModel工厂，代码就不带你们看了。主要逻辑就是若是不须要 SavedStateHandle 就是经过反射建立一个ViewModel 对象。须要 SavedStateHandle 的状况你们能够看下这篇文章 www.jianshu.com/p/731ca4282…

小结

以上咱们从ViewModel 的源码反向推倒知道了 ViewModel 的建立、恢复以及清除的过程。

所以咱们也知道了，为何Activity 在发生屏幕旋转等配置更改时ViewModel 没有从新建立；ViewModel 的生命周期为何要比Activity 长一点。还不知道的同窗能够从新看一遍。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程