Android-Jetpack依赖注入框架 - Hilt 入门指南

一. Hilt 介绍

Hilt 是 Android官方在依赖注入库Dagger的基础上二次封装的产物。学习过Dagger的同学一定会发现，Dagger作为依赖注入框架，虽然功能强大，但是较高的学习门槛，使得Dagger在Android上的落地成本很高。为了解决上述问题，Android官方推出了学习门槛更低的Hilt框架。

Hilt 通过为项目中的每个 Android 类提供容器并自动管理其生命周期，提供了一种在应用中使用依赖注入的标准方法。

本文所示的源码请参考：linux-link/HiltUseDemo (github.com)

二. 依赖注入

依赖注入（Dependency Injection，简称DI）还有个容易令人头晕的概念 - 控制反转（Inversion of Control，缩写为IoC）。

控制反转它本质上是一种全新的编程思想，而不是一个技术实现。它主要描述了Java 开发领域对象的创建以及管理的问题：

• 控制 ：指的是对象创建（实例化、管理）的权力；

• 反转 ：控制权交给外部环境（Spring 框架、IoC 容器）；

在传统的开发方式中，一个类里面需要用到很多个成员变量，这些成员变量，都需要依次new出来！在基于IoC思想的开发方式中，对象的创建通过对应的IOC容器(Hilt,Dagger2 框架) 来帮助我们完成实例化对象并赋值。

依赖注入则指的是对象是通过外部注入的方式完成创建。为了方便我们理解何为依赖注入，先来看一个简单的例子：

class User {

    val simple = Simple()

    fun functionA() {
        val count = simple.functionB()
        if (count > 0) {
            // do something.
        } else {
            // do something.
        }
    }
}

User类中的functionA中，依赖Simple类中functionB的结果，为了得到functionB的结果，我们new了一个Simple类。

我们把上面的例子改造成依赖注入的形式：User 的每个实例在其构造函数中接收 Simple 对象作为参数，而不是在初始化时构造自己的 Simple 对象。

class User constructor(val simple: Simple){

    fun functionA() {
        val count = simple.functionB()
        if (count > 0) {
            // do something.
        } else {
            // do something.
        }
    }
}

依赖注入会为我们的应用提供以下优势：

• 重用类以及分离依赖项：更容易换掉依赖项的实现。由于控制反转，代码重用得以改进，并且类不再控制其依赖项的创建方式，而是支持任何配置。

• 易于重构：依赖项成为 API Surface 的可验证部分，因此可以在创建对象时或编译时进行检查，而不是作为实现详情隐藏。

• 易于测试：类不管理其依赖项，因此在测试时，可以传入不同的实现以测试所有不同用例

通过上面的描述可以看出，依赖注入和控制反转是同一个概念的不同角度描述，IOC是一种软件设计思想，DI是这种软件设计思想的一个具体的实现，相比于控制反转，依赖注入更容易理解

三. Hilt 使用

1. 引入 Hilt 依赖

要在Android中使用Hilt，我们首先要引入根目录的build.gradle中引入Hilt的依赖

buildscript {
    repositories {
        google()
        mavenCentral()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:7.0.0"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.21"
        // hilt plugin
        classpath 'com.google.dagger:hilt-android-gradle-plugin:2.38.1'
    }
}

然后在app项目的build.gradle中引入Hilt的依赖

plugins {
    ...
    id 'dagger.hilt.android.plugin'
}

android {
   ...
}

dependencies {
    ...
    implementation 'com.google.dagger:hilt-android:2.38.1'
    kapt "com.google.dagger:hilt-android-compiler:2.38.1"
}

Hilt 使用Java 8功能。如需在项目中启用Java 8，还需要将以下代码添加到 app/build.gradle 文件中。

compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}
kotlinOptions {
    jvmTarget = '1.8'
}

2. Hilt 应用

所有使用 Hilt 的应用都必须包含一个带有 @HiltAndroidApp 注释的 Application 类。@HiltAndroidApp 会触发 Hilt 的代码生成操作，生成的代码包括应用的一个基类，该基类充当应用级依赖项容器。

