kotlin 中的 Dagger 2 静态提供程序方法

Question

在最新版本的 dagger 2 中，其中一项改进是可以使用静态提供方法。就这么简单：

@Provides
static A providesA() {
  return A();
}

我想知道如何在 kotlin 中做到这一点？我试过了

@Module
class AModule {
  companion object {
    @JvmStatic
    @Provides
    fun providesA(): A = A()
  }
}

但我收到错误消息：

@Provides methods can only be present within a @Module or @ProducerModule

我猜伴随对象在这里发生了一些事情，但是我对 Kotlin 还是很陌生，我不确定如何做到这一点。有没有可能？

谢谢！

Answer 1

虽然我认为 zsmb13 的解决方案更好，但我找到了另一个可行的解决方案

@Module
class AModule {
  @Module
  companion object {
    @JvmStatic
    @Provides
    fun providesA(): A = A()
  }

  // add other non-static provides here
}

但是，请注意，将生成两个类：AModule_ProvidesAFactory 和 AModule_Companion_ProvidesAFactory，而不是一个 AModule_ProvidesAFactory 类，用于带有对象而不是带有伴随对象的类的情况

Answer 2

我现在无法测试它，但我认为这应该可以：

@Module
object AModule {
    @JvmStatic
    @Provides
    fun providesA(): A = A()
}

Answer 3

https://github.com/google/dagger/issues/900 上似乎得到了 Google 认可的一个很好的解释

具体见：

静态提供可以通过@JvmStatic 实现。我看到有两种情况：

顶级objects

@Module object DataModule {   
  @JvmStatic @Provides fun 
    provideDiskCache() = DiskCache() 
} 

如果你有一个现有的类 模块，事情变得有点奇怪

@Module abstract class DataModule {   
    @Binds abstract fun provideCache(diskCache: DiskCache): Cache

    @Module   
    companion object {
        @JvmStatic @Provides fun provideDiskCache() = DiskCache()   
    } 
} 

其工作方式如下：

伴随对象也必须在底层注释为@Module， kotlin 编译器会将这些静态提供方法复制到 数据模块类。 Dagger 会看到这些并像对待它们一样对待它们 常规静态字段。 Dagger也会在同伴中看到他们 对象，但该“模块”将从匕首获取代码生成但被标记 作为“未使用”。 IDE 会将其标记为 provideDiskCache 方法将被标记为未使用。你可以告诉 IntelliJ 忽略这个 用于通过 quickfix 使用 @Provides 注释的注释

Answer 4

现在Dagger2 (version 2.26) support companion objects in @Module annotated classes in kotlin withthouh @Module and @JvmStatic annotations

更好地支持 Kotlin 伴侣中的绑定声明 @Module 注解的类的对象。

将 dagger 依赖项更新为 2.26 版本

def dagger_version = "2.26"
//dagger
implementation "com.google.dagger:dagger:$dagger_version"
kapt "com.google.dagger:dagger-compiler:$dagger_version"

//If you're using classes in dagger.android you'll also want to include:
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"

所以现在你可以使用

@Module
class AModule {

  companion object {

    @Provides
    fun providesA(): A = A()
  }

}

---

重要提示：很快，在 companion objects 的 @Module 类中添加 @Module 将引发错误。

注意：为了向后兼容，我们仍然允许 @Module 在 伴随对象和提供方法上的@JvmStatic。然而， 伴随对象上的 @Module 现在是无操作的，并且它的所有 属性（例如“包含”）将被忽略。 In future releases, we will make it an error to use @Module on a companion object.

Answer 5

对于仅静态方法，我喜欢zsmb13的解决方案。

但是，我来到这里是因为我想将@Provides 和@Binds 合并到一个模块中。 这不是直接可行的，而是使用两个嵌套模块（正如Omar Al Halabi 指出的那样）。

我采用了一种稍微不同的方法来组合@Provides 和@Binds：

@Module(includes = [MyModule.Bindings::class])
object MyModule {
    @Module
    interface Bindings {
        @Binds
        fun bindA(a: AImpl): A
    }

    @Provides
    @JvmStatic
    fun provideB(): B = BImpl()
}

区别在于：

• 外部模块是提供静态功能的对象。这可以避免使用无意的companion object。
• 内部模块保存抽象绑定。我可以在这里使用一个接口，它在类和函数中都保留了abstract 修饰符。
• 外部模块包含内部模块，因此我不必在其他地方包含内部模块。