Hilt是什么?
Hilt Google开源的一个 Android 的依赖注入库,其实是基于 Dagger。
Hilt 是专门为android打造的 ,可以使我们的代码 尽量的简化
Hilt 创建了一组标准的 组件和作用域。这些组件会自动集成到 Android 程序中的生命周期中。在使用的时候可以指定使用的范围,事情作用在对应的生命周期当中。
Hilt如何使用?
(1)在项目的build.gradle中添加引用
dependencies {
...
classpath 'com.google.dagger:hilt-android-gradle-plugin:2.28-alpha'
}
}
(2)在App的build.gradle中添加plugin的引用的依赖
apply plugin: 'kotlin-kapt'
apply plugin: 'dagger.hilt.android.plugin'
dependencies {
implementation "com.google.dagger:hilt-android:2.28-alpha"
kapt "com.google.dagger:hilt-android-compiler:2.28-alpha"
}
Hilt的简单用法
(1)hlit初始化
每个 Android 程序中都会有一个 Application,如果要是用hlit必须要自定义一个 Application 才行,否则 Hilt 将无法正常工作。
@HiltAndroidApp
class BaseApplication : Application() {
override fun onCreate() {
super.onCreate()
}
}
(2)hlit支持的入口
hlit 一共支持6个入口点
- Application
- Activity
- Fragment
- View
- Service
- BroadcastReceiver
这些都是android的基础控件 ,注意的是其中没有contentProvider 因为contentProvider的生命周期比较特殊,他是在Application的onCreate之前就已经完成初始化了 ,而hlit实在Application中完成初始化的,所以自带的入口点里面是没有contentProvider的。
关于注解的声明:只有 Application 这个入口点是使用 @HiltAndroidApp 注解来声明的。其他的所有入口点,都是用 @AndroidEntryPoint 注解来声明的。
如果在一个activity中使用注解
@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
}
}
注意点:
如果使用 @AndroidEntryPoint 注解 Android 类,还必须注解依赖他的 Android 类;
例如: 给 fragment 使用 @AndroidEntryPoint 后,则还需要给 fragmet 依赖的 Activity 依赖@AndroidEntryPoint ,否则会出现异常
@AndroidEntryPoint 不能以写在抽象类上
(3)hlit 完成简单的实例化
- 声明对象
class Test @Inject constructor(){
fun test() {
println("I am a Test test")
}
}
- 在添加注解的activity有中调用
@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
@Inject
lateinit var test: Test
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
test.test()
}
}
-
输出结果
image.png 注意
Hilt 注入的字段是不可以声明成 private 的
*声明需要参数的类
class Test @Inject constructor(var testPar: TestPar){
fun test() {
println("I am a Test test")
}
}
里面的参数同样需要添加注解支持
class TestPar @Inject constructor(){
}
(4)hilt 完成接口实例化
- 声明接口
interface Animal {
fun call()
}
- 编写实现类 并使用 @Inject
class Cat @Inject constructor() : Animal {
override fun call() {
println("miao miao")
}
}
class Dog @Inject constructor() : Animal {
override fun call() {
println("wang wang")
}
}
- 声明实现类的不同注解
@Qualifier
@Retention(AnnotationRetention.BINARY)
annotation class BindDog
@Qualifier
@Retention(AnnotationRetention.BINARY)
annotation class BindCat
- 编写实现类接口对应的module
@Module
@InstallIn(ActivityComponent::class)
abstract class AnimalModel {
@BindDog
@Binds
abstract fun bindDig(dog: Dog): Animal
@BindCat
@Binds
abstract fun bindCat(cat: Cat): Animal
}
- 在实现类中显示
class Test @Inject constructor(var testPar: TestPar){
@BindDog
@Inject
lateinit var dog: Animal
@BindCat
@Inject
lateinit var cat: Animal
fun test() {
dog.call()
cat.call()
println("I am a Test test1")
}
}
-
最终输出结果
image.png
(5)Hilt内置组件和组件作用域
InstallIn,就是安装到的意思。那么 @InstallIn(ActivityComponent::class),就是把这个模块安装到 Activity 组件当中。同事这个也是对他的一种限制,表示只能在Activity 中只用。 Activity 中包含的 Fragment 和 View 也可以使用,但是除了 Activity、Fragment、View 之外的其他地方就无法使用了.
下面是一张简单的作用域和范围的表格
使用作用范围表示在作用范围内是单例的。
(6)预置Qualifier
在android中与java不同的 android中打部分时候 头需要传递一个比较重要的函数Context,但是现在Context 有没有加上hilt对应的注解 那么我们改如何在传参是设置 Context呢?
这我们就用到了 hilt 预置的函数
预定义的绑定 - 表示 Android 类,如 Application 或 Activity。
预定义的限定符 - 表示 @ApplicationContext 和 @ActivityContext。
写的时候这样写
class Test @Inject constructor(@ApplicationContext var context: Context){
@BindDog
@Inject
lateinit var dog: Animal
@BindCat
@Inject
lateinit var cat: Animal
fun test() {
dog.call()
cat.call()
println("I am a Test test1")
}
}
这样就可以添加Context关键字了