Dagger Hilt - ViewModel的依赖注入及实现原理

简介: Dagger Hilt VIewModel 依赖注入的原理

在这里插入图片描述

Dagger Hilt

Hilt是谷歌最新发布的DI库,降低了Android中Dagger的使用成本,支持各种常见Android组件的注入,也包括我们常用的ViewModel。

Dagger Hilt - Android官方推荐的依赖注入框架
一文中介绍了ViewModel的注入方法,使用起来非常简单:

class ActivityViewModel @ViewModelInject constructor(
    private val repository: Repository,
    @Assisted private val savedState: SavedStateHandle
) : ViewModel() {

}
@AndroidEntryPoint
class MainActivity : AppCompatActivity(R.layout.activity_main) {

    private val viewModel by viewModels<ActivityViewModel>()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

    }
}

ViewModle创建需要借助ViewModel.Factory、而非构造函数直接创建。上面整个注入过程并没有自定义任何factory,仅仅@ViewModelInject一个注解就搞定了,这是怎么实现的呢?

viewModels{...}

viewModels{...}是一个继承Lazy<>的ktx扩展,可以通过by关键字方便地创建ViewModel,以前我在airbnb的Mvrx中见到过类似用法,看来是被Jetpack借鉴了。

官方自然不只是简单的借(chao)鉴(xi),里面自有其玄机

@MainThread
inline fun <reified VM : ViewModel> ComponentActivity.viewModels(
    noinline factoryProducer: (() -> Factory)? = null
): Lazy<VM> {
    val factoryPromise = factoryProducer ?: {
        // ComponentActivity#getDefaultViewModelProviderFactory()
        defaultViewModelProviderFactory
    }

    return ViewModelLazy(VM::class, { viewModelStore }, factoryPromise)
}

通过源码知道,ViewModel.Factory默认使用了defaultViewModelProviderFactory。所以只要重写这个defaultViewModelProviderFactory,就可以hook自定义实现进去

重写getDefaultViewModelProviderFactory

通过前一篇文章我们知道,Hilt会在编译期修改被注入对象的父类,

@AndroidEntryPoint
class MainActivity : AppCompatActivity(R.layout.activity_main) {

MainActivity原本继承自AppCompatActivity,但经Hilt处理后父类变为了Hilt_MainActivity

@Generated("dagger.hilt.android.processor.internal.androidentrypoint.ActivityGenerator")
public abstract class Hilt_MainActivity extends AppCompatActivity implements GeneratedComponentManager<Object> {
  private volatile ActivityComponentManager componentManager;
...
  @Override
  public ViewModelProvider.Factory getDefaultViewModelProviderFactory() {
    ViewModelProvider.Factory factory = DefaultViewModelFactories.getActivityFactory(this);
    if (factory != null) {
      return factory;
    }
    return super.getDefaultViewModelProviderFactory();
  }
}

HIlt_MainActivity中通过DefaultViewModelFactories.getActivityFactory(this)返回ViewModel.Factory。

public final class DefaultViewModelFactories {

  @Nullable
  public static ViewModelProvider.Factory getActivityFactory(ComponentActivity activity) {
    return getFactoryFromSet(
        EntryPoints.get(activity, ActivityEntryPoint.class).getActivityViewModelFactory());
  }
  //...
}

一句话概括:Hilt通过Dagger生成的Component获取ViewModelFactory

  • EntryPoints.get(activity, ActivityEntryPoint.class)创建并获取ActivityComponent,
  • getActivityViewModelFactory()通过Component内的Module获取Factory

创建ActivityComponent

public final class EntryPoints {

  @Nonnull
  public static <T> T get(Object component, Class<T> entryPoint) {
    if (component instanceof GeneratedComponent) {
      return entryPoint.cast(component);
    } else if (component instanceof GeneratedComponentManager) {
      return entryPoint.cast(((GeneratedComponentManager<?>) component).generatedComponent());
    } 
  }
}
@Generated("dagger.hilt.android.processor.internal.androidentrypoint.ActivityGenerator")
public abstract class Hilt_MainActivity extends AppCompatActivity implements GeneratedComponentManager<Object> {
  private volatile ActivityComponentManager componentManager;
...

