使用Hilt使用运行时参数实例化viewModel

基础概念

Hilt 是 Google 推出的依赖注入框架，用于简化 Android 应用中的依赖注入。ViewModel 是 Android Architecture Components 的一部分，用于管理 UI 相关的数据，并处理与 UI 控制器的生命周期相关的问题。

优势

简化依赖注入：Hilt 自动处理依赖注入，减少了手动管理依赖的复杂性。
生命周期管理：ViewModel 可以在配置更改（如屏幕旋转）时保持数据，避免了数据丢失。
测试友好：依赖注入使得单元测试和集成测试更加容易。

类型

Hilt 支持多种类型的依赖注入：

构造函数注入：通过构造函数注入依赖。
字段注入：通过字段注入依赖。
方法注入：通过方法注入依赖。

应用场景

Hilt 和 ViewModel 的组合常用于以下场景：

MVVM 架构：在 ViewModel 中管理数据和业务逻辑，UI 控制器（Activity 或 Fragment）负责展示数据和响应用户操作。
跨组件共享数据：ViewModel 可以在配置更改时保持数据，适用于需要跨组件共享数据的场景。

运行时参数实例化 ViewModel

在某些情况下，你可能需要在运行时传递参数来实例化 ViewModel。Hilt 提供了 @AssistedInject 注解来实现这一点。

示例代码

假设我们有一个 UserViewModel，需要根据用户 ID 来实例化：

import androidx.lifecycle.ViewModel
import dagger.hilt.android.lifecycle.HiltViewModel
import javax.inject.Inject

@HiltViewModel
class UserViewModel @Inject constructor(
    private val userId: String,
    private val userService: UserService
) : ViewModel() {
    // 使用 userId 和 userService 进行业务逻辑处理
}

为了在运行时传递 userId，我们需要定义一个接口：

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

interface UserViewModelFactory {
    fun create(userId: String): UserViewModel
}

class UserViewModelFactoryImpl @AssistedFactory constructor(
    private val userService: UserService
) : UserViewModelFactory {
    @AssistedInject
    override fun create(userId: String): UserViewModel {
        return UserViewModel(userId, userService)
    }
}

然后在模块中提供 UserViewModelFactory：

import dagger.Module
import dagger.Provides
import dagger.hilt.InstallIn
import dagger.hilt.components.SingletonComponent

@Module
@InstallIn(SingletonComponent::class)
object AppModule {
    @Provides
    fun provideUserService(): UserService {
        return UserServiceImpl()
    }
}

最后，在 Activity 或 Fragment 中使用 UserViewModelFactory 来实例化 UserViewModel：

import androidx.activity.viewModels
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import dagger.hilt.android.AndroidEntryPoint

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
    private val viewModelFactory: UserViewModelFactory by viewModels()
    private val viewModel: UserViewModel by viewModels { viewModelFactory.create("123") }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        // 使用 viewModel 进行数据展示和处理
    }
}