快捷導(dǎo)航

在kotlin的安卓項(xiàng)目中使用dagger的操作方法

更新時(shí)間：2025年04月11日 09:37:44 作者：Mac Zhu

在 Kotlin 的 Android 項(xiàng)目中使用 ??Dagger??（特別是 ??Dagger Hilt??,官方推薦的簡(jiǎn)化版）進(jìn)行依賴注入（DI）可以大幅提升代碼的可測(cè)試性和模塊化程度,這篇文章主要介紹了在kotlin的安卓項(xiàng)目中使用dagger的相關(guān)操作,需要的朋友可以參考下

1. 配置 Dagger Hilt??

??1.1 添加依賴??

在 build.gradle (Module) 中：

plugins {
    id("com.google.dagger.hilt.android") version "2.48" apply false
}
dependencies {
    implementation("com.google.dagger:hilt-android:2.48")
    kapt("com.google.dagger:hilt-compiler:2.48") // Kotlin 注解處理器
}

在 build.gradle (Project) 中：

plugins {
    id("com.google.dagger.hilt.android") version "2.48" apply false
}

??1.2 啟用 Hilt??

在 Application 類上添加 @HiltAndroidApp：

@HiltAndroidApp
class MyApp : Application()

??2. 核心注解與用法?? ??

2.1 注入依賴到 Android 類??

使用 @Inject 標(biāo)記需要注入的依賴，并在目標(biāo)類（如 Activity、Fragment）上添加 @AndroidEntryPoint：

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
    @Inject lateinit var myDependency: MyDependency // 依賴注入
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        myDependency.doSomething() // 直接使用
    }
}

??2.2 提供依賴（Module）??

使用 @Module 和 @Provides 定義依賴：

@Module
@InstallIn(SingletonComponent::class) // 作用域?yàn)槿謫卫?
object AppModule {
    @Provides
    fun provideMyDependency(): MyDependency = MyDependencyImpl()
}

??2.3 作用域（Scoping）

@Singleton：全局單例（整個(gè)應(yīng)用生命周期）。
@ActivityScoped：與 Activity 生命周期綁定。
@ViewModelScoped：與 ViewModel 生命周期綁定。

@Module
@InstallIn(ViewModelComponent::class) // 作用域?yàn)?ViewModel
object ViewModelModule {
    @ViewModelScoped
    @Provides
    fun provideMyViewModelDependency(): MyViewModelDependency = MyViewModelDependencyImpl()
}

??3. 注入 ViewModel??

結(jié)合 ViewModel 和 Hilt：

@HiltViewModel
class MyViewModel @Inject constructor(
    private val myDependency: MyDependency
) : ViewModel() {
    fun doWork() {
        myDependency.doSomething()
    }
}

在 Activity/Fragment 中獲?。?/p>

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
    private val viewModel: MyViewModel by viewModels()
}

??4. 注入接口或第三方庫(kù)?? ??

4.1 接口綁定（@Binds）??

interface MyRepository {
    fun getData(): String
}
class MyRepositoryImpl @Inject constructor() : MyRepository {
    override fun getData() = "Data from Repository"
}
@Module
@InstallIn(SingletonComponent::class)
abstract class RepositoryModule {
    @Binds
    abstract fun bindMyRepository(impl: MyRepositoryImpl): MyRepository
}

??4.2 注入 Retrofit / Room??

@Module
@InstallIn(SingletonComponent::class)
object NetworkModule {
    @Provides
    fun provideRetrofit(): Retrofit {
        return Retrofit.Builder()
            .baseUrl("https://api.example.com/")
            .addConverterFactory(GsonConverterFactory.create())
            .build()
    }
    @Provides
    fun provideApiService(retrofit: Retrofit): ApiService {
        return retrofit.create(ApiService::class.java)
    }
}

??5. 常見(jiàn)問(wèn)題與解決

????5.1 編譯錯(cuò)誤：Cannot be provided without an @Provides

??原因??：Dagger 找不到依賴的提供方式。
??解決??：
- 檢查是否正確定義了 @Module 和 @Provides。
- 確保 @Inject 的類可以被 Dagger 構(gòu)造（如非接口、非第三方庫(kù)類）。

??5.2 作用域沖突??

??錯(cuò)誤示例??：在 Activity 中注入 @Singleton 依賴，但該依賴需要 @ActivityScoped。
??解決??：調(diào)整 @InstallIn 和作用域注解，確保生命周期匹配。

??5.3 延遲注入（Lazy）??

如果依賴初始化耗時(shí)，可以使用 Lazy<T>：

@Inject lateinit var heavyDependency: Lazy<HeavyDependency>
fun useDependency() {
    heavyDependency.get().doWork() // 使用時(shí)才初始化
}

??6. Dagger Hilt vs. Dagger 2??

??特性??	??Dagger Hilt??	??Dagger 2??
??配置復(fù)雜度??	低（自動(dòng)生成組件）	高（需手動(dòng)定義組件）
??作用域管理??	內(nèi)置 Android 生命周期作用域（如 `@ActivityScoped`）	需自定義作用域
??適用場(chǎng)景??	標(biāo)準(zhǔn) Android 項(xiàng)目	需要高度定制的復(fù)雜項(xiàng)目