Anvil：轻松集成Dagger 2的KCP

2023-11-16 01:41:29

Dagger 2是Java和Android平台上流行的依赖注入框架之一，以其易用和高效而著称，但是它在使用时也有一定的学习曲线。Anvil正是为此而生的，它的目标是使集成Dagger 2更加容易，同时不牺牲Dagger 2的灵活性或功能。

Anvil是一个Kotlin编译器插件，这意味着它可以在编译时应用于Kotlin代码。它通过自动生成Dagger module和component接口来简化依赖注入的设置过程，让开发者可以专注于业务逻辑，而无需编写繁琐的Dagger代码。

让我们通过一个简单的例子来说明Anvil是如何工作的。假设我们有一个应用程序，其中有两个类：Foo和Bar，这两个类都需要一个Database对象。传统上，我们需要使用Dagger来实现依赖注入。代码可能如下所示：

// Foo.kt
class Foo @Inject constructor(private val database: Database) {

    fun doSomething() {
        // Use the database
    }
}

// Bar.kt
class Bar @Inject constructor(private val database: Database) {

    fun doSomethingElse() {
        // Use the database
    }
}

// DaggerModule.kt
@Module
class DaggerModule {

    @Provides
    fun provideDatabase(): Database {
        // Create and return a Database instance
    }
}

// DaggerComponent.kt
@Component(modules = [DaggerModule::class])
interface DaggerComponent {

    fun inject(foo: Foo)
    fun inject(bar: Bar)
}

// MainActivity.kt
class MainActivity : Activity() {

    private val component: DaggerComponent = DaggerDaggerComponent.create()

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

        val foo = Foo()
        val bar = Bar()

        component.inject(foo)
        component.inject(bar)

        foo.doSomething()
        bar.doSomethingElse()
    }
}

使用Anvil，我们可以极大地简化这个过程。首先，我们需要在项目的build.gradle文件中添加Anvil的依赖：

plugins {
    id 'org.jetbrains.kotlin.kapt' version '1.5.31'
    id 'com.github.anvil' version '2.4.0'
}

dependencies {
    kapt "com.github.anvil:compiler:2.4.0"
}

接下来，我们可以在需要注入的类上使用@Inject注解，并使用@Provides注解来提供依赖项。代码可能如下所示：

// Foo.kt
@Inject
class Foo(private val database: Database) {

    fun doSomething() {
        // Use the database
    }
}

// Bar.kt
@Inject
class Bar(private val database: Database) {

    fun doSomethingElse() {
        // Use the database
    }
}

// DatabaseProvider.kt
@Provides
fun provideDatabase(): Database {
    // Create and return a Database instance
}

注意，我们不需要再定义Dagger module和component接口了。Anvil会自动地生成这些接口，并在编译时将其合并到我们的应用程序中。

最后，我们在MainActivity中获取生成的Dagger组件并注入依赖项，代码如下：

// MainActivity.kt
class MainActivity : Activity() {

    private val component: DaggerGeneratedComponent = DaggerDaggerGeneratedComponent.create()

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

        val foo = Foo()
        val bar = Bar()

        component.inject(foo)
        component.inject(bar)

        foo.doSomething()
        bar.doSomethingElse()
    }
}