Help us understand the problem. What is going on with this article?

Fragment の Android-KTX が AAC ViewModel の取得に便利だ

More than 1 year has passed since last update.

Android Architecture Components の ViewModel
Fragment で取得するときは こう書くと思います:

MainFragment.kt
import android.support.v4.app.Fragment
import androidx.lifecycle.ViewModelProviders

class MainFragment : Fragment() {
    private lateinit var viewModel : MainViewModel

    override fun onActivityCreated(savedInstanceState: Bundle?) {
        super.onActivityCreated(savedInstanceState)
        viewModel = ViewModelProviders.of(this).get(MainViewModel::class.java)
    }
}

Fragment KTX を使うと

Property Delegate を使ってこうかけます:

MainFragment.kt
import android.support.v4.app.Fragment
import androidx.fragment.app.viewModels

class MainFragment : Fragment() {
    private val viewModel: MainViewModel by viewModels()
}

lateinit varval になったので
なんとなく安心感が出てきましたね。

あるいは Activity のスコープの ViewModel をつかうときは
by activityViewModels がつかえます:

MainFragment.kt
import android.support.v4.app.Fragment
import androidx.fragment.app.activityViewModels

class MainFragment : Fragment() {
    private val viewModel : MainViewModel by activityViewModels()
}

導入法

アプリ (モジュール) 以下の gradle に
Fragment KTX の依存を追加します:

app/build.gradle
dependencies {
    implementation 'androidx.fragment:fragment-ktx:1.1.0-alpha04'
}

KTX について詳しくはこちら:
https://developer.android.com/kotlin/ktx

パターン

この Property Delegate は 2 つの引数をとりますが、
それぞれデフォルト引数が設定されてるのでなしでもいけますし、
指定してもいけるっていう便利な感じになってます。

inline fun <reified VM : ViewModel> Fragment.viewModels(
    noinline ownerProducer: () -> ViewModelStoreOwner = { this },
    noinline factoryProducer: (() -> Factory)? = null
)

https://android.googlesource.com/platform/frameworks/support/+/refs/heads/androidx-master-dev/fragment/ktx/src/main/java/androidx/fragment/app/FragmentViewModelLazy.kt#55

これを踏まえてよく使うパターンが紹介されてます

https://developer.android.com/reference/kotlin/androidx/fragment/app/package-summary?hl=ja#viewmodels

1. 引数なし: by viewmodels()

1 つめは by viewmodels() で引数なしで移譲するパターンです:

private val viewModel: MainViewModel by viewModels()

Returns a property delegate to access ViewModel by default scoped to this Fragment

このパターンでは、この ViewModel のスコープが
このプロパティを定義した Fragment ( === this ) になります。

2. by viewmodels({ViewModelStoreOwner})

2 つめは by viewmodels ({requireParentFragment()}) のように
親の Fragment を与えたりして、
別の FragmentViewModel のスコープとして与えることができます。

3. by viewmodels { ViewModelProvider.Factory }

3 つめは by viewmodels { myFactory } として
ViewModel を作成するようなファクトリのインスタンスを与えるパターンです。

これは Dagger で ViewModelProvider.Factory@Inject するケースで使えますね。


両方の引数を与えたときはどちらも考慮される感じです:
https://android.googlesource.com/platform/frameworks/support/+/refs/heads/androidx-master-dev/lifecycle/viewmodel/ktx/src/main/java/androidx/lifecycle/ViewModelProvider.kt#54

べんり!

mangano-ito
Web + アプリ (Android) エンジニアです。
https://mangano-ito.hatenablog.com/
hatena-corp
「知る」「つながる」「表現する」で新しい体験を提供し、人の生活を豊かにする
https://hatenacorp.jp/
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした