比Dagger2好用一个量级-Hilt的使用和详解

1 Hilt简介

Hilt 是 Android Jetpack中的依赖注入库，可减少项目代码，用于模块解耦。Hilt是在Dagger基础上进行二次封装构建的，相对Dagger来说，代码量更少，使用更简单。不同的是，Dagger利用注解使用APT去生成辅助代码，而Hilt是利用注解使用APT和ASM(字节码插桩)去生成辅助代码。

Hilt官网：https://dagger.dev/hilt/

Google官网Hilt使用：https://developer.android.com/training/dependency-injection/hilt-android?hl=zh-cn

2 Hilt使用

2.1 引入依赖

根目录build.gradle中添加hilt-android-gradle-plugin插件，最新版本可以在官网查看。

buildscript {
    dependencies {
        classpath 'com.google.dagger:hilt-android-gradle-plugin:2.41'
    }
}

在app目录下build.gradle中添加以下依赖：

...
apply plugin: 'kotlin-kapt'
apply plugin: 'dagger.hilt.android.plugin'

android {
    ...
}

dependencies {
    implementation "com.google.dagger:hilt-android:2.28-alpha"
    kapt "com.google.dagger:hilt-android-compiler:2.28-alpha"
}

2.2 几种常用注解

@Inject用来标注需要依赖获取的对象。

@Module用来标注提供依赖对象的类，也就是Module类，Module类中会有一个方法来提供依赖对象，在这个方法中可以对注入对象的有参构造函数传入参数或者进行其他处理。

@Provides用来标注Module类中的提供依赖对象的方法进行标注，该方法在需要提供依赖时被调用，从而把预先提供好的对象当做依赖给标注了@Inject 的变量赋值。

@HiltAndroidApp 用来标注Application，这个是必须到，如果没有该注解，程序会崩溃。该注解会触发 Hilt 的代码生成操作，生成的代码包括应用的一个基类，该基类充当应用级依赖项容器。

@AndroidEntryPoint表示该类为接受依赖注入的对象，Hilt可以为带有@AndroidEntryPoint注释的Android类提供依赖项。如果使用 @AndroidEntryPoint 为某个 Android 类添加注释，则还必须为依赖于该类的Android类添加注释。例如，如果为某个Fragment添加注释，则还必须为使用该 Fragment 的所有 Activity 添加注释。

@Binds用来绑定接口和实现类，会告知 Hilt 在需要提供接口的实例时要使用哪种实现。

@InstallIn表示希望Hilt将该类注解到某处。比如BookModule类使用@InstallIn(ActivityComponent::class)，就表示BookModule中所有的额依赖项都可以在Activity中使用。

2.3 Hilt支持的类

Application（通过使用 @HiltAndroidApp）
Activity
Fragment
View
Service
BroadcastReceiver

2.4 Hilt为 Android 类生成的组件

对于可以从中执行字段注入的每个Android类，都有一个关联的 Hilt 组件，可以 @InstallIn注释中引用该组件。每个Hilt组件负责将其绑定注入相应的 Android 类。

Hilt组件	注入器面向的对象
ApplicationComponent	Application
ActivityRetainedComponent	ViewModel
ActivityComponent	Activity
FragmentComponent	Fragment
ViewComponent	View
ViewWithFragmentComponent	带有 @WithFragmentBindings 注释的 View
ServiceComponent	Service

2.5 使用@Provides注入实例

创建Book对象，示例中将使用hilt在Activity中获取对象。

data class Book(val name: String)

创建BookModule，用来提供Book对象。BookModule需要用@Module来标注，表示这是一个提供依赖注入对象的类。然后用@InstallIn(ActivityComponent::class)来标注，表示依赖注入将作用于Activity。

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

    @Provides
    fun provideBook(): Book {
        return Book("三体")
    }
}

创建两个Activity，分别在两个Activity中打印获取到的Book对象的hashCode。

@AndroidEntryPoint//标记这是一个注入点
class FirstActivity : AppCompatActivity() {

    private val TAG = "zhangmushui"

    //执行对象注入
    @Inject
    lateinit var book: Book

    @Inject
    lateinit var book2: Book

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_first)

        findViewById<Button>(R.id.button).setOnClickListener {
            startActivity(
                Intent(
                    this,
                    SecondActivity::class.java
                )
            )
        }

        Log.d(TAG, "book hashCode: ${book.hashCode()}")
        Log.d(TAG, "book2 hashCode: ${book2.hashCode()}")
    }
}

@AndroidEntryPoint
class SecondActivity : AppCompatActivity() {

    private val TAG = "zhangmushui"

    @Inject
    lateinit var book: Book

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_second)

        Log.d(TAG, "book3 hashCode: ${book.hashCode()}")

    }
}

运行程序，查看log。

2022-04-21 18:26:16.730 22743-22743/cn.zhangmushui.hilt D/zhangmushui: book hashCode: 639594
2022-04-21 18:26:16.730 22743-22743/cn.zhangmushui.hilt D/zhangmushui: book2 hashCode: 639594
2022-04-21 18:26:21.580 22743-22743/cn.zhangmushui.hilt D/zhangmushui: book3 hashCode: 639594

可以看到，3个Book对象额HashCode一致，Hilt默认的依赖注入对象是单例的。

2.6 使用@Binds注入接口实例

创建一个接口BookService。

interface BookService {
    fun getBook()
}

实现这个接口，打印一句话，注意需要用@Inject来标注构造方法。

class BookServiceImpl @Inject constructor() : BookService {

    override fun getBook() {
        Log.d("zhangmushui", "获取到了一本书")
    }
}

创建Module类，用@Binds将接口和实现类关联。

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

    @Binds
    abstract fun bindBookService(bookServiceImpl: BookServiceImpl): BookService
}

在Activity中，只需要通过@Inject去依赖注入接口类即可。

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {

    @Inject
    lateinit var bookService: BookService

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        bookService.getBook()
    }
}

可以看到，无需手动实例化接口实现类，即可调用接口。

3 Hilt原理解析

Hilt使用APT和ASM技术，通过注解去生成辅助类。原理和Dagger2类似，说直白点就是各个类使用对应的注解，就会生成对应的辅助类，然后把依赖注入对象实例化的工作交给这些辅助类去做，所以就只通过注解就能达到获取到对象的目的。

详细分析可以参照模块解耦神器-Dagger2的使用和详解 - 简书 (jianshu.com)
，不同的地方是，Hilt会通过APT对依赖注入的作用类生成一个“Hilt_类名.java”类，然后该作用类会继承这个生成类，然后通过字节码插桩，在生成类中添加以下方法，从而实现依赖的注入。

protected void inject() {
    if (!injected) {
      injected = true;
      ((FirstActivity_GeneratedInjector) this.generatedComponent()).injectFirstActivity(UnsafeCasts.<FirstActivity>unsafeCast(this));
    }
  }

而使用Dagger2的时候，这一部分代码需要自己手动在作用类中添加。

本文完整源码公众号【木水Code】回复“Hilt”即可获取。

关注木水小站 (zhangmushui.cn)和微信公众号【木水Code】，及时获取更多最新文章。