Koin DSL

Kotlin言語の強力さのおかげで、Koinはアノテーションを付けたり、コードを生成したりする代わりに、アプリケーションを記述するのに役立つDSLを提供します。 Kotlin DSLにより、Koinは依存性注入を準備するためのスマートな関数型APIを提供します。

Application & Module DSL

Koinは、Koinアプリケーションの要素を記述するためのいくつかのキーワードを提供します。

KoinApplicationインスタンスは、Koinコンテナインスタンスの構成です。これにより、ロギング、プロパティのロード、およびモジュールを構成できます。

新しいKoinApplicationを構築するには、次の関数を使用します。

koinApplication { } - KoinApplicationコンテナ構成を作成します
startKoin { } - KoinApplicationコンテナ構成を作成し、GlobalContextに登録して、GlobalContext APIの使用を許可します

KoinApplicationインスタンスを構成するには、次のいずれかの関数を使用できます。

上記のように、Koinコンテナ構成は、koinApplicationまたはstartKoin関数の2つの方法で記述できます。

コンテナ構成をGlobalContextに登録することにより、グローバルAPIはそれを直接使用できます。 KoinComponentはKoinインスタンスを参照します。デフォルトでは、GlobalContextのインスタンスを使用します。

詳細については、カスタムKoinインスタンスに関する章を確認してください。

Koinの開始とは、GlobalContextでKoinApplicationインスタンスを実行することを意味します。

モジュールを使用してKoinコンテナを開始するには、次のようにstartKoin関数を使用します。

// グローバルコンテキストでKoinApplicationを開始します
startKoin {
    // 使用するロガーを宣言します
    logger()
    // 使用するモジュールを宣言します
    modules(coffeeAppModule)
}

Koinモジュールは、アプリケーション用に注入/結合する定義を収集します。新しいモジュールを作成するには、次の関数を使用します。

モジュールでコンテンツを記述するには、次の関数を使用できます。

注：named()関数を使用すると、文字列、enum、または型で修飾子を指定できます。これは、定義に名前を付けるために使用されます。

Koinモジュールは、すべてのコンポーネントを宣言するスペースです。 module関数を使用して、Koinモジュールを宣言します。

val myModule = module {
   // ここに依存関係があります
}

このモジュールでは、以下に示すようにコンポーネントを宣言できます。

新しいConstructor DSL定義と同様に、withOptions演算子を使用して、「通常の」定義に定義オプションを指定できます。

module {
    single { ClassA(get()) } withOptions { 
        named("qualifier")
        createdAtStart()
    }
}

このオプションのラムダ内では、次のオプションを指定できます。