当前位置：首页 > article >正文

Android中的依赖注入(DI)框架Hilt

article 2024/11/24 14:17:07

Hilt 是 Android 提供的一种依赖注入（DI）框架，它基于 Dagger，目的是简化依赖注入的使用，提供更易用的接口和与 Android 生命周期组件的紧密集成。下面是 Hilt 的详细介绍。

在这里插入图片描述

为什么选择 Hilt?

依赖注入的优势：

解耦代码：通过构造函数注入可以避免组件之间的强依赖。
易于测试：通过提供 mock 实现，可以轻松测试各个组件。
管理依赖生命周期：在适当的时间创建和销毁依赖，避免内存泄漏。

Hilt 的优势：

与 Android 集成良好：支持 Android 常见组件（如 Activity、Fragment、ViewModel 等）的依赖注入。
简化配置：通过预定义的作用域和注解减少手动配置。
提升性能：通过 Dagger 的代码生成特性保证运行时性能。

核心概念

1. 模块和绑定

使用 @Module 和 @Provides 注解来定义模块和依赖。Hilt 会自动将这些依赖注入到需要的地方。

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

    @Provides
    fun provideString(): String = "Hello, Hilt!"
}

2. 作用域（Scopes）

Hilt 提供了预定义的作用域，帮助管理依赖的生命周期：

Scope	生命周期
@Singleton	应用程序全局
@ActivityRetained	与 ViewModel 生命周期相同
@ViewModelScoped	限于 ViewModel 内
@ActivityScoped	限于 Activity 生命周期
@FragmentScoped	限于 Fragment 生命周期
@ServiceScoped	限于 Service 生命周期

例如，提供全局单例：

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

    @Singleton
    @Provides
    fun provideDatabase(@ApplicationContext context: Context): MyDatabase {
        return MyDatabase.getInstance(context)
    }
}

3. 注入依赖

在需要注入依赖的地方使用 @Inject：

构造函数注入：

class Repository @Inject constructor(
    private val apiService: ApiService
) {
    fun fetchData() = apiService.getData()
}

属性注入：

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {

    @Inject
    lateinit var repository: Repository

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

        repository.fetchData()
    }
}

4. 预定义组件

Hilt 提供了一些内置组件，用于不同场景的依赖注入：

组件	适用范围	注解
ApplicationComponent	全局单例	@SingletonComponent
ActivityComponent	Activity 范围	@ActivityComponent
FragmentComponent	Fragment 范围	@FragmentComponent
ViewModelComponent	ViewModel 范围	@ViewModelScoped

要启用这些组件，使用 @AndroidEntryPoint 注解标记目标类。

@AndroidEntryPoint
class MainActivity : AppCompatActivity()

典型用例

网络请求和仓库模式

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

    @Singleton
    @Provides
    fun provideRetrofit(): Retrofit {
        return Retrofit.Builder()
            .baseUrl("https://api.example.com")
            .addConverterFactory(GsonConverterFactory.create())
            .build()
    }

    @Singleton
    @Provides
    fun provideApiService(retrofit: Retrofit): ApiService {
        return retrofit.create(ApiService::class.java)
    }
}

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {

    @Inject
    lateinit var apiService: ApiService

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

        lifecycleScope.launch {
            val data = apiService.getData()
            // Process data
        }
    }
}