Android Hilt多Activity复用同一ViewModel报匹配键绑定错误如何解决？

Hilt对同ViewModel类多实例的支持 #

Hilt完全支持不同Activity中创建同一个ViewModel类的不同实例。ViewModel实例默认与其绑定的ViewModelStoreOwner（即每个独立的Activity）绑定，不同Activity注入同一个ViewModel类时，默认就会生成各自独立的实例，你遇到的报错并非Hilt不支持该特性，而是依赖绑定的作用域或注入方式不匹配导致的。

报错原因分析 #

从报错信息可以明确两个核心点：

• 注入第二个Activity的ViewmodelA时，Hilt在当前组件树中找不到TypeA的合法绑定
• TypeA的绑定实际存在于ViewModelComponent组件中

该问题的常见诱因如下：

• 你的TypeA是每个Activity独立传入的动态参数，并非全局可被Hilt检索的绑定，此前用Dagger2自定义ViewModel工厂时是手动传入TypeA实例，绕过了Hilt的自动注入校验
• 提供TypeA的Module被安装到了比ViewModelComponent层级更低的组件（如ActivityComponent、FragmentComponent），Hilt的组件只能访问自身和父层级组件的绑定，无法访问下层组件的绑定
• TypeA的绑定添加了@ActivityScoped这类低层级作用域注解，只能在Activity组件层级使用，无法注入到ViewModel中
• 仅在第一个Activity的专属自定义组件中提供了TypeA绑定，第二个Activity的组件树中没有对应绑定

可行解决方案 #

场景1：TypeA为全局通用实例，不需要和Activity绑定 #

将TypeA的绑定安装到ViewModelComponent或更高层级的组件即可，两种实现方式二选一：

1. 给TypeA类添加@Inject注解的构造方法：

class TypeA @Inject constructor() {
    // 类逻辑
}

2. 编写Module提供TypeA，安装到符合层级要求的组件：

@Module
@InstallIn(SingletonComponent::class) // 也可替换为ActivityRetainedComponent::class、ViewModelComponent::class
object TypeAModule {
    @Provides
    fun provideTypeA(): TypeA = TypeA()
}

场景2：TypeA为每个Activity独立传入的动态参数（对应你之前Dagger2自定义工厂的场景） #

需要使用Hilt的辅助注入@AssistedInject实现手动传参与Hilt自动注入的结合，你当前使用的Hilt 2.37版本完全支持该特性，实现步骤如下：

步骤1：修改ViewModel代码，添加辅助注入配置

@HiltViewModel(assistedFactory = ViewmodelA.Factory::class)
class ViewmodelA @AssistedInject constructor(
    @Assisted val paramA : TypeA, // 标记为需要手动传入的辅助参数
    // 其他需要Hilt自动注入的参数可以照常声明，不需要加@Assisted注解
    val otherAutoInjectParam: OtherInjectType
) {
    // 定义辅助工厂接口
    @AssistedFactory
    interface Factory {
        fun create(paramA: TypeA): ViewmodelA
    }

    // 其他业务逻辑
}

步骤2：在每个Activity中注入工厂，创建ViewModel实例

@AndroidEntryPoint
class YourFirstActivity : AppCompatActivity() {
    // 注入ViewModel辅助工厂
    @Inject lateinit var vmFactory: ViewmodelA.Factory
    
    private val viewModel: ViewmodelA by viewModels {
        object : ViewModelProvider.Factory {
            override fun <T : ViewModel> create(modelClass: Class<T>): T {
                // 传入当前Activity对应的TypeA实例
                return vmFactory.create(paramA = firstActivityTypeAInstance) as T
            }
        }
    }

    // Activity其他逻辑
}

第二个Activity也按照同样的方式传入自身的TypeA实例即可，两个Activity的ViewModel实例完全独立，互不影响。

内容的提问来源于stack exchange，提问作者ACR