在 Android 中通过 Hilt 进行依赖项注入

image

DI (依赖项注入) 是一种在程序设计中被广泛使用的技术,非常适合 Android 开发,该技术可以将依赖项提供给类,从而让类不必自己创建这些依赖。通过遵循 DI 原则,您将为良好的应用架构、更高的代码复用性和便捷的测试奠定基础。您是否尝试过在应用中进行手动依赖项注入?即使使用了当今许多现有的依赖项注入库,随着您的项目越来越大,这些库仍需要大量模板代码,因为您必须手动构造每个类及其依赖项,并创建容器用来复用和管理依赖项。

通过遵循 DI 原则,您将为良好的应用架构、更高的代码复用性和便捷的测试奠定基础。

通过为项目中的每个 Android 类提供容器并自动管理其生命周期,新的 Hilt 库 定义了一种在应用中进行 DI 的标准方式。Hilt 目前处于 alpha 阶段,请在您的应用中进行尝试,并向我们 提供反馈

Hilt 在热门 DI 库 Dagger 的基础上构建而成,因而能够受益于 Dagger 的编译时正确性、运行时性能、可伸缩性和 Android Studio 支持。如需了解详情,请参阅《Dagger 导航从未如此简单 | Android Studio 4.1》。正因如此,在 Google Play 商店前 10k 的顶级应用中,其中 74% 都广泛使用了 Dagger。但是,由于在编译期生成代码,构建时间会有所增加。

由于许多 Android Framework 中的类都是由操作系统自身实例化的,因此在 Android 应用中使用 Dagger 时,会存在与此相关的模板代码。不同于 Dagger,Hilt 集成了 Jetpack 库以及 Android Framework 中的类,并移除了大部分模板代码,使您可以专注于定义和注入绑定中的重要环节,而无需担心管理 Dagger 的配置和关联。Hilt 可以自动生成并提供如下内容:

  • 用于集成 Android Framework 类与 Dagger 的组件,避免了手动创建
  • Hilt 自动生成组件的作用域注解
  • 预定义的绑定以及限定符

最重要的是,由于 Dagger 和 Hilt 可以共存,您可以根据需要迁移应用。

Hilt 实战

为了向您展示 Hilt 的易用性,我们将通过一个典型的 Android 应用来演示一些快速 DI。让我们使用 Hilt 将 AnalyticsAdapter 注入到 MainActivity 中。

首先,在您的 Application 类上添加 @HiltAndroidApp 注解,从而使您的应用开启 Hilt,触发 Hilt 的代码生成:

@HiltAndroidApp
class MyApplication : Application() { ... }

其次,通过使用 @Inject 注解修饰 AnalyticsAdapter 的构造函数,注明 Hilt 如何提供其实例:

class AnalyticsAdapter @Inject constructor() { ... }

第三,为了将 AnalyticsAdapter 实例注入到 MainActivity 中,需要为 Activity 添加 @AndroidEntryPoint 注解以启用 Hilt,并通过 @Inject 注解修饰字段执行注入:

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
  @Inject lateinit var analytics: AnalyticsAdapter
  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    // analytics 实例已经通过 Hilt 赋值,并且可以使用
  }
}

更多信息,请在文末备忘单中轻松查看新注解的功能。

对 Jetpack 的支持

您可以通过 Hilt 轻松使用您喜欢的 Jetpack 库。在此版本中,我们支持 ViewModel 和 WorkManager 直接注入。

举个例子,向 LoginActivity 中注入一个 组件架构 ViewMode —— LoginViewModelm: 给 LoginViewModel 增加 @ViewModelInject 注解,然后就可以如您所愿在 Activity 或 Fragment 中使用。

class LoginViewModel @ViewModelInject constructor(
  private val analyticsAdapter: AnalyticsAdapter
): ViewModel { ... }
@AndroidEntryPoint
class LoginActivity : AppCompatActivity() {
  private val loginViewModel: LoginViewModel by viewModels()
  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    // loginViewModel 已经可以被使用
  }
}

了解有关 Jetpack 支持的更多信息,请查阅: Android 官方文档|Hilt 和 Jetpack 集成

开始使用 Hilt

如果您已经对 Hilt 感兴趣,并希望了解更多信息,我们整理了如下指南帮您了解如何 将 Hilt 添加到您的 Android 应用

文档

如果您对 DI 或 Dagger 还有些陌生,请查看上面的指南,将 Hilt 添加到 Android 应用。如果您已经了解 Dagger,请查看 dagger.dev/hilt 内提供的文档。如果您仅想了解新注解以及可以通过 Hilt 做什么,请您查看并收藏文末的备忘单。

面向 Dagger 使用者

如果您已经在应用中使用 Dagger 或者 dagger.android,查看 迁移指南 或者下文提及的 Codelab 可以帮助您切换到 Hilt。由于 Dagger 和 Hilt 可以共存,您可以逐步迁移您的应用。

Codelab

我们发布了如下两个 Codelab,手把手教您使用 Hilt:

示例代码

您是否想在现存应用中查看如何使用 Hilt?请查阅以下资源:

反馈

Hilt 目前处于 1.0.0-beta01 版本,如果您在使用中出现任何问题,请及时向我们 反馈问题

备忘单

备忘单 可以让您快速查看 Hilt 和 Dagger 注解的功能差异以及如何使用它们。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容