在 Android 中依赖注入,使用 Hilt

本文为 Manuel Vivo 发布于 Medium 的文章译文
原文链接为 Dependency injection on Android with Hilt
本文仅作为个人学习记录所用。如有涉及侵权,请相关人士尽快联系译文作者。

依赖注入(DI)是一种在编程中广泛使用的技术,非常适合 Android 开发。在 Android 开发中,将依赖项提供给类,而不是自己创建依赖项。 通过遵循 DI 原则,您将为良好的应用程序体系结构,更高的代码可重用性和易于测试奠定基础。 您是否曾经尝试过在应用程序中进行手动依赖项注入? 即使使用当今许多现有的依赖项注入库,由于您的项目越来越大,它仍需要大量样板代码,因为您必须手动构造每个类及其依赖项,并创建容器以重用和管理依赖项。

通过遵循DI原则,您将为良好的应用程序体系结构,更高的代码可重用性和易于测试奠定基础

通过为项目中的每个Android类提供容器并为你自动管理其生命周期,新的Hilt库定义了一种在应用程序中执行DI的标准方法。Hilt目前处于Alpha状态,请在您的应用中进行尝试,并使用此链接向我们提供反馈。

Hilt基于流行的DI库Dagger构建,因此可以从Dagger提供的编译时间正确性,运行时性能,可伸缩性和Android Studio支持中受益。 因此,Dagger在Google Play商店的前1万款应用中占74%的广泛采用率。 但是,由于生成了编译时代码,因此预期编译时间会增加。

由于许多Android框架类都是由操作系统本身实例化的,因此在Android应用中使用Dagger时会有一个关联的样板。 与Dagger不同,Hilt与Jetpack库和Android框架类集成在一起,并删除了大部分样板,使您可以专注于定义和注入绑定的重要部分,而不必担心管理所有Dagger设置和编写。 它会自动生成并提供:

  • 用于将Android框架类与Dagger集成的组件,否则需要手工创建。
  • Hilt自动生成的组件的范围注释。
  • 预定义的绑定和限定符。

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

Hilt 在项目中的实践

为了向您展示Hilt的易用性,让我们在典型的Android应用中执行一些快速DI。 让我们用Hilt将AnalyticsAdapter注入MainActivity。
首先,使用@HiltAndroidApp注释应用程序类以触发Hilt的代码生成,从而在您的应用程序中启用Hilt:

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

其次,通过用@Inject注释其构造函数来告诉Hilt如何提供AnalyticsAdapter的实例:

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

第三,要将AnalyticsAdapter的实例注入MainActivity,请在活动中使用@AndroidEntryPoint批注启用Hilt,并使用@Inject批注执行字段注入:

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
  @Inject lateinit var analytics: AnalyticsAdapter
  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    // analytics instance has been populated by Hilt
    // and it's ready to be used
  }
}

有关更多信息,您可以在下面的备忘单部分中轻松查看新注释的功能。

附带Jetpack支持!

您可以在开箱即用的情况下使用喜爱的Jetpack库。 在此版本中,我们为ViewModel和WorkManager提供直接注入支持。
例如,要将架构组件ViewModel,LoginViewModel注入LoginActivity:用@ViewModelInject注释LoginViewModel并按预期在activity或fragment中使用它:
文档中了解有关Jetpack支持的更多信息。

开始使用Hilt

如果您对Hilt感兴趣,并且想了解更多有关此的信息,请按照以下偏好的方式学习一些资源:

Hilt入门
借助本指南,了解如何在您的Android应用中添加Hilt。

文献资料
如果您是DI或Dagger的新手,请查看我们的指南,将Hilt添加到Android应用中。 另外,如果您已经了解Dagger,我们还将提供有关dagger.dev的文档
如果您只是对新的注解以及Hilt的用途感到好奇,请在以下部分中查看该备忘单。

对于Dagger用户
如果您已经在应用中使用了Dagger或dagger.android,请查看此迁移指南或下面提到的代码实验室,以帮助您切换到Hilt。 由于Dagger和Hilt可以共存,因此您可以逐步迁移应用程序。

代码实验室
为了逐步学习Hilt,我们刚刚发布了两个代码实验室:

代码示例
您想查看在现有应用中如何使用Hilt吗? 在Google I / O 2020应用程序Android体系结构示例Github存储库的dev-hilt分支中检查其用法。

反馈
Hilt目前处于Alpha状态,请在您的应用中进行尝试,并使用此链接向我们提供反馈。

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

cheat-sheet.png

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