@HiltAndroidApp
class MyApp : Application() {

}

然后，不要忘了在Androidmanifest.xml中引入Application

3. 将对象注入 Android 类

在 Application 类中设置了 Hilt 且有了应用级组件后。其它的Android类可以使用@AndroidEntryPoint 表明该类会使用Hilt进行依赖注入。

@AndroidEntryPoint
class NormalActivity : AppCompatActivity() {}

Hilt 目前支持以下 Android 类：

• Application（通过使用 @HiltAndroidApp）

• Activity

• Fragment

• View

• Service

• BroadcastReceiver

如果使用 @AndroidEntryPoint 为某个 Android 类添加注解，则还必须为依赖于该类的 Android 类添加注解。例如，如果为某个 Fragment 添加注解，则还必须为使用该 Fragment 的所有 Activity 添加注解。

Hilt 仅支持继承自 ComponentActivity 的 Activity，如 AppCompatActivity。
Hilt 仅支持继承自 androidx.Fragment 的 Fragment。
Hilt 不支持继承自 android.app.Fragment 的 Fragment。

在需要注入的目标对象的构造方法中加上@Inject注解。

import javax.inject.Inject

class Target @Inject constructor() {

    fun print() {
       ...
    }
}

然后在Android类中引入目标对象，同样要添加@Inject注解。这里需要特别注意的是，添加**@Inject**注解的对象，不能被**private**修饰，否则会出现编译报错。

import dagger.hilt.android.AndroidEntryPoint
import javax.inject.Inject

@AndroidEntryPoint
class NormalActivity : AppCompatActivity() {

    @Inject
    lateinit var target: Target

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        ...
        println(target.print())
    }
}

通过上面的步骤，我们使用 Hilt 完成了一次最简单的注入对象到Android类中。可以看到 Hilt 在使用上，远比 Dagger 要简单的多。

4. 使用 @Mdoue 设定 Hilt Module

有时候，类型不能通过构造函数注入。发生这种情况可能有多种原因。例如，不能通过构造函数注入接口。此外，也不能通过构造函数注入不归我们所有的类型，如来自外部库的类。在这些情况下，就可以使用 Hilt 模块向 Hilt 提供绑定信息。

Hilt module是一个带有 @Module 注释的类。与 Dagger 模块一样，它会告知 Hilt 如何提供某些类型的实例。与 Dagger 模块不同的是，必须使用 @InstallIn 为 Hilt 模块添加注释，以告知 Hilt 每个模块将用在或安装在哪个 Android 类中。

使用@Module表示这是一个Hilt Module，@InstallIn(ActivityComponent::class)表示当前 Module 中提供的对象在应用的所有 Activity 中都可以使用。

@InstallIn(ActivityComponent::class)
@Module
object AppModule {

    @Provides
    fun providerTarget3(): Target3 {
        val target = Target3.Builder()
            .setStr("str")
            .build()
        return target
    }
}

5. 使用 @Provides 注入实例

当一个来自外部库，或者必须使用建造者模式创建时，这时我们无法通过在构造方法上添加@``Inject的形式来注入对象的实例，这时候我们就会用到@Provides 。

例如：存在一个类Target3类，它的构造方法被private修饰(@Inject不能注入被private修饰的构造方法)，我们只能通过类中提供的build()来创建Target3类

class Target3 private constructor() {

    private lateinit var string: String

    fun print() {
        println(this.javaClass.simpleName + ":" + string)
    }

    class Builder {
        private val target = Target3();

        fun setStr(string: String): Builder {
            target.string = string
            return this
        }

        fun build(): Target3 {
            return target
        }
    }
}

带有@Provides的方法会向Hilt告知以下信息：

• 方法返回类型会告知 Hilt 函数提供哪个类型的实例。

• 方法参数会告知 Hilt 相应类型的依赖项。

• 方法主体会告知 Hilt 如何提供相应类型的实例。每当需要提供该类型的实例时，Hilt 都会执行方法主体

