歡迎
Koin 是一套適用於 Kotlin 的相依注入架構。您可以在模組中宣告類別的組建方式,Koin 會在執行時期建立並連接這些執行個體,而選用的 Koin Compiler Plugin 則會在您組建時檢查整個依賴圖。它可執行於 Android、Compose、Kotlin Multiplatform、Ktor 以及任何 Kotlin/JVM 應用程式上。
本頁面是整份文件的導覽地圖。以下各節將說明它們各自解答了哪些問題,以及您可以從何處開始。
kotlin
class UserRepository(private val api: ApiService)
val appModule = module {
single<ApiService>()
single<UserRepository>()
}
fun main() {
startKoin { modules(appModule) }
}我想要…
- 先了解相依注入:什麼是相依注入?
- 在五分鐘內了解 Koin 的運作方式:核心概念
- 在 DSL 與註解之間做出選擇:選擇您的風格
- 將 Koin 新增至我的 Gradle 組建中:Gradle 設定
- 在 Composable 中注入 ViewModel:Compose 中的 ViewModel
- 在 Activity、Fragment 或 Service 中進行注入:Android 入口點
- 連接 Retrofit、Room 或 OkHttp:Android 程式庫整合
- 在 Android 與 iOS 之間共享模組:KMP 共享模式
- 將執行時期數值(例如 ID)傳遞給定義:注入參數
- 測試我的 Koin 配置:驗證您的 Koin 配置 與 編譯期安全性
- 修復「No definition found」錯誤:疑難排解
- 從 Hilt 遷移:從 Hilt 遷移
- 將我的註解從 KSP 遷移至 Compiler Plugin:從 KSP 遷移
- 查看 Koin 在正式環境中的運作表現:正式環境監控
導覽目錄
開始使用
什麼是 Koin?它是如何運作的?我該使用哪種風格?
- 什麼是 Koin?:Koin 是什麼以及它如何運作,包含執行時期與編譯期。
- 核心概念:定義、模組、容器、注入、作用域。
- 選擇您的風格:註解或 DSL(Compiler Plugin、Constructor DSL 或 Classic DSL)。
- Koin Compiler Plugin:此外掛程式在組建時期執行的工作。
設定
我該在組建中新增什麼?
- 設定:各平台需要安裝的內容。
- Gradle 設定:BOM 與所有 Koin 構件。
- Compiler Plugin 設定:安裝並設定 Gradle 外掛程式。
教學
如何一步步使用 Koin 建置第一個應用程式?
- Kotlin:純 Kotlin 應用程式。
- Android - ViewModel 與 Android - Jetpack Compose。
- Compose Multiplatform:在 Android 與 iOS 上共享 UI。
- Ktor:伺服器端應用程式。
核心
如何在任何平台上宣告、組織與檢索相依項?
平台
如何在特定平台或架構中使用 Koin?
- Android:在 Android 上啟動 Koin、Android ViewModel、多模組 Android 應用程式。
- Compose:適用於 Compose 的 Koin、Compose 中的 ViewModel、Navigation 3。
- Kotlin Multiplatform:KMP 設定、共享模式。
- Ktor:適用於 Ktor 的 Koin、請求作用域。
測試
如何測試使用 Koin 的程式碼,並測試配置本身?
- 在測試中進行注入:
KoinTest、使用測試替身(fakes)取代定義。 - 驗證您的 Koin 配置:在單元測試中檢查模組。
- Android 檢測測試 與 測試 Composable。
正式環境與工具
有哪些工具可以協助我編寫、檢查與執行 Koin 應用程式?
- 工具:圍繞 Koin 的周邊工具概覽。
- IDE 外掛程式:Android Studio 與 IntelliJ IDEA 中的導覽與檢查。
- Monitor 與 正式環境監控:查看 Koin 在執行時期的運作狀況。
遷移
我正在使用其他架構或舊版 Koin 設定。該如何遷移?
- Koin vs Hilt:兩者的比較。
- 從 Hilt 遷移:逐步指南。
- JSR-330 相容性:保留來自
javax.inject的@Inject與@Singleton。 - 從 KSP 遷移:將註解遷移至 Compiler Plugin。
參考指南
所有關鍵字、註解與選項有哪些?
- DSL 參考:每個 DSL 關鍵字。
- 註解參考:每個註解及其參數。
- Compiler Plugin 選項:此外掛程式的所有 Gradle 選項。
支援
我該使用哪個版本?有什麼變更?可以從哪裡獲得協助?
