定義

Koinを使用すると、モジュール内で定義を記述します。このセクションでは、モジュールの宣言、整理、およびリンク方法について説明します。

モジュールの記述

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

val myModule = module {
   // your dependencies here
}

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

シングルトンの定義

シングルトンコンポーネントを宣言することは、Koinコンテナが宣言されたコンポーネントのユニークなインスタンスを保持することを意味します。シングルトンを宣言するには、モジュール内でsingle関数を使用します。

class MyService()

val myModule = module {

    // declare single instance for MyService class
    single { MyService() }
}

ラムダ内でのコンポーネントの定義

single、factory、scopedキーワードは、ラムダ式を介してコンポーネントを宣言するのに役立ちます。このラムダは、コンポーネントを構築する方法を記述します。通常、コンポーネントはコンストラクタを介してインスタンス化しますが、任意の式を使用することもできます。

single { Class constructor // Kotlin expression }

ラムダの結果型が、コンポーネントの主要な型となります。

ファクトリの定義

ファクトリコンポーネント宣言は、この定義を要求するたびに新しいインスタンスを提供する定義です（このインスタンスはKoinコンテナによって保持されません。なぜなら、後で他の定義にこのインスタンスをインジェクトしないためです）。コンポーネントを構築するには、ラムダ式とともにfactory関数を使用します。

class Controller()

val myModule = module {

    // declare factory instance for Controller class
    factory { Controller() }
}

INFO

Koinコンテナはファクトリインスタンスを保持しません。定義が要求されるたびに新しいインスタンスを提供するからです。

依存関係の解決と注入

コンポーネント定義を宣言できるようになったので、依存性注入によってインスタンスをリンクさせたいと思います。Koinモジュール内でインスタンスを解決するには、要求された必要なコンポーネントインスタンスに対してget()関数を使用するだけです。このget()関数は通常、コンストラクタ内で、コンストラクタの値をインジェクトするために使用されます。

INFO

Koinコンテナで依存性注入を行うには、コンストラクタインジェクションスタイルで記述する必要があります。つまり、クラスのコンストラクタ内で依存関係を解決します。このようにして、インスタンスはKoinから注入されたインスタンスで作成されます。

いくつかのクラスの例を見てみましょう。

// Presenter <- Service
class Service()
class Controller(val view : View)

val myModule = module {

    // declare Service as single instance
    single { Service() }
    // declare Controller as single instance, resolving View instance with get()
    single { Controller(get()) }
}

定義：インターフェースのバインディング

singleまたはfactoryの定義は、指定されたラムダ定義から型を使用します。すなわち、single { T }のようにです。 定義の一致する型は、この式からの一致する唯一の型です。

クラスと実装されたインターフェースの例を見てみましょう。

// Service interface
interface Service{

    fun doSomething()
}

// Service Implementation
class ServiceImp() : Service {

    fun doSomething() { ... }
}

Koinモジュールでは、Kotlinのasキャスト演算子を次のように使用できます。

val myModule = module {

    // Will match type ServiceImp only
    single { ServiceImp() }

    // Will match type Service only
    single { ServiceImp() as Service }

}

推論された型式を使用することもできます。

val myModule = module {

    // Will match type ServiceImp only
    single { ServiceImp() }

    // Will match type Service only
    single<Service> { ServiceImp() }

}

NOTE

この2番目の宣言スタイルが推奨され、以降のドキュメントで採用されます。

追加の型バインディング

場合によっては、1つの定義から複数の型を一致させたいことがあります。

クラスとインターフェースの例を見てみましょう。

// Service interface
interface Service{

    fun doSomething()
}

// Service Implementation
class ServiceImp() : Service{

    fun doSomething() { ... }
}

定義に追加の型をバインドするには、クラスとともにbind演算子を使用します。

val myModule = module {

    // Will match types ServiceImp & Service
    single { ServiceImp() } bind Service::class
}

ここで注目すべきは、Service型をget()で直接解決することです。しかし、複数の定義がServiceをバインドしている場合、bind<>()関数を使用する必要があります。

定義：命名とデフォルトバインディング

同じ型に関する2つの定義を区別するために、定義に名前を指定できます。

その名前で定義を要求するだけです。

val myModule = module {
    single<Service>(named("default")) { ServiceImpl() }
    single<Service>(named("test")) { ServiceImpl() }
}

val service : Service by inject(qualifier = named("default"))

get()関数とby inject()関数は、必要に応じて定義名を指定できます。この名前は、named()関数によって生成されるqualifierです。

デフォルトでは、Koinは型がすでに定義にバインドされている場合、その型またはその名前によって定義をバインドします。

val myModule = module {
    single<Service> { ServiceImpl1() }
    single<Service>(named("test")) { ServiceImpl2() }
}

次に：

• val service : Service by inject() は ServiceImpl1 定義をトリガーします。
• val service : Service by inject(named("test")) は ServiceImpl2 定義をトリガーします。

インジェクションパラメータの宣言

どの定義でも、インジェクションパラメータ（定義によって注入され使用されるパラメータ）を使用できます。

class Presenter(val view : View)

val myModule = module {
    single{ (view : View) -> Presenter(view) }
}

解決された依存関係（get()で解決されるもの）とは対照的に、インジェクションパラメータは解決APIを介して渡されるパラメータです。 これは、これらのパラメータがget()およびby inject()とともにparametersOf関数を使って渡される値であることを意味します。

val presenter : Presenter by inject { parametersOf(view) }

詳細については、インジェクションパラメータのセクションを参照してください。

定義の終了 - OnClose

onClose関数を使用すると、定義のクローズが呼び出されたときに実行されるコールバックを定義に追加できます。

class Presenter(val view : View)

val myModule = module {
    factory { (view : View) -> Presenter(view) } onClose { // closing callback - it is Presenter }
}

定義フラグの使用

Koin DSLにはいくつかのフラグも用意されています。

起動時にインスタンスを作成する

定義またはモジュールは、起動時（または必要なとき）に作成されるよう、CreatedAtStartとしてフラグ付けできます。まず、モジュールまたは定義にcreatedAtStartフラグを設定します。

定義にCreatedAtStartフラグを設定する

val myModuleA = module {

    single<Service> { ServiceImp() }
}

val myModuleB = module {

    // eager creation for this definition
    single<Service>(createdAtStart=true) { TestServiceImp() }
}

モジュールにCreatedAtStartフラグを設定する：

val myModuleA = module {

    single<Service> { ServiceImp() }
}

val myModuleB = module(createdAtStart=true) {

    single<Service>{ TestServiceImp() }
}

startKoin関数は、createdAtStartでフラグ付けされた定義インスタンスを自動的に作成します。

// Start Koin modules
startKoin {
    modules(myModuleA,myModuleB)
}

INFO

特定のタイミング（例えばUIスレッドではなくバックグラウンドスレッドなど）で定義をロードする必要がある場合は、目的のコンポーネントをgetまたはinjectするだけです。

ジェネリクスの扱い

Koinの定義はジェネリクス型引数を考慮しません。例えば、以下のモジュールは2つのList定義を試みています。

module {
    single { ArrayList<Int>() }
    single { ArrayList<String>() }
}

Koinは、このような定義では起動しません。これは、ある定義を別の定義で上書きしようとしていると解釈するためです。

2つの定義を使用するには、名前または場所（モジュール）によってそれらを区別する必要があります。例えば：

module {
    single(named("Ints")) { ArrayList<Int>() }
    single(named("Strings")) { ArrayList<String>() }
}