Jetpack-Hilt总结

1、使用前提:

必须自定义一个Application,并加上@HiltAndroidApp注解,否则Hilt无法正常工作

2、选择指定依赖注入的入口:

为什么用选择,是因为可以被注入的入口已经被限制死了,一共6个:


Jetpack-Hilt总结_第1张图片
依赖入口.png

想在哪个组件里进行依赖注入,就在头上加对应注解。

3、简单依赖注入:---@Inject

3.1、依赖注入类的生成:

在需要变成可注入类class X的构造函数前加上@Inject注解即可。

3.2、注入:

在入口类中,申明X类型的变量x,并给其添加@Inject注解即可。

4、复杂依赖注入:

4.1、带参数的依赖注入:

class X @Inject constructor(val y:Y)

此时只要对Y的构造函数加@Inject注解让其变成可注入类即可,如果Y的构造函数也有参数,以此类推。

4.2、接口的依赖注入:---工厂模块+@Qualifier+@Binds

接口:interface X    。接口实现类:  class XImpl1    /  class XImpl2
4.2.1、单实现类:对接口的实现类进行简单依赖注入即可。
4.2.2、多实现类(同样适用一个类对应多个子类型):需要自定义一个提供实现类的“工厂模块”:

步骤:

  1. 创建一个“工厂模板”类,并提供两个方法,入参是X的不同实现类,返回接口是X
class XModule{
 fun providerXimpl1(x1:XImpl1):X

   fun providerXimpl2(x2:XImpl2):X
}
  1. 给模板类加上2个注解:
    @Module // 这个好理解,表示模块
    @InstallIn(ActivityComponent::class) //这个也是字面意思,安装到xxxx中,第5部分详细说

  2. 对每一个实现类型创建其特有注解,用@Qualifier,表示修饰:

@Qualifier
@Retention(AnnotationRetention.BINARY)
annotationn class BindXImpl1

@Qualifier
@Retention(AnnotationRetention.BINARY)
annotationn class BindXImpl2
  1. 最后给模板类中的方法加上2个注解:
    @第三步自定义的注解
    @Binds // 表示用于获取依赖注入真正的接口实现类型

最后完整的样子:

@Module 
@InstallIn(ActivityComponent::class)class XModule{

    @BindXImpl1
    @Binds
     fun providerXimpl1(x1:XImpl1):X
    
    @BindXImpl2
    @Binds
    fun providerXimpl2(x2:XImpl2):X
}
  1. 在使用的地方,不仅保留@Inject,也要同步加上自定义的注解:
@BindXImpl1
@Inject
latainit var x1:X

4.3、第三方提供的类的依赖注入 ---工厂模块+@Provides

解决方案和4.2用@Module类似,有一点小区别
相同的是还是创建一个模板类,加上2个注解,@Module@InstallIn(ActivityComponent::class),提供一个方法,返回类型就是第三方的类型;
不同的是方法上的注解不用@Binds了,并且也不用自定义注解了,而是用@Provides

5、InstallIn作用域以及和依赖注入入口的区别

InstallIn这个注解表示的是可注入类X能被注入的范围,即X的作用域,比如@InstallIn(ActivityComponent::class),表示这个可注入类实例只能在Activity和activity所包含的Fragment/View中使用,其他地方不能用,比如service中不能用,用了就报错,并且[图片上传中...(image.png-324eb7-1621056572551-0)]
同一个作用域下面共享的是同一个注入实例
与依赖入口的
区别其实就相当于化学课中的玻璃瓶和浓硫酸,玻璃瓶就是入口,表示提供了存放浓硫酸(依赖注入)的能力,至于你放不不放浓硫酸,你爱放不放,放别的也可以,但是浓硫酸要求只能放在玻璃瓶(作用域)里,别的材料的瓶子不能存放,放了就腐蚀给你看。
InstallIn括号中可用的
值**是有限制的,有下面7个值:

Jetpack-Hilt总结_第2张图片

7个组件对应不同的作用域如上表,但是作用域之间的关系不是完全的互斥,而是某些作用域之间存在包含关系,如下图:

Jetpack-Hilt总结_第3张图片

比如@Singleton注解的箭头可以指向所有地方。而@ServiceScoped注解的箭头无处可指,所以只能限定在Service自身当中使用。@ActivityScoped注解的箭头可以指向Fragment、View当中。

6、安卓内部预设的Qualifier

1、Context的预设:

安卓中最常用的Context,实例都是安卓系统去创建的,开发者也没有权限去修改其代码的构造函数,但是也是可以注入的,并且不用自己写@Module提供工厂模板,安卓已经提供了类似的预设Qualifier,比如context对应的Qualifier为:@ApplicationContext@ActivityContext等,入参是context的地方参数前加上这个注解即可,当然,具体用哪个要结合注解作用域,比如@SingleTon的话就需要用ApplicationContext,而不能用ActivityContext。

2、Application和Activity的预设:

不用添加任何注解,Hilt默认就能自动识别。注意,只能是这两个类型,这两个类型的子类型还是要用@Provides工厂模板+向下转型的方式提供一下的。

你可能感兴趣的:(Jetpack-Hilt总结)