  @Override
  public final Object generatedComponent() {
    return componentManager().generatedComponent();
  }
  
  protected ActivityComponentManager createComponentManager() {
    return new ActivityComponentManager(this);
  }

  protected final ActivityComponentManager componentManager() {
    if (componentManager == null) {
      synchronized (componentManagerLock) {
        if (componentManager == null) {
          componentManager = createComponentManager();
        }
      }
    }
    return componentManager;
  }

如上,Hilt_MainActivity继承自GeneratedComponentManager,ActivityComponentManager获取generatedComponent

public class ActivityComponentManager implements GeneratedComponentManager<Object> {

 //...

  protected Object createComponent() {
    return ((ActivityComponentBuilderEntryPoint)
            activityRetainedComponentManager.generatedComponent())
        .activityComponentBuilder()
        .activity(activity)
        .build();
  }
}

最终通过Hilt_MainActivity的ActivityComponentManager获创建ActivityComponent,ActivityComponentManager内部通过activityRetainedComponentManager(借助ViewModel)保证了ActivityComponent的复用。

获取ViewModelFactory

获取ActivityComponent后,通过内部的Model获取ViewModelFactory。
Hilt中提供了ActivityModule,可以InstallIn到ActivityComponent。ActivityModule中定义了Factory的Provider

@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX)
public final class ViewModelFactoryModules {

    /**
     * Hilt Modules for providing the activity level ViewModelFactory
     */
    @Module
    @InstallIn(ActivityComponent.class)
    public abstract static class ActivityModule {

        @NonNull
        @Multibinds
        abstract Map<String, ViewModelAssistedFactory<? extends ViewModel>> viewModelFactoriesMap();