@InstallIn(ActivityComponent::class)
@Module
object AppModule {

    @Provides
    fun providerTarget3(): Target3 {
        val target = Target3.Builder()
            .setStr("str")
            .build()
        return target
    }
}

然后我们就可以在Activity中使用Target3对象

@AndroidEntryPoint
class ProviderActivity : AppCompatActivity() {

    @Inject
    lateinit var target3: Target3

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        ...
        target3.print()
    }
}

6. 注入 Context

Target2类在逻辑实现上需要使用到Context和Activity还有Target3

class Target2 constructor(
    val context: Context,
    val activity: Activity,
    val target: Target3
) {

    fun print() {
        println(this.javaClass.simpleName + "\n" + context + "\n" + activity + "\n")
        target.print()
    }
}

对于context我们可以使用@ActivityContext和@ApplicationContext来指定我们需要的是Activity的context还是Application的context。

Activity不需要添加任何注解，因为@InstallIn(ActivityComponent::class)存在Hilt会为我们自定注入target2作用域对应的Activity。

Target3对象同样由providerTarget3()为我们自动注入。

@InstallIn(ActivityComponent::class)
@Module
object AppModule {

    @Provides
    fun providerTarget3(): Target3 {
        val target = Target3.Builder()
            .setStr("str")
            .build()
        return target
    }

    @Provides
    fun providerTarget2(
        @ActivityContext context: Context,
        activity: Activity,
        target3: Target3
    ): Target2 {
        return Target2(context, activity, target3)
    }
}

Target2的使用就非常简单了，如下所示。

@AndroidEntryPoint
class ProviderActivity : AppCompatActivity() {

    @Inject
    lateinit var target2: Target2

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        ...
        target2.print()
    }
}

7. 使用 @Binds 注入接口实例

实际开发中，我们经常会使用一个接口的实例，接口是没有构造方法的，这时可以通过@Binds来注入一个接口。@Binds 注释会告知 Hilt 在需要提供接口的实例时要使用哪种实现。

interface ISimple {

    fun print(string: String)

}

定一个抽象的Module，在其中注入接口的实现类，如下所示

@InstallIn(ActivityComponent::class)
@Module
abstract class SimpleModule {

    @Binds
    abstract fun providerISimple(impl: ISimpleImpl): ISimple

}

带有@Binds注解的方法会向 Hilt 提供以下信息：

• 方法返回类型会告知 Hilt 函数提供哪个接口的实例。

• 方法参数会告知 Hilt 要提供哪种实现。

在接口的实现类的构造方法上添加@Inject注解：

class ISimpleImpl @Inject constructor() : ISimple {

    override fun print(string: String) {
        println(this::class.simpleName + ";" + string)
    }

}

使用起来同样非常的简单。

@AndroidEntryPoint
class AbsActivity : AppCompatActivity() {

    @Inject
    lateinit var simple: ISimple

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        ...
        simple.print("ISimple!!")
    }
}

抽象类的注入与接口的注入完全相同，源码请参考文末提供的源码。

8. 注入同一类型的不同实例

有的时候，在项目我们会经常使用同一个类的不同的实例，Module中返回同样类型的方法，还需要做些额外的操作。

首先我们需要使用@Qualifier来定义一个用来区分不同Target对象实例的注解。

@Qualifier
@Retention(AnnotationRetention.BINARY)
annotation class TargetType1()

@Qualifier
@Retention(AnnotationRetention.BINARY)
annotation class TargetType2()

然后在Module中用定义好的注解，来区分不同的Target注入方式

@InstallIn(ActivityComponent::class)
@Module
object AppModule2 {

    @TargetType1
    @Provides
    fun providerTarget4Type1(): Target4 {
        return Target4();
    }

    @TargetType2
    @Provides
    fun providerTarget4Type2(): Target4 {
        return Target4();
    }
}

最后，在使用时也要添加注解来区分不同对象实例。

@AndroidEntryPoint
class MultiActivity : AppCompatActivity() {

