跳到主要内容

构造器 DSL

Koin 现在提供了一种新的 DSL 关键字，可以直接定位到类构造函数，避免在 lambda 表达式中编写定义。

对于给定的类 ClassA 及其以下依赖项：

class ClassA(val b : ClassB, val c : ClassC)
class ClassB()
class ClassC()

现在可以直接定位 class constructor 来声明这些组件：

module {
    singleOf(::ClassA)
    singleOf(::ClassB)
    singleOf(::ClassC)
}

不再需要在构造函数中使用 get() 函数来指定依赖项了! 🎉

信息

请务必在类名前使用 ::，以定位到你的类构造函数。

备注

你的构造函数将自动填充所有 get()。 避免使用任何默认值，因为 Koin 会尝试在当前 graph（图）中找到它。

备注

如果需要检索 "named（具名）" 的定义，则需要使用带有 lambda 和 get() 的标准 DSL 来指定 qualifier（限定符）。

Available Keywords（可用关键字）​

以下关键字可用于从构造函数构建你的定义：

  • factoryOf - 等效于 factory { } - 工厂定义
  • singleOf - 等效于 single { } - 单例定义
  • scopedOf - 等效于 scoped { } - 作用域定义
信息

请确保不要在构造函数中使用任何默认值，因为 Koin 会尝试使用它来填充每个参数。

DSL Options（DSL 选项）​

任何构造函数 DSL 定义，也可以在 lambda 中打开一些选项：

module {
    singleOf(::ClassA) { 
        // 定义选项
        named("my_qualifier")
        bind<InterfaceA>()
        createdAtStart()
    }
}

常用的选项和 DSL 关键字在此 lambda 中可用：

  • named("a_qualifier") - 为定义提供一个 String qualifier（字符串限定符）
  • named<MyType>() - 为定义提供一个 Type qualifier（类型限定符）
  • bind<MyInterface>() - 为给定的 bean（Bean）定义添加要绑定的类型
  • binds(listOf(...)) - 为给定的 bean（Bean）定义添加类型列表
  • createdAtStart() - 在 Koin 启动时创建单例实例

你还可以使用 bind 或 binds 运算符，而无需任何 lambda：

module {
    singleOf(::ClassA) bind InterfaceA::class
}

Injected Parameters（注入参数）​

使用这种声明方式，你仍然可以使用注入的参数。 Koin 将在注入的参数和当前依赖项中查找，以尝试注入你的构造函数。

像下面这样：

class MyFactory(val id : String)

用构造函数 DSL 声明：

module {
    factoryOf(::MyFactory)
}

可以像这样注入：

val id = "a_factory_id"
val factory = koin.get<MyFactory> { parametersOf(id)}

Reflection Based DSL (Deprecated since 3.2) （基于反射的 DSL (自 3.2 起已弃用)）​

警告

Koin Reflection DSL 现在已弃用。 请使用上面的 Koin Constructor DSL