如何在ViewModel类中优雅的使用Dagger2

  ViewModel 是 Google 在 Android Jetpack 项目中提供的关键组件,可以方便开发者建立UI模型,保存UI状态变量,优雅的编写基于MVVM架构的代码。
  Dagger2 是 Google 提供的依赖注入框架,使用依赖注入框架可以优化项目架构,写出更整洁的代码。
   但是当这两者遇到一起时,会对使用者产生些小小的麻烦。

问题描述

ViewModel 在 Activity 中初始化,依赖一个Provider方法 ViewModelProviders:

    private ViewModel viewModel;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        /**
        * 使用 ViewModelProviders 方法获取viewmodel
        */
        viewModel = ViewModelProviders.of(this).get(MainViewModel.class);
    }

这样,ViewModelProviders 要求在ViewModel中必须提供一个无参构造函数,否则运行时会报错:

     Caused by: java.lang.RuntimeException: Cannot create an instance of class MainViewModel
     Caused by: java.lang.InstantiationException: java.lang.Class<MainViewModel> has no zero argument constructor

于是,要想为 ViewModel 类注入依赖,使用 @inject 标注构造函数的方式变得不可取。

    @Inject
    public MainViewModel(AppExecutors executors, QueensModel queensModel, SharedPreferences sharedPreferences) {
        this.executors = executors;
        this.sharedPreferences = sharedPreferences;
        setQueensModel(queensModel);
    }

这时需要怎么办?

解决方案

首先想到的不太合理的方案为:

1 放弃构造函数注入,使用成员变量注入方案

  1. ViewModel 中需要注入的成员变量用@Inject标注
    @Inject
    private AppExecutors executors;
    @Inject
    private SharedPreferences sharedPreferences;
    @Inject
    private QueensModel queensModel;

2 AppComponent 添加inject方法

public interface AppComponent extends AndroidInjector<DaggerApplication> {
    void inject(MainViewModel mainViewModel);
    ……
}

3 ViewModel的无参构造函数中,获取DaggerAppComponent,调用inject方法

public MainViewModel() {
……
    mContext.getApplication().getAppComponent().inject(this);
}

这个方案的问题在于:
   MainViewModel 的构造函数引入了对DaggerAppComponent的依赖,被依赖注入的对象需要知道依赖注入的方法,破坏了依赖注入的原则.
  参考 Google 官方实现 android-architecture-components, 为了解决上述问题,采用了如下方式为 ViewModel 提供依赖注入。

2 Google 提供的 ViewModel 依赖注入方案

  1. ViewModel 依然采用构造函数注入的方式,@Inject 注解构造函数而不是成员变量。
    @Inject
    public QueensViewModel(AppExecutors executors, QueensModel queensModel, SharedPreferences sharedPreferences) {
        this.executors = executors;
        this.sharedPreferences = sharedPreferences;
        setQueensModel(queensModel);
    }
  1. 提供一个工厂类,根据 class name 生产 ViewModel 对象。这个类构造函数需要注入一个Map,这个 Map 就是 ViewModel 的 class name 和 对应的 provider。
@Singleton
public class QueensViewModelFactory implements ViewModelProvider.Factory{
    private final Map<Class<? extends ViewModel>, Provider<ViewModel>> creators;

    @Inject
    public QueensViewModelFactory(Map<Class<? extends ViewModel>, Provider<ViewModel>> creators) {
        this.creators = creators;
    }

    @NonNull
    @Override
    public <T extends ViewModel> T create(@NonNull Class<T> modelClass) {
        Provider<? extends ViewModel> creator = creators.get(modelClass);
        if (creator == null) {
            for (Map.Entry<Class<? extends ViewModel>, Provider<ViewModel>> entry : creators.entrySet()) {
                if (modelClass.isAssignableFrom(entry.getKey())) {
                    creator = entry.getValue();
                    break;
                }
            }
        }
        if (creator == null) {
            throw new IllegalArgumentException("unknown model class " + modelClass);
        }
        try {
            return (T) creator.get();
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
}
  1. 通过Dagger2 的 MultiBindings 方法提供方法2 中需要的Map。并通过@Binds 绑定 ViewModelProvider.Factory 接口和 2中提供的实现类。关于MultiBindings的用法可以参考multibindings
@Module
abstract public class ViewModelModule {
    @Binds
    @IntoMap
    @ViewModelKey(QueensViewModel.class)
    abstract ViewModel bindQueensViewModel(QueensViewModel queensViewmodel);

    @Binds
    abstract ViewModelProvider.Factory bindViewModelFactory(QueensViewModelFactory factory);
}
  1. ViewModelModule 加入AppModule
@Module(includes = ViewModelModule.class)
public class AppModule {
}

这样 ViewModel 就已经添加进入Dagger2 的依赖图中了,Activity中获取viewModel的方法为:

    @Inject
    ViewModelProvider.Factory viewModelFactory;
    QueensViewModel viewModel;    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        /**
        * 使用 ViewModelProviders 方法获取viewmodel
        */
        viewModel = ViewModelProviders.of(this,viewModelFactory).get(QueensViewModel .class);
    }

对比方案一,Google 的方案对 ViewModel 的修改极小,后续添加 ViewModel 只需要 在 ViewModelModule 中,把新增的 ViewModel 绑定进 Map 即可。

参考

  1. 方案二完整代码可以参考我的GitHub项目:https://github.com/lixiangthinker/NQueens
  2. 感谢 Google 爸爸提供的参考设计 android-architecture-components

推荐阅读更多精彩内容