帶有註解的定義

Koin 註解 (Koin Annotations) 允許像常規的 Koin DSL 一樣宣告相同類型的定義，但改用註解方式。只需使用所需的註解標記您的類別，它將為您生成所有內容！

例如，等同於 single { MyComponent(get()) } DSL 宣告的方式，只需像這樣使用 @Single 標記：

@Single
class MyComponent(val myDependency : MyDependency)

Koin 註解保持與 Koin DSL 相同的語義。您可以使用以下定義來宣告您的元件：

• @Single - 單例實例 (在 DSL 中使用 single { } 宣告)
• @Factory - 工廠實例。用於每次您需要實例時重新建立的實例。(在 DSL 中使用 factory { } 宣告)
• @KoinViewModel - Android ViewModel 實例 (在 DSL 中使用 viewModel { } 宣告)
• @KoinWorker - Android Worker Workmanager 實例 (在 DSL 中使用 worker { } 宣告)

關於作用域 (Scopes)，請查閱 宣告作用域 章節。

為 Kotlin Multiplatform 生成 Compose ViewModel (自 1.4.0 起)

@KoinViewModel 註解可用於生成 Android 或 Compose KMP ViewModel。要在 Koin 定義中生成 viewModel (使用 org.koin.compose.viewmodel.dsl.viewModel 而非常規的 org.koin.androidx.viewmodel.dsl.viewModel)，您需要啟用 KOIN_USE_COMPOSE_VIEWMODEL 選項：

ksp {
    arg("KOIN_USE_COMPOSE_VIEWMODEL","true")
}

NOTE

USE_COMPOSE_VIEWMODEL 鍵已被棄用，請改用 KOIN_USE_COMPOSE_VIEWMODEL。

NOTE

Koin 4.0 應會將這兩個 ViewModel DSL 合併為一個，因為 ViewModel 類型參數來自同一個函式庫。

自動或特定綁定

當宣告一個元件時，所有檢測到的「綁定」(相關聯的超類別) 都將為您準備好。例如，以下定義：

@Single
class MyComponent(val myDependency : MyDependency) : MyInterface

Koin 將宣告您的 MyComponent 元件也與 MyInterface 綁定。其 DSL 等效為 single { MyComponent(get()) } bind MyInterface::class。

除了讓 Koin 為您檢測，您也可以透過 binds 註解參數來指定您真正想要綁定的類型：

@Single(binds = [MyBoundType::class])

可為 Null 的依賴項

如果您的元件使用可為 Null 的依賴項，請不用擔心，它將自動為您處理。只需繼續使用您的定義註解，Koin 會猜測該怎麼做：

@Single
class MyComponent(val myDependency : MyDependency?)

生成的 DSL 等效將是 single { MyComponent(getOrNull()) }

請注意，這也適用於注入的參數和屬性。

使用 @Named 的限定符

您可以為定義添加一個「名稱」(也稱為限定符 Qualifier)，以區分相同類型的多個定義，使用 @Named 註解：

@Single
@Named("InMemoryLogger")
class LoggerInMemoryDataSource : LoggerDataSource

@Single
@Named("DatabaseLogger")
class LoggerLocalDataSource(private val logDao: LogDao) : LoggerDataSource

解析依賴項時，只需使用 named 函式搭配限定符：

val logger: LoggerDataSource by inject(named("InMemoryLogger"))

也可以建立自訂的限定符註解。以上述範例為例：

@Named
annotation class InMemoryLogger

@Named
annotation class DatabaseLogger

@Single
@InMemoryLogger
class LoggerInMemoryDataSource : LoggerDataSource

@Single
@DatabaseLogger
class LoggerLocalDataSource(private val logDao: LogDao) : LoggerDataSource

val logger: LoggerDataSource by inject(named<InMemoryLogger>())

使用 @InjectedParam 注入參數

您可以將建構子成員標記為「注入參數」，這表示在呼叫解析時，該依賴項將在圖中傳遞。

例如：

@Single
class MyComponent(@InjectedParam val myDependency : MyDependency)

然後您可以呼叫您的 MyComponent 並傳遞 MyDependency 的實例：

val m = MyDependency
// Resolve MyComponent while passing  MyDependency
koin.get<MyComponent> { parametersOf(m) }

生成的 DSL 等效將是 single { params -> MyComponent(params.get()) }

注入懶載入依賴項 - Lazy<T>

Koin 可以自動檢測並解析懶載入的依賴項。例如，我們希望懶載入解析 LoggerDataSource 定義。您只需使用 Lazy Kotlin 類型，如下所示：

@Single
class LoggerInMemoryDataSource : LoggerDataSource

@Single
class LoggerAggregator(val lazyLogger : Lazy<LoggerDataSource>)

其背後將生成類似於使用 inject() 而非 get() 的 DSL：

single { LoggerAggregator(inject()) }

注入依賴項列表 - List<T>

Koin 可以自動檢測並解析所有依賴項列表。例如，我們希望解析所有 LoggerDataSource 定義。您只需使用 List Kotlin 類型，如下所示：

@Single
@Named("InMemoryLogger")
class LoggerInMemoryDataSource : LoggerDataSource

@Single
@Named("DatabaseLogger")
class LoggerLocalDataSource(private val logDao: LogDao) : LoggerDataSource

@Single
class LoggerAggregator(val datasource : List<LoggerDataSource>)

其背後將生成類似於使用 getAll() 函式的 DSL：

single { LoggerAggregator(getAll()) }

帶有 @Property 的屬性

要在您的定義中解析 Koin 屬性，只需使用 @Property 標記建構子成員。這將透過傳遞給註解的值來解析 Koin 屬性：

@Factory
public class ComponentWithProps(
    @Property("id") public val id : String
)

生成的 DSL 等效將是 factory { ComponentWithProps(getProperty("id")) }

@PropertyValue - 帶有預設值的屬性 (自 1.4 起)

Koin 註解提供了直接從您的程式碼中透過 @PropertyValue 註解為屬性定義預設值的可能性。讓我們沿用我們的範例：

@Factory
public class ComponentWithProps(
    @Property("id") public val id : String
){
    public companion object {
        @PropertyValue("id")
        public const val DEFAULT_ID : String = "_empty_id"
    }
}

生成的 DSL 等效將是 factory { ComponentWithProps(getProperty("id", ComponentWithProps.DEFAAULT_ID)) }