【Dagger】Component.Factory与Component.Builder的使用对比

一时失言乱红尘 2023-07-12 05:30 17阅读 0赞

Dagger 2.22 起引入了 `@Component.Factory` 可以取代`@Component.Builder`的使用，Factory在许多场景的上的使用相对于Builder会更简单。本文用对比的方式介绍`@Component.Factory`与 `@Component.Builder`在使用上的区别。

# 依赖版本 #

--------------------

implementation 'com.google.dagger:dagger:2.23.1'
    kapt 'com.google.dagger:dagger-compiler:2.23.1'

# 带构造参数的Module #

--------------------

当Module在运行时构造传参时

@Module
    class AppModule(private val value: String) { 
    
        @Provides
        fun provideString(): String { 
            return value
        }
    }

当使用Builder，因为Module需要动态创建，需要在Builder中定义参数为module的方法：

@Component(
        modules = [
            AppModule::class
        ]
    )
    interface AppComponent { 
    
        @Component.Builder
        interface Builder { 
            // 传入Module实例
            fun appModule(appModule: AppModule): Builder
    
            fun build(): AppComponent
        }
    
        fun inject(activity: MainActivity)
    }

若使用Factory，同样需要定义method，传入module作为参数

@Component(
        modules = [
            AppModule::class
        ]
    )
    interface AppComponent { 
    
        @Component.Factory
        interface Factory { 
            // 传入module的实例
            fun create(appModule: AppModule): AppComponent
        }
    
        fun inject(activity: MainActivity)
    }

Factory不需要在定义`build`方法了，只定一个一个方法就OK

val component = DaggerAppComponent.factory()
        .create(AppModule("Sample"))
    
    component.inject(this)

# BindsInstance #

--------------------

除了使用Module构造函数传入运行时所需要的依赖，还可以使用`@BindsInstance`。例如我们需要运行时获取Context：

@Module
    class AppModule { 
    
        @Provides
        fun providePackageName(context: Context): String { 
            return context.packageName
        }
    }

此时可以在Builder中使用 `@BindsInstance` 如下

@Component(
        modules = [
            AppModule::class
        ]
    )
    interface AppComponent { 
    
        @Component.Builder
        interface Builder { 
            @BindsInstance
            fun context(context: Context): Builder
    
            fun build(): AppComponent
        }
    
        fun inject(activity: MainActivity)
    }

使用Factory的写法大体相同：

Component(
        modules = [
            AppModule::class
        ]
    )
    interface AppComponent { 
    
        @Component.Factory
        interface Factory { 
            fun create(
                @BindsInstance context: Context
            ): AppComponent
        }
    
        fun inject(activity: MainActivity)
    }

val component = DaggerAppComponent.factory()
        .create(context)
    
    component.inject(this)

# dependencies #

--------------------

使用`dependencies` 通过指定父Component，建立Component的依赖。

Builder中需要额外定义method，传入父Component

@Component(
        modules = [
            AppModule::class
        ],
        dependencies = [
            CoreComponent::class
        ]
    )
    interface AppComponent { 
    
        @Component.Builder
        interface Builder { 
            @BindsInstance
            fun context(context: Context): Builder
    
            fun coreComponent(coreComponent: CoreComponent): Builder
    
            fun build(): AppComponent
        }
    
        fun inject(activity: MainActivity)
    }

Factory中只需要增加一个参数即可

@Component(
        modules = [
            AppModule::class
        ],
        dependencies = [
            CoreComponent::class
        ]
    )
    interface AppComponent { 
    
        @Component.Factory
        interface Factory { 
            fun create(
                @BindsInstance context: Context,
                coreComponent: CoreComponent
            ): AppComponent
        }
    
        fun inject(activity: MainActivity)
    }

val coreComponent = DaggerCoreComponent.create()
    val appComponent = DaggerAppComponent.factory()
        .create(
            context,
            coreComponent
        )
    
    appComponent.inject(this)

# AndroidInjector #

--------------------

`AndroidInjector.Builder` 虽然已经`deprecated`了，Builder中的使用如下：

@Component(
        modules = [
            AndroidInjectionModule::class,
            AppModule::class,
            MainActivityModule::class
        ]
    )
    interface AppComponent : AndroidInjector<App> { 
        @Component.Builder
        abstract class Builder: AndroidInjector.Builder<App>() { 
            @BindsInstance
            abstract fun context(context: Context): Builder
        }
    }

同样的我们可以通过`AndroidInjector.Factory` 创建`AndroidInjector`，但是其`create`无法自定义参数，所以需要传额外参数时，最好使用普通Factory完成，如下方式：（参考 [AndroidInjector.Factory传入额外参数][AndroidInjector.Factory]）

@Component(
        modules = [
            AndroidInjectionModule::class,
            AppModule::class,
            MainActivityModule::class
        ]
    )
    interface AppComponent : AndroidInjector<App> { 
        @Component.Factory
        interface Factory { 
            fun create(
                @BindsInstance context: Context
            ): AppComponent
        }
    }

[AndroidInjector.Factory]: https://stackoverflow.com/questions/57451251/how-to-use-androidinjector-factory