ようこそ
Koin は Kotlin 向けの依存性注入(Dependency Injection)フレームワークです。モジュール内でクラスの構築方法を宣言すると、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) }
}やりたいことから探す
- まず依存性注入を理解したい: 依存性注入とは?
- 5分でKoinの仕組みを理解したい: コアコンセプト
- DSLとアノテーションのどちらを使うか選びたい: スタイルの選択
- GradleビルドにKoinを追加したい: 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の起動:
startKoin、ロギング、プロパティ。 - モジュール および 定義: Koinが生成するコンポーネントの宣言。
- スコープ: ライフサイクルに紐づくインスタンス。
- トラブルシューティング: エラーとその対処法。
プラットフォーム
特定のプラットフォームやフレームワークでKoinを使用するには?
- Android: AndroidでKoinを起動する、Android ViewModel、マルチモジュールAndroidアプリ。
- Compose: Koin for Compose、ComposeでのViewModel、Navigation 3。
- Kotlin Multiplatform: KMPのセットアップ、共有パターン。
- Ktor: Koin for Ktor、リクエストスコープ。
テスト
Koinを使用するコードのテストや、Koin設定自体のテストを行うには?
- テストでの注入:
KoinTest、定義のテスト用フェイクへの置き換え。 - 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オプション。
サポート
どのバージョンを使うべきか、何が変更されたか、どこでサポートを受けられるか?
- リリース: バージョン、変更点、アップグレードに関する注意事項。
- APIの安定性: 安定版(stable)、実験的(experimental)、内部用(internal)の意味。
- サポート: ロードマップ、コミュニティ、サポートオプション。
