目录
前 言
Hilt接入
Hilt应用
构造函数注入
模块注入
组件对应生命周期
每个组件的作用域注释
Hilt 中的预定义限定符
定义
注入
使用
为接口或者抽象对象注入使用@Binds
创建
注入
使用
总结
前 言
在学习今天的Hilt之前,我们要先来聊聊依赖注入。那什么是依赖注入呢?先给大家举一个简单的例子:现在有两个class类,分别是A和B,在A这个类里面我们想使用B这个类里面的成员方法或者是设置B的属性值,我们通常的做法就是在A这个类里面new一个B的对象b,然后根据b这个对象去调用里面的setter方法修改里面的属性值或者是调用b的成员方法。其实我们把这种setter的形式就叫做注入,把这种创建对象的过程叫做依赖关系。常见的依赖注入分为setter注入,构造方法注入,接口注入。
那么学习Hilt依赖注入有什么好处呢?就如上述例子所说,我们不学Hilt也可以实现依赖注入嘛,那为什么还要学习呢?答案是:解耦。如上所说,我们在A的类里面通过new得到了B的对象,假如现在有N多个类,需要用到Class B,那就需要在类里面实例化N多次,这样对于后期的维护和管理都是不方便的,如果后期需求发生改变,那更改量有大很多。稍微厉害一点的同学有可能会想到工厂模式,但是工厂模式也有一定的局限性。再来看一个例子:比如我们吃饭的时候需要一双筷子,那么我们应该去找两根木头,来把它削一下,变成一双筷子,然后再使用。(这就对应的是我们的传统new对象的模式)。稍微高级一点,我们去街上买,筷子由加工厂生产,我们无需关心它是怎么制作的。(这就是Java里面简单的工厂设计模式)。再高级一点就是,我们发出一个指令,筷子它自动就到你手上了。(这就是我们要学的hilt依赖注入)。
Hilt接入
在project级别下的build.gradle
dependencies { classpath "com.android.tools.build:gradle:4.0.1" classpath 'com.google.dagger:hilt-android-gradle-plugin:2.28-alpha' }
讯享网
在app级别的build.gradle
讯享网//kotlin kpt,使用Java的可以不用导入 apply plugin: 'kotlin-kapt' apply plugin: 'dagger.hilt.android.plugin'
def hilt_version = "2.28-alpha" implementation "com.google.dagger:hilt-android:$hilt_version" //ktolin语言用kpt kapt "com.google.dagger:hilt-android-compiler:$hilt_version" //Java用apt annotationProcessor "com.google.dagger:hilt-android-compiler:$hilt_version"
Hilt应用
这里我用Java代码作为我们的主程序开发,首先新建一个Application,在Application上面加上@HiltAndroidApp注解。生成的这一 Hilt 组件会附加到 Application对象的生命周期,并为其提供依赖项。此外,它也是应用的父组件,这意味着,其他组件可以访问它提供的依赖项。
讯享网@HiltAndroidApp public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); } }
在需要注入的组件里面添加@AndroidEntryPoint注解
@AndroidEntryPoint public class MainActivity extends AppCompatActivity { }
下面我们用hilt来创建一个对象,通常我们使用构造函数注入和模块注入。
构造函数注入
在某个类的构造函数中使用 @Inject 注释,以告知 Hilt 如何提供该类的实例。
讯享网public final class Car { private String tyre; private String engine; @Inject public Car() { Log.d("Car","这是一辆汽车"); } }
在Android组件使用
@Inject Car car;
注意:由 Hilt 注入的字段不能为私有字段。尝试使用 Hilt 注入私有字段会导致编译错误。
模块注入
Hilt 模块是一个带有 @Module 注释的类。它会告知 Hilt 如何提供某些类型的实例。必须使用 @InstallIn 为 Hilt 模块添加注释,以告知 Hilt 每个模块将用在或安装在哪个 Android 类中。
讯享网@Module @InstallIn(ActivityComponent.class) public final class BeanModule { @Provides public Person providesPerson(){ return new Person(); } }
对于您可以从中执行字段注入的每个 Android 类,都有一个关联的 Hilt 组件,您可以在 @InstallIn 注释中引用该组件。每个 Hilt 组件负责将其绑定注入相应的 Android 类。
组件对应生命周期
| 组件 |
创建时机 |
销毁时机 |
| SingletonComponent/ |
Application#onCreate() |
Application#onDestroy() |
| ActivityRetainedComponent |
Activity#onCreate() |
Activity#onDestroy() |
| ServiceComponent |
Service#onCreate() |
Service#onDestroy() |
| ActivityComponent |
Activity#onCreate()
|
Activity#onDestroy() |
| ViewModelComponent |
ViewModel#super() |
ViewModel#clear() |
| FragmentComponent |
Fragment#onAttach() |
Fragment#onDestroy() |
| ViewComponent |
View#super() |
视图销毁时 |
| ViewWithFragmentComponent |
View#super() |
视图销毁时 |
注意:Hilt 不会为广播接收器生成组件,因为 Hilt 直接从 ApplicationComponent 注入广播接收器。
每个组件的作用域注释
| Android 类 |
生成的组件 |
作用域 |
| Application |
ApplicationComponent/SingletonComponent |
@Singleton |
| View Model |
ActivityRetainedComponent |
@ActivityRetainedScope |
| Activity |
ActivityComponent |
@ActivityScoped |
| Fragment |
FragmentComponent |
@FragmentScoped |
| View |
ViewComponent |
@ViewScoped |
| 带有 @WithFragmentBindings 注释的 View |
ViewWithFragmentComponent |
@ViewScoped |
| Service |
ServiceComponent |
@ServiceScoped |
Hilt 中的预定义限定符
如果您需要让 Hilt 以依赖项的形式提供同一类型的不同实现,必须向 Hilt 提供多个绑定。您可以使用限定符为同一类型定义多个绑定。限定符是一种注释,当为某个类型定义了多个绑定时,您可以使用它来标识该类型的特定绑定。
例如,在模块注入中需要提供多个同一类型不同的对象,则需要添加限定符,你可以把限定符理解为一个标签,用于区分多个不同对象。
定义
@Qualifier @Retention(RetentionPolicy.RUNTIME) public @interface Female { } @Qualifier @Retention(RetentionPolicy.RUNTIME) public @interface Male { }
注入
讯享网 @Provides @Male public Person providesPersonMale() { Person person = new Person(); person.setSex("男"); return person; } @Provides @Female public Person providesPersonFemale() { Person person = new Person(); person.setSex("女"); return person; }
使用
@Inject @Male Person mMale; @Inject @Female Person mFemale;
为接口或者抽象对象注入使用@Binds
创建
讯享网public interface Engine { void on(); void off(); }
注入
@Module @InstallIn(ActivityComponent.class) public interface ApiModule { @Binds Engine bindsEngine(Car car); }
使用
讯享网 @Inject Engine engine;
我们先来简单说一下@Binds是如何使用的,首先要创建一个接口,用一个类来实现这个接口,再在模块里面完成注入。值得注意的是,该模块类也必须是一个接口,否则会报错。
总结
由于 Android 操作系统会实例化它自己的许多框架类,因此在 Android 应用中使用 Dagger 要求您编写大量的样板。Hilt 可减少在 Android 应用中使用 Dagger 所涉及的样板代码。Hilt 会自动生成并提供以下各项:
- 用于将 Android 框架类与 Dagger 集成的组件 - 您不必手动创建。
- 作用域注释 - 与 Hilt 自动生成的组件一起使用。
- 预定义的绑定 - 表示 Android 类,如
Application或Activity。 - 预定义的限定符 - 表示
@ApplicationContext和@ActivityContext。
Dagger 和 Hilt 代码可以共存于同一代码库中。不过,在大多数情况下,最好使用 Hilt 管理您在 Android 上对 Dagger 的所有使用。
代码地址:https://gitee.com/yanganjunXB/hilt-demo.git


版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/50776.html