Android Studio 4.1 的 Dagger 导航更新

在使用 Dagger 的项目中,您是否由于要弄清楚 Dagger 的依赖关系而产生疑惑?依赖项来自 @Inject 修饰的构造器、@Binds 仍是 @Provides 修饰的方法?它有限定符吗?要搞清楚这个并不是易事。android

难道不能一键获取相关信息甚至获得更多内容吗?固然能够!git

最新的 Android Studio 4.1 版本 (目前已经在稳定版渠道发布) 为咱们带来了一个新的“间距图标” (在编辑器和代码行号之间的图标,以下图所示),经过点击这个图标,咱们能够轻松地在 Dagger 的关联代码间进行导航,包括依赖项的生产者、消费者、组件、子组件以及模块。您一样能够在 Find usages 中获取相同的信息。github

在 Android Studio 4.2 中加入了更多针对 Hilt 的支持,除了上述列出的 Dagger 功能以外,您还能够更便捷使用入口点 (entry points) 导航功能。编辑器

在 Android Studio 中新增的 Dagger 导航支持

在 Android Studio 中新增的 Dagger 导航支持 ide

正如您所看到的,在 Android 应用中 Dagger 关系的导航从未如此简单。新版本 Android Studio 将支持一键精确查找提供依赖项方法的功能。google

实践

在 Android Studio 4.1 Canary 7 以后,您能够在使用 Dagger 的项目中看到一个新的间距图标:.net

Android Studio 中新的 Dagger 间距图标

Android Studio 中新的 Dagger 间距图标3d

它们的点击效果是:code

  • 向上箭头的图标:提供类型的地方(即依赖项来自何处)
  • 树形的图标:类型被看成依赖项使用的地方

让咱们经过 GitHub 上的示例应用 architecture-samples 的 Dagger 分支 (dev-dagger),来展现新功能的使用。component

了解依赖项来自哪里

在一个使用 Dagger 注入的类中,若是您在依赖项上点击带有向上箭头的间距图标,您将跳转到使用 Dagger 注解提供对应类型的方法。

在下面的例子中,TasksViewModel 依赖了 TasksRepository。点击间距图标便可跳转到 AppModuleBinds 类中提供 TasksRepository 对象的 @Bind 方法:

了解依赖项来自哪里

了解依赖项来自哪里

支持限定符

如上所述,若是使用了限定符提供依赖项,此功能将会帮您精确跳转到提供方法处。

DefaultTasksRepository 依赖了被限定符修饰的 TasksDataSource。点击间距图标将跳转到  AppModule 中使用限定符提供对应类型的方法。

支持限定符

支持限定符

依赖项在哪里被使用

当您有一个使用 Dagger 注解提供依赖项的方法时,您能够点击带有向下箭头的间距图标来跳转到依赖项的使用处。若是该依赖项被多个消费者使用,您能够在列表中选择目标进行跳转。

在咱们的项目中,DefaultTasksRepository 使用在了不一样的 ViewModels 中,具体是哪些呢?您能够经过点击提供方法的间距图标来了解(此处使用 @Binds):

了解依赖项在哪里被使用

了解依赖项在哪里被使用

Hilt 入口点

当您在一个 Hilt 的入口点 (entry point) 时,这个间距图标能够帮助您导航到依赖的来源。咱们撰写了一个在 Android 中将 Dagger 迁移到 Hilt 的 codelab,在这个 codelab 里,您可经过 android-dagger-to-hilt 工程的 interop 分支 的代码来试用这个功能。

在入口点能够导航到依赖的来源

在入口点能够导航到依赖的来源

Find Usages 功能

在 Android Studio 中可使用 Find usage 功能找到您 Dagger/ Hilt 代码之间的关系。

若是您右键点击 AppModuleBinds 类的 bindRepository 方法,选择 Find usage,而后就会看到以下相似的界面内容:

为 bindRepository 方法使用 Find usage 功能

为 bindRepository 方法使用 Find usage 功能赶快尝试起来!若是您在使用中出现任何问题,请及时向咱们 反馈问题

相关文章
相关标签/搜索