InitializerViewModelFactoryを使ってViewModelを生成

Feb 26, 2022

Lifecycle ViewModel 2.5.0-alpha03 で InitializerViewModelFactory が追加されています。この InitializerViewModelFactory を使ってViewModelを生成する方法を紹介します。

ここでは CreationsExtras についても出てくるので、前回書いた記事を参考にしてください。

InitializerViewModelFactory を使うとシンプルにViewModelFactoryを生成することができるようになっています。

※これを書いてる時点ではalphaなので今後変更があるかもです。

環境

Composeの場合

例としてコンストラクタ引数を一つ持ったViewModelを生成してみます。Activityから生成することを想定します。

InitializerViewModelFactory は直接使用することはできないため、 InitializerViewModelFactoryBuilder を使って InitializerViewModelFactory を作成します。

addInitializer の中で単純にViewModelのインスタンスを作っています。このとき引数も渡しています。

あとはこのFactoryを ViewModelProvider を使ってViewModelを取得するだけです。

全体的なコードは以下のような感じになります。

viewModelFactory という関数が用意されてるので、そちらを使うともう少し簡単にFactoryを作れます。

このFactoryは複数のViewModelにも対応できます。

今回の例ではActivity内でFactoryを作成していますが、グローバルに定義して複数の箇所から使用することも可能です。

AndroidViewModel や SavedStateHandle に対応するには CreationExtras を使って対応します。

initializer のスコープは CreationExtras になっているので this でアクセスできるので、そこから渡された値を取得できるようになっています。

CreationExtras を使って独自の値を渡すことも可能になっています。

前回の記事でも書きましたが、 CreationExtras を作る際は Activity/Fragmentの defaultViewModelCreationExtras を含めることを忘れないようにしましょう。

Composeの場合は新しく initializer を受け取れる viewModel 関数が追加されていますので、そちらを使うだけです。