带有Hilt的Android上的依赖注入
Jetpack推荐的DI库
依赖项注入(DI)是一种广泛用于编程的技术,非常适合Android开发,该类将依赖项提供给类而不是自己创建。通过遵循DI原则,您将为良好的应用程序体系结构,更高的代码可重用性和易于测试奠定基础。
您是否曾经尝试过在应用程序中进行手动依赖项注入?即使使用当今许多现有的依赖项注入库,由于您的项目越来越大,它仍需要大量样板代码,因为您必须手动构造每个类及其依赖项,并创建容器以重用和管理依赖项。
通过遵循DI原则,您将为良好的应用程序体系结构,更高的代码可重用性和易于测试奠定基础
通过为项目中的每个Android类提供容器并为您自动管理其生命周期,新的Hilt库定义了一种在应用程序中执行DI的标准方法。 Hilt目前处于Alpha状态,请在您的应用中进行尝试,并使用此链接向我们提供反馈。
Hilt基于流行的DI库Dagger构建,因此可以从Dagger提供的编译时间正确性,运行时性能,可伸缩性和Android Studio支持中受益。因此,Dagger在Google Play商店的前10k顶级应用中占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() { ... }
其次,通过注释Hilt的构造函数,告诉Hilt如何提供AnalyticsAdapter
的实例
@Inject
:
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) // 分析实例已由Hilt填充
// and it's ready to be used
}
}
有关更多信息,您可以在下面的备忘单部分中轻松查看新注释的功能
Jetpack支持
在此版本中,提供对ViewModel和WorkManager的直接注入支持。
例如,要将Architecture Components ViewModel注入到LoginActivity
中:用@ViewModelInject
注释LoginViewModel
并使用如您所愿,将其放在活动或片段中:
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 is ready to be used
}
}
在docs中了解有关Jetpack
支持的更多信息。
开始使用Hilt
如果您对Hilt感兴趣,并想进一步了解它,可以通过以下一些资源以自己喜欢的方式学习
Hilt入门
Hilt入门示例 guide.
相关资料
如果您不熟悉DI或Dagger,请查看我们的 guide to add Hilt to an Android app. 另外,如果您已经知道Dagger,我们还提供 documentation on dagger.dev.
如果您只是对新注释以及Hilt的功能感到好奇,请在下面的部分中查看该备忘单。
对于Dagger用户
如果您已经在应用中使用了Dagger或dagger.android
,请查看此 migration guide 或下面提到的代码实验室可帮助您切换到Hilt。由于Dagger和Hilt可以共存,因此您可以逐步迁移应用程序。
代码示例
为了逐步学习Hilt,我们刚刚发布了两个代码实验室::