injecting viewmodel with navigation-graph scope: NavController is not available before onCreate()
In short, you could provide the ViewModel
lazily with dagger Provider
or Lazy
.
The long explanation is:
Your injections points are correct. According to https://dagger.dev/android#when-to-inject
DaggerActivity calls AndroidInjection.inject() immediately in onCreate(), before calling super.onCreate(), and DaggerFragment does the same in onAttach().
The problem is some kind of race condition between when Android recreates the Activity
and the Fragments
attached to the FragmentManger
and when the NavController
can be provided. More specifically:
- one
Activity
that hasFragments
attached is destroyed by the OS (can be reproduced with "don't keep Activities" from "developer settings") - user navigates back to the
Activity
, OS proceeds to recreate theActivity
Activity
callssetContentView
while being recreated.- This causes the
Fragments
in theFragmentManager
to be reattached, which involve callingFragment#onAttach
- The
Fragment
is injected inFragment#onAttach
- Dagger tries to provide the
NavController
BUT you cannot get the NavController
from the Activity
by this point, as Activity#onCreate
has not finished yet and you get
IllegalStateException: NavController is not available before onCreate()
The solution I found is to inject provide the NavCotroller
or things that depend on the NavController
(such as the ViewModel
, because Android needs the NavController
to get nav-scoped VideModels
) lazily. This can be done in two ways:
- with
Lazy
- with
Provided
(REF: https://proandroiddev.com/dagger-2-part-three-new-possibilities-3daff12f7ebf)
ie: inject the ViewModel
to the Fragment
or implementation of navigator like this:
@Inject
lateinit var viewModel: Provider<ViewModel>
then use it like this:
viewModel.get().events.observe(this) {....}
Now, the ViewModel
can by provided by Dagger like:
@Provides
fun provideViewModel(
fragment: Fragment,
argumentId: Int
): CreateMyViewModel {
val viewModel: CreateMyViewModel
by fragment.navGraphViewModels(R.id.nested_graph_id)
return viewModel
}
Dagger won't try to resolve the provisioning when the Fragment
is injected, but when it's used, hence, the race condition will be solved.
I really hate not being able to use my viewModels directly and need to use Provider
, but it's the only workaround I see to solve this issue, which I'm sure it was an oversight by Google (I don't blame them, as keeping track of the absurd lifecycle of Fragment and Activities is so difficult).