    @TargetType1
    @Inject
    lateinit var target4Type1: Target4

    @TargetType2
    @Inject
    lateinit var target4Type2: Target4

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_multi)
        println(target4Type1)
        println(target4Type2)
    }
}

9. Hilt 与 ViewModel 联合使用

Hilt 支持多种对象类型的注入，比如我们最常使用的ViewModel，在注入ViewModel之前，我们需要引入额外的依赖。

dependencies {
    ...
    implementation "androidx.hilt:hilt-lifecycle-viewmodel:1.0.0-alpha03"
    kapt "androidx.hilt:hilt-compiler:1.0.0"
    // 不是必须的，但是会方便我们使用 ViewModel 的KTX方法
    implementation 'androidx.activity:activity:1.1.0'
    implementation 'androidx.fragment:fragment-ktx:1.2.5'
}

在ViewModel中使用@HiltViewModel标记ViewModel，并在构造方法上添加@Inject。

@HiltViewModel
class SimpleViewModel @Inject constructor(
    val repository: SimpleRepository
) : ViewModel() {

    fun getData() {
        repository.getData()
    }

}

由于ViewModel的构造方法中引入SimpleRepository，所以我们需要在SimpleRepository的构造方法上添加@``Inject注解。

class SimpleRepository @Inject constructor() {

    fun getData() {
        println("getData")
    }
}

最后，在Activity中引入SimpleViewModel。

@AndroidEntryPoint
class ViewModelActivity : AppCompatActivity() {

    private val viewModel: SimpleViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_view_model)
        viewModel.getData()
    }
}

四. 组件的作用域

默认情况下，Hilt 中的所有绑定都未限定作用域。这意味着，每当应用请求绑定时，Hilt 都会创建所需类型的一个新实例。Hilt 也允许将绑定的作用域限定为特定组件。Hilt 只为绑定作用域限定到的组件的每个实例创建一次限定作用域的绑定，对该绑定的所有请求共享同一实例。

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

举个例子：如果我们希望对象的实例是一个单例。首先需要指定Module安装到

SingletonComponent上，然后在provider方法中指定其作用域为@Singleton，这样Target5在App的生命周期内，只会存在一个实例。

@InstallIn(SingletonComponent::class)
@Module
object AppModule3 {

    @Singleton
    @Provides
    fun providerTarget():Target5{
        return Target5()
    }
}

在举个例子，如果我们希望对象的实例，在Activity的生命周期中只存在一个实例，我们可以指定它的作用域为@``ActivityScoped。

@InstallIn(ActivityComponent::class)
@Module
object AppModule3 {

    @ActivityScoped
    @Provides
    fun providerTarget():Target5{
        return Target5()
    }
}

五. 组件的生命周期

Hilt 会按照相应 Android 类的生命周期自动创建和销毁生成的组件类的实例。

生成的组件	创建时机	销毁时机
ApplicationComponent	Application#onCreate()	Application#onDestroy()
ActivityRetainedComponent	Activity#onCreate()	Activity#onDestroy()
ActivityComponent	Activity#onCreate()	Activity#onDestroy()
FragmentComponent	Fragment#onAttach()	Fragment#onDestroy()
ViewComponent	View#super()	视图销毁时
ViewWithFragmentComponent	View#super()	视图销毁时
ServiceComponent	Service#onCreate()	Service#onDestroy()

注意：
ActivityRetainedComponent 在配置更改后仍然存在，因此它在第一次调用 Activity#onCreate() 时创建，在最后一次调用 Activity#onDestroy() 时销毁。

六. 总结

通过上面描述，我们就讲完了Android中使用Hilt的基本方式，本文源码请参考：linux-link/HiltUseDemo (github.com)

七. 参考资料

Android 中的依赖项注入 | Android 开发者 | Android Developers (google.cn)

Hilt-依赖注入框架上手指南_petterp的博客-CSDN博客_hilt

作者：林栩
链接：https://www.jianshu.com/p/cb0887d1b834
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。