Koin 註解使用入門

Koin 註解專案的目標是幫助您以快速且直觀的方式宣告 Koin 定義，並為您生成所有底層的 Koin DSL。其目標是借助 Kotlin 編譯器，幫助開發者體驗擴展並快速開發 🚀。

入門

不熟悉 Koin？請先查看 Koin 入門指南

使用定義與模組註解標記您的元件，並使用慣用的 Koin API。

// 標記您的元件以宣告定義
@Single
class MyComponent

基本模組設定

// 宣告模組並掃描註解
@Module
class MyModule

現在您可以使用 @KoinApplication 啟動您的 Koin 應用程式，並明確指定要使用的模組：

// 下面的 import 讓您可以使用生成的擴充功能
// 例如 MyModule.module 和 MyApp.startKoin() 
import org.koin.ksp.generated.*

@KoinApplication(modules = [MyModule::class])
object MyApp

fun main() {
    MyApp.startKoin {
        printLogger()
    }

    // 像往常一樣使用您的 Koin API
    KoinPlatform.getKoin().get<MyComponent>()
}

基於配置的模組設定

或者，您可以使用 @Configuration 建立會自動載入的模組：

// 帶有配置的模組 - 自動包含在預設配置中
@Module
@Configuration
class MyModule

透過配置，您無需明確指定模組：

// 下面的 import 讓您可以使用生成的擴充功能
// 此方法會自動載入所有標記為 @Configuration 的模組
import org.koin.ksp.generated.*

@KoinApplication
object MyApp

fun main() {
    MyApp.startKoin {
        printLogger()
    }

    // 像往常一樣使用您的 Koin API
    KoinPlatform.getKoin().get<MyComponent>()
}

就是這樣，您可以使用 慣用的 Koin API 在 Koin 中使用您的新定義。

KSP 選項

Koin 編譯器提供了一些配置選項。根據官方文件，您可以將以下選項添加到您的專案中：KSP 快速入門文件

編譯安全 - 在編譯時檢查您的 Koin 配置 (從 1.3.0 開始)

Koin 註解允許編譯器插件在編譯時驗證您的 Koin 配置。您可以透過將以下 KSP 選項添加到您的 Gradle 模組中來啟用此功能：

// 在 build.gradle 或 build.gradle.kts

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

編譯器將檢查您配置中使用的所有依賴項是否已宣告，並且所有使用的模組都可被存取。

使用 @Provided 繞過編譯安全 (從 1.4.0 開始)

除了編譯器中忽略的類型 (Android 常見類型) 之外，編譯器插件可以在編譯時驗證您的 Koin 配置。如果您想排除某個參數不被檢查，可以在參數上使用 @Provided 來指示此類型是從目前的 Koin 註解配置外部提供的。

以下表示 MyProvidedComponent 已在 Koin 中宣告：

class MyProvidedComponent

@Factory
class MyPresenter(@Provided val provided : MyProvidedComponent)

預設模組 (自 1.3.0 起已棄用)

WARNING

預設模組方法自 Annotations 1.3.0 起已棄用。我們建議使用帶有 @Module 和 @Configuration 註解的顯式模組，以提高組織性和清晰度。

此前，Koin 編譯器會檢測任何未綁定到模組的定義，並將其放入一個「預設模組」中。現在此方法已棄用，建議改用 @Configuration 和 @KoinApplication 註解。

已棄用方法 (避免使用)：

// 在 build.gradle 或 build.gradle.kts

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

推薦方法：使用上述範例中所示的顯式模組組織方式，搭配 @Configuration 和 @KoinApplication。

Kotlin KMP 設定

請按照官方文件所述的 KSP 設定：KSP 與 Kotlin Multiplatform

您也可以查看 Hello Koin KMP 專案，其中包含 Koin 註解的基本設定。

ProGuard

如果您打算將 Koin 註解應用程式作為 SDK 嵌入，請查看這些 ProGuard 規則：

# 保留註解定義
-keep class org.koin.core.annotation.** { *; }

# 保留標記有 Koin 註解的類別
-keep @org.koin.core.annotation.* class * { *; }