        @Provides
        @IntoSet
        @NonNull
        @DefaultActivityViewModelFactory
        static ViewModelProvider.Factory provideFactory(
                @NonNull Activity activity,
                @NonNull Application application,
                @NonNull Map<String, Provider<ViewModelAssistedFactory<? extends ViewModel>>>
                        viewModelFactories) {
            // Hilt guarantees concrete activity is a subclass of ComponentActivity.
            SavedStateRegistryOwner owner = (ComponentActivity) activity;
            Bundle defaultArgs = activity.getIntent() != null
                    ? activity.getIntent().getExtras() : null;
            SavedStateViewModelFactory delegate =
                    new SavedStateViewModelFactory(application, owner, defaultArgs);
            return new HiltViewModelFactory(owner, defaultArgs, delegate, viewModelFactories)

通过SavedStateViewModelFactory的defaultArgs,将ViewModel所需的参数进行注入

总结

Hilt在编译期改写Activity或者Fragment的父类,获取了自定义的ViewModel.Factory的方法,从而hook了ViewModle的创建过程,对ViewModel进行注入。整个实现过程借助@InstallIn以及@AndroidEntryPoint的注解,本身就是一个Hilt的最佳实践,值得学习和借鉴

参考上一篇 Dagger Hilt - Android官方推荐的依赖注入框架

目录
相关文章
Jetpack Compose中ViewModel、Flow、Hilt、Coil的使用
Jetpack Compose中ViewModel、Flow、Hilt、Coil的使用
2167 0
Jetpack Compose中ViewModel、Flow、Hilt、Coil的使用
|
Java API 调度
Kotlin 中的suspend 关键字
Kotlin 中的suspend 关键字
769 0
|
2月前
|
人工智能 自然语言处理 数据可视化
阿里云百炼大模型服务平台可以做什么?大模型服务与Agent开发,助力用户AI应用落地
本文介绍了阿里云百炼一站式大模型开发与应用平台,作为阿里云在大模型领域的核心产品,百炼汇聚百余款千问系列及主流第三方模型,为开发者提供兼容OpenAI的API接口与全链路模型服务,为企业用户提供可视化应用构建能力。文章从模型推理、独占吞吐、训练调优三大服务维度,到Agent开发中的模板应用、知识库、工作流等工具链,全面阐述其如何降低AI应用门槛。同时,平台为不同需求用户提供Token Plan、节省计划、组合购、资源包等灵活计费模式,新用户更可享超7000万免费tokens的体验额度,帮助开发者与企业从零成本试用到规模化应用,实现AI能力的高效落地。
|
JavaScript 前端开发 jenkins
【前端】vue项目打包Browserslist: caniuse-lite is outdated. Please run: npx update-browserslist-db@latest解决方案
【前端】vue项目打包Browserslist: caniuse-lite is outdated. Please run: npx update-browserslist-db@latest解决方案
4603 0
|
8月前
|
人工智能 算法 API
CAD二次开发的外包流程
国内CAD二次开发正加速迈向AI驱动的生成式设计时代。本文详解AutoCAD/中望/浩辰等平台的技术选型(C++/C#/API)、标准化外包流程、AI集成(生成设计、图纸识别)、Web CAD新趋势及费用周期参考,助力企业高效实现国产替代与智能升级。(239字)
|
Java 关系型数据库 MySQL
基于springboot的电脑商城系统
本研究聚焦3C数码电商系统的技术升级,针对传统架构性能瓶颈与用户体验不足问题,基于SpringBoot微服务框架构建高并发、易扩展的新型电商平台,结合MySQL、B/S架构与Java技术,提升系统稳定性与智能化水平。
|
XML 前端开发 Android开发
一篇文章带你走近Android自定义view
这是一篇关于Android自定义View的全面教程,涵盖从基础到进阶的知识点。文章首先讲解了自定义View的必要性及简单实现(如通过三个构造函数解决焦点问题),接着深入探讨Canvas绘图、自定义属性设置、动画实现等内容。还提供了具体案例,如跑马灯、折线图、太极图等。此外,文章详细解析了View绘制流程(measure、layout、draw)和事件分发机制。最后延伸至SurfaceView、GLSurfaceView、SVG动画等高级主题,并附带GitHub案例供实践。适合希望深入理解Android自定义View的开发者学习参考。
1126 84
|
人工智能 数据可视化 API
自动查文献+写代码+跑数据+出报告!港大开源 Auto Deep Research 搞定科研全流程
Auto-Deep-Research 是一款由香港大学开源的个人 AI 助理,基于模块化多 Agent 架构,专注于深度研究任务,兼容多种大语言模型,并提供一键启动和文件解析等强大功能。
1926 4
自动查文献+写代码+跑数据+出报告!港大开源 Auto Deep Research 搞定科研全流程
|
数据采集 文字识别 JavaScript
视觉分析开发范例:Puppeteer截图+计算机视觉动态定位
本文介绍了在现代互联网中,传统DOM爬虫难以应对动态加载和视觉驱动内容的问题,并提出了“视觉爬虫”的解决方案。通过Puppeteer实现浏览器自动化,结合计算机视觉技术完成页面元素的动态定位与信息提取。文章对比了DOM爬虫与视觉爬虫的技术特点,展示了基于Node.js的核心代码示例,用于小红书平台的视频搜索、播放及截图处理。最后指出,视觉爬虫能够突破传统限制,在强JS渲染和动态内容场景中更具优势,为数据采集提供了新方向。
982 1
视觉分析开发范例:Puppeteer截图+计算机视觉动态定位
|
编译器 Android开发 开发者
带你了解Android Jetpack库中的依赖注入框架:Hilt
本文介绍了Hilt,这是Google为Android开发的依赖注入框架,基于Dagger构建,旨在简化依赖注入过程。Hilt通过自动化的组件和注解减少了DI的样板代码,提高了应用的可测试性和可维护性。文章详细讲解了Hilt的主要概念、基本用法及原理,帮助开发者更好地理解和应用Hilt。
1229 18