使用 Hilt 进行依赖注入时如何将运行时参数传递给 ViewModel 的构造函数？

Question

我想知道如何在将 Hilt 用于 DI 时将运行时参数传递给 ViewModel 的构造函数？在使用 Hilt 之前，我有一个如下所示的 ViewModel：

class ItemViewModel(private val itemId: Long) : ViewModel() {
    private val repo = ItemRepository(itemId) 
}

class ItemViewModelFactory(private val itemId: Long) : ViewModelProvider.Factory {
@Suppress("unchecked_cast")
override fun <T : ViewModel?> create(modelClass: Class<T>): T {
    if (modelClass.isAssignableFrom(ItemViewModel::class.java)) {
        return ItemViewModel(itemId) as T
    }
    throw IllegalArgumentException("Unknown ViewModel class")
}

我在我的片段中创建了上面的 ViewModel，如下所示：

override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {

    val args: ItemScreenFragmentArgs by navArgs()
    val itemId = args.itemId

    //Create the view model factory
    val viewModelFactory = ItemViewModelFactory(application, itemId)

    // Get a reference to the ViewModel associated with this fragment.
    val itemViewModel = ViewModelProvider(this, viewModelFactory).get(ItemViewModel::class.java)
}

如果我的 ItemViewModel 构造函数没有 itemId 参数，则使用 Hilt 的 ViewModel 和 Fragment 将如下所示：

class ItemViewModel
@ViewModelInject
constructor(private val repo: ItemRepository) : ViewModel() { }

@AndroidEntryPoint
class ItemFragment : Fragment() {
    private val itemViewModel: ItemViewModel by viewModels ()
}

我想弄清楚如何将我从 ItemFragment 的 NavArgs 获得的 itemId 传递给 ItemViewModel 的构造函数？有没有办法用 Hilt 做到这一点？

Answer 1

有一个更好的解决方案，无需 AssistedInject，只需使用 SavedStateHandle 即可。

如果片段中的 args 包含 userId：

val args: UserFragmentArgs by navArgs()
...
args.userId

然后只需在您的 savingStateHandle 中即可使用它，无需额外的工作。

class UserViewModel @Inject constructor (
    private val state: SavedStateHandle
) : ViewModel() {

    //Get the value of the userId here
    val userId = state.get<String>("userId")


   //Also you can do this using safe args
   val args = UserFragmentArgs.fromSavedStateHandle(state)
   val userId = args.userId
}

完整实施细节：https://mattrobertson.dev/passing-safe-args-to-your-viewmodel-with-hilt-366762ff3f57

Answer 2

对于其他希望在使用 Dagger Hilt 时将运行时参数传递给 ViewModel 的人，我是这样做的：

我遵循了这个例子中使用AssistedInject库的代码。

我的代码现在如下所示：

class ItemViewModel
@AssistedInject
constructor(private val repo: ItemRepository, @Assisted private val itemId: Long) : ViewModel() {
    init {
        repo.itemId = itemId
    }

    @AssistedInject.Factory
    interface AssistedFactory {
        fun create(itemId: Long): ItemViewModel
    }

    companion object {
        fun provideFactory(
            assistedFactory: AssistedFactory,
            itemId: Long
        ): ViewModelProvider.Factory = object : ViewModelProvider.Factory {
            override fun <T : ViewModel?> create(modelClass: Class<T>): T {
                return assistedFactory.create(itemId) as T
            }
        }
    }
}

@InstallIn(FragmentComponent::class)
@AssistedModule
@Module
interface AssistedInjectModule {}

@AndroidEntryPoint
class ItemFragment : Fragment() {
    private val args: ItemScreenFragmentArgs by navArgs()      
    @Inject lateinit var itemViewModelAssistedFactory: ItemViewModel.AssistedFactory        
    private val itemViewModel: ItemViewModel by viewModels {
            ItemViewModel.provideFactory(itemViewModelAssistedFactory, args.itemId)
    }    
}

Answer 3

Dagger 现在支持辅助注入，并且 InflationInjection 拥有自己的存储库。现在的语法如下：

import dagger.assisted.Assisted
import dagger.assisted.AssistedFactory
import dagger.assisted.AssistedInject
...




class ItemViewModel
@AssistedInject
constructor(private val repo: ItemRepository, @Assisted private val itemId: Long) : ViewModel() {
    init {
        repo.itemId = itemId
    }

    //-@AssistedInject.Factory
    @AssistedFactory
    interface AssistedFactory {
        fun create(@Named("item_id") itemId: Long): ItemViewModel
    }

    companion object {
        fun provideFactory(
            assistedFactory: AssistedFactory,
            itemId: Long
    ): ViewModelProvider.Factory = object : ViewModelProvider.Factory {
         override fun <T : ViewModel?> create(modelClass: Class<T>): T {
             return assistedFactory.create(itemId) as T
         }
       }
    }
}

@InstallIn(FragmentComponent::class)
//-@AssistedModule
@Module
interface AssistedInjectModule {}

@AndroidEntryPoint
class ItemFragment : Fragment() {
    private val args: ItemScreenFragmentArgs by navArgs()      
    @Inject lateinit var itemViewModelAssistedFactory:ItemViewModel.AssistedFactory        
    private val itemViewModel: ItemViewModel by viewModels {
        ItemViewModel.provideFactory(itemViewModelAssistedFactory, args.itemId)
    }    
}

基于雷德克的回答。更多相关内容请点击此处