ViewModel SavedState + Dagger
Created at Sat, May 25, 2019ViewModel + SavedStateでDaggerを使う方法を考えてみました。
前提知識・課題
SavedStateを使う場合、ViewModelにSavedStateHandleインスタンスを渡さなければいけません。
class MyViewModel(
private val state: SavedStateHandle
) : ViewModel() {
...
}
SavedStateHandleインスタンスを作るために、SavedStateVMFactoryもしくは、AbstractSavedStateVMFactoryを使う必要があります。
生成したいViewModelのコンストラクタの引数がSavedStateHandleのみなら、SavedStateVMFactoryを使います。
// thisはFragmentActivity
ViewModelProvider(this, MyViewModel(this))
.get(MyViewModel::class.java)
コンストラクタの引数がSavedStateHandle以外にもあるなら、AbstractSavedStateVMFactoryを拡張します。
class TestViewModel(
private val state: SavedStateHandle,
private val name: String
) : ViewModel()
class TestViewModelFactory(
owner: SavedStateRegistryOwner,
defaultArgs: Bundle? = null
) : AbstractSavedStateVMFactory(owner, defaultArgs) {
override fun <T : ViewModel> create(
key: String, modelClass: Class<T>,
handle: SavedStateHandle
): T {
return TestViewModel(handle, "test") as T
}
}
// 以下、生成コード
ViewModelProvider(this, TestViewModelFactory(this))
.get(TestViewModel::class.java)
こんな感じになります。
今までとは違い、AbstractSavedStateVMFactoryにSavedStateRegistryOwnerインターフェース（実質、FragmentActivity or Fragment）を渡さなければいけません。
また、初期値が欲しい場合は、defaultArgs(Bundle)も渡す必要があります。
Daggerでどのように使うか?
以下いろいろと書いていきます。クラス名は適当です。また、このサンプルはFragmentActivity + 初期値がintent.extras固定となります。Fragmentの場合はFragmentに置き換える必要があります
1. AbstractSavedStateVMFactoryを生成するクラスを定義する
class SavedStateViewModel2(
private val dummy: Dummy,
private val state: SavedStateHandle
) : ViewModel() {
class Factory @Inject constructor(private val dummy: Dummy) {
fun create(owner: FragmentActivity): AbstractSavedStateVMFactory {
return object : AbstractSavedStateVMFactory(owner, owner.intent.extras) {
override fun <T : ViewModel> create(
key: String,
modelClass: Class<T>,
handle: SavedStateHandle
): T {
return SavedStateViewModel2(dummy, handle) as T
}
}
}
}
}
// 以下、生成コード
class MainActivity : AppCompatActivity() {
@Inject lateinit var factory: SavedStateViewModel2.Factory
private val viewModel by viewModels<SavedStateViewModel2> { // viewModelsはktxの拡張関数
factory.create(this)
}
}
一番シンプルな方法だと思います。AbstractSavedStateVMFactoryを作るためのFactory（FactoryのFactory）を作り、それに@Injectをつけます。
2. 1の方法に加え、FragmentActivityをBinds or Providesする
@Binds
fun fragmentActivity(activity: MainActivity): FragmentActivity
or
@Provides
fun fragmentActivity(activity: MainActivity): FragmentActivity = fragmentActivity
--
class SavedStateViewModel5(
private val dummy: Dummy,
private val state: SavedStateHandle
) : ViewModel() {
class Factory @Inject constructor(
owner: FragmentActivity,
private val dummy: Dummy
) : AbstractSavedStateVMFactory(owner, owner.intent.extras) {
override fun <T : ViewModel> create(
key: String,
modelClass: Class<T>,
handle: SavedStateHandle
): T {
return SavedStateViewModel5(dummy, handle) as T
}
}
}
// 以下、生成コード
class MainActivity : AppCompatActivity() {
@Inject lateinit var factory: SavedStateViewModel5.Factory
private val viewModel by viewModels<SavedStateViewModel5> {
factory
}
}
FragmentActivityがInject可能になったので直接AbstractSavedStateVMFactoryが生成可能になりました😃
3. AssistedInjectを使う
SavedStateHandleがDaggerで解決しにくい値なので、square/AssistedInjectを使うことで解決を試みます。
class SavedStateViewModel3 @AssistedInject constructor(
@Assisted private val state: SavedStateHandle,
private val dummy: Dummy
) : ViewModel() {
@AssistedInject.Factory
interface Factory {
fun create(state: SavedStateHandle): SavedStateViewModel3
}
}
---
@AssistedModule
@Module(includes = [AssistedInject_SavedStateViewModelModule::class])
interface SavedStateViewModelModule
---
// 以下、生成コード
class MainActivity : AppCompatActivity() {
@Inject lateinit var factory3: SavedStateViewModel3.Factory
private val viewModel3 by viewModels<SavedStateViewModel3> {
viewModelWrapper(this) { factory3.create(it) }
}
}
---
// ただの便利関数
fun <T : ViewModel> viewModelWrapper(
owner: FragmentActivity,
body: (state: SavedStateHandle) -> T
): AbstractSavedStateVMFactory {
return object : AbstractSavedStateVMFactory(owner, owner.intent.extras) {
override fun <T : ViewModel> create(
key: String,
modelClass: Class<T>,
handle: SavedStateHandle
): T {
@Suppress("UNCHECKED_CAST")
return body(handle) as T
}
}
}
こんな感じになります。FragmentActivityをInject可能にすれば、もう少しいい感じに書けると思います。最終的なコード量は1、2のパターンに比べかなり減ると思います。
4. AssistedInject + multibindsを使う
DaggerでViewModelのインスタンスを生成するときに、multibindsを使うパターンがよく使われているので、SavedStateの場合も考えてみました。
@MustBeDocumented
@Target(
AnnotationTarget.FUNCTION,
AnnotationTarget.PROPERTY_GETTER
)
@Retention(AnnotationRetention.RUNTIME)
@MapKey annotation class ViewModelKey(
val value: KClass<out ViewModel>
)
---
class ViewModelFactory @Inject constructor(
owner: FragmentActivity,
private val creators: Map<Class<out ViewModel>, @JvmSuppressWildcards Provider<SavedStateViewModelFactory>>
) : AbstractSavedStateVMFactory(owner, owner.intent.extras) {
override fun <T : ViewModel> create(
key: String,
modelClass: Class<T>,
handle: SavedStateHandle
): T {
var creator: Provider<out SavedStateViewModelFactory>? = creators[modelClass]
if (creator == null) {
for ((key, value) in creators) {
if (modelClass.isAssignableFrom(key)) {
creator = value
break
}
}
}
if (creator == null) {
throw IllegalArgumentException("unknown model class $modelClass")
}
try {
@Suppress("UNCHECKED_CAST")
return creator.get().create(handle) as T
} catch (e: Exception) {
throw RuntimeException(e)
}
}
}
---
interface SavedStateViewModelFactory {
fun create(
state: SavedStateHandle
): ViewModel
}
---
class SavedStateViewModel4 @AssistedInject constructor(
@Assisted private val state: SavedStateHandle,
private val dummy: Dummy
) : ViewModel() {
@AssistedInject.Factory
interface Factory : SavedStateViewModelFactory {
override fun create(state: SavedStateHandle): SavedStateViewModel4
}
}
---
@Binds
fun bindFragmentActivity(activity: MainActivity): FragmentActivity
@ViewModelKey(SavedStateViewModel4::class)
@IntoMap @Binds
fun bind(
factory: SavedStateViewModel4.Factory
): SavedStateViewModelFactory
---
@Inject lateinit var viewModelFactory: ViewModelFactory
private val viewModel4 by viewModels<SavedStateViewModel4> {
viewModelFactory
}
SavedStateViewModelFactoryインターフェースを作るところがポイントです。他の部分は従来のViewModel + multibindsと大体一緒です。
まとめ
- SavedStateHandleはDaggerで解決しにくい・できない？
- 自分で頑張ってFactoryを書く、Assisted Injectを使うなどの方法をしなければ行けない
- multibindsを使う方法はさらに複雑になった
- 出来るとは思うけど、個人的には推奨しない。複雑になりそう
今回の検証に使ったコードはsatoshun-android-example/ViewModelSavedStateにあります😃