Dagger2 in Android（四）.android 擴展庫

系列文章

• Dagger2 in Android（一）通俗基礎
• Dagger2 in Android（二）進階
• Dagger2 in Android（三）Scope與生命週期
• Dagger2 in Android（四）.android 擴展庫

問題

在以前咱們討論過，Dagger 在 Android 上廣泛的結構是：定義一個全局的 AppComponent，其餘組件依賴或繼承它。假設如今有 AppComponent 與 ActivityComponent 兩個，他們多是這樣編寫的：

@Module(subcomponents = [ActivityComponent::class])
class AppModule(val context: Context) {

    @Provides
    @Singleton
    fun provideContext() = context
}

@Component(modules = [AppModule::class])
@Singleton
interface AppComponent {
	fun inject(app: MyApplication)
	
	fun activityComponent(): ActivityComponent.Builder
}
複製代碼

@Module
class ActivityModule {
    @Provides
    fun provideSp(context: Context) =
            context.getSharedPreferences("Cooker", Context.MODE_PRIVATE)
}

@SubComponent(modules = [ActivityModule::class])
interface ActivityComponent {
	
	fun inject(activity: MainActivity)

	@Subcomponent.Builder
	interface Builder {
		fun build(): ActivityComponent
	}
}
複製代碼

上面定義了這兩個 Component 而且他們是包含關係。而後咱們必須在 Appliction 中實例化 AppComponent 來保證單例：

class MyApplication: Application {
    lateinit var component: AppComponent
    override fun onCreate() {
        super.onCreate();
        component = DaggerAppComponent.builder().appModule(AppModule(this)).build();
    }
}
複製代碼

最後若是要在 Activity 中使用注入咱們得這樣寫：

class MainAty : AppCompatActivity() {
    @Inject
    lateinit var sp: SharedPreferences

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
		(application as MyApplication).component
			.activityComponent()
			.build()
			.inject(this)
}
複製代碼

這種作法有下面兩個問題：

• 每一個 Activity 都必須建立一個 Component 實例。這些代碼是重複的，會被複制粘貼到不少 Activity。這將很難重構，並且隨着時間的推移，甚至都沒人知道這段代碼到底是幹什麼的，成爲傳說中的「祖傳代碼」。
• Activity 必須知道它所需的 Component 類型，這有悖於原則：被注入的類不該該關心依賴注入的細節。

解決

本節主要來源於 Dagger 官方文檔。

Dagger.android 是一個 Dagger 擴展庫，用於解決上面問題，讓 Dagger 在 Android 上面的使用更加順暢。要使用 Dagger.android，首先須要引入，在第一節已經討論過這個問題了，須要額外依賴下面三個東西：

implementation "com.google.dagger:dagger-android:$dagger_version"
implementation "com.google.dagger:dagger-android-support:$dagger_version"
kapt "com.google.dagger:dagger-android-processor:$dagger_version"
複製代碼

這裏以向 MainActivity 中注入對象爲例，看看 .android 擴展庫如何簡化使用。

1. 首先須要在 AppComponent 中安裝擴展庫提供的 AndroidInjectionModule，這個 Module 提供了對 Android 系統組件的建立支持。例如 Activity、Fragment 等。

@Component(modules = [AppModule::class, AndroidInjectionModule::class]) // 注意這行
@Singleton
interface AppComponent {

    fun activityComponent(): ActivityComponent.Builder
}
複製代碼

2. 讓 Activity 所需的子 Component 實現 AndroidInjector<Activity> 接口。而且其 Builder 繼承 AndroidInjector.Factory。（Builder 已經被標註爲棄用）

@SubComponent(modules = [ActivityModule::class])
interface ActivityComponent : AndroidInjector<MainActivity> {

	@Subcomponent.Factory
	interface Factory : AndroidInjector.Factory<MainActivity> {} // 注意這裏不用再寫 build() 方法了
}
複製代碼

3. 新建立一個 Module，來綁定 Subcomponent 的 Factory，並把它添加到 AppComponent 中。

@Module(subcomponents = [ActivityComponent::class])
abstract class ActivityBindModule {
    @Binds
    @IntoMap
    @ClassKey(MainAty::class)
    abstract fun bindMainAtyInjectorFactory( factory: ActivityComponent.Factory): AndroidInjector.Factory<*>
}

@Component(modules = [AppModule::class, AndroidInjectionModule::class, ActivityBindModule::class]) // 注意這行
@Singleton
interface AppComponent {

    fun activityComponent(): ActivityComponent.Builder
}
複製代碼

提示：

若是子 Component 以及其 Factory(Builder) 沒有其餘函數，或繼承除了步驟2所提到的以外的類，那麼能夠用註解 @ContributesAndroidInjector 來簡化#2#3兩步。

只需在 Module 裏添加一個抽象方法，返回對應的 Activity 類型，而後用 @ContributesAndroidInjector 來註解它，並指定要加入子 Component 的模塊。若是子 Component 擁有 Scope，那麼將對應的 Scope 註解也應用到這個抽象方法。

@Module(subcomponents = [LocalWatchFaceComponent::class])
abstract class ActivityBindModule {

    @ActivityScope
    @ContributesAndroidInjector(modules = [ActivityModule::class])
    abstract fun activityInjector(): MainAty
}

// 別忘記加入 AppComponent 當中了
複製代碼

提示：

若有多個 Activity 能夠寫入同一個 Bind 抽象類中，不必分別寫一個。

4. 讓 Application 類實現 HasActivityInjector 接口，而且注入一個 DispatchingAndroidInjector<Activity> 類型的依賴做爲 activityInjector() 函數的返回值。

class MyApplication: Application, HasActivityInjector {
	@Inject
    lateinit var dispatchingActivityInjector: DispatchingAndroidInjector<Activity>
	
	override fun activityInjector() = dispatchingActivityInjector
	
    lateinit var component: AppComponent
    override fun onCreate() {
        super.onCreate();
        component = DaggerAppComponent.builder().appModule(AppModule(this)).build();
    }
}
複製代碼

5. 最後在 Activity 的 onCreate() 方法中，super.onCreate() 以前，調用 AndroidInjection.inject(this) 便可。

class MainAty : AppCompatActivity() {
    @Inject
    lateinit var sp: SharedPreferences

    override fun onCreate(savedInstanceState: Bundle?) {
		AndroidInjection.inject(this) // <----
        super.onCreate(savedInstanceState)
}
複製代碼

這樣 Activity 中的注入被大大簡化了，並且 Activity 再也不須要知道 Component 的細節。