Koinアノテーションにおけるスコープ

定義やモジュールを使用する際、特定の空間と時間の解決のためにスコープを定義する必要があるかもしれません。

@Scopeでスコープを定義する

Koinはスコープの使用を許可しています。基本的な詳細については、Koin Scopesセクションを参照してください。

アノテーションでスコープを宣言するには、次のようにクラスに@Scopeアノテーションを使用します。

@Scope
class MyScopeClass

これは以下のスコープセクションと同等になります：

scope<MyScopeClass> {

}

そうでなく、型よりもスコープ名が必要な場合は、nameパラメータを使用して@Scope(name = )アノテーションでクラスにタグ付けする必要があります。

@Scope(name = "my_scope_name")
class MyScopeClass

これは以下と同等になります：

scope<named("my_scope_name")> {

}

@Scopedでスコープ内に定義を追加する

スコープ内（アノテーションで定義されているか否かに関わらず）に定義を宣言するには、@Scopeと@Scopedアノテーションでクラスにタグ付けするだけです。

@Scope(name = "my_scope_name")
@Scoped
class MyScopedComponent

これにより、スコープセクション内に適切な定義が生成されます。

scope<named("my_scope_name")> {
  scoped { MyScopedComponent() }
}

INFO

スコープ空間（@Scopeを使用）と定義するコンポーネントの種類（@Scopedを使用）を示すために、両方のアノテーションが必要です。

スコープからの依存関係の解決

スコープ化された定義からは、内部スコープと親スコープからの任意の定義を解決できます。

例えば、次のケースは機能します。

@Single
class MySingle

@Scope(name = "my_scope_name")
@Scoped
class MyScopedComponent(
  val mySingle : MySingle,
  val myOtherScopedComponent :MyOtherScopedComponent
)

@Scope(name = "my_scope_name")
@Scoped
class MyOtherScopedComponent(
  val mySingle : MySingle
)

MySingleコンポーネントはルートでシングルトン定義として定義されています。MyScopedComponentとMyOtherScopedComponentは"my_scope_name"スコープで定義されています。 MyScopedComponentからの依存関係の解決は、MySingleインスタンスでKoinのルートにアクセスし、現在の"my_scope_name"スコープからMyOtherScopedComponentスコープインスタンスにアクセスします。

@ScopeIdを用いたスコープ外からの解決 (バージョン1.3.0以降)

別のスコープから、自身のスコープから直接アクセスできないコンポーネントを解決する必要があるかもしれません。そのためには、依存関係に@ScopeIdアノテーションを付加し、Koinに指定されたスコープIDのスコープ内でこの依存関係を見つけるように指示する必要があります。

@Factory
class MyFactory(
  @ScopeId("my_scope_id") val myScopedComponent :MyScopedComponent
)

上記のコードは、生成されたものと同等です。

factory { Myfactory(getScope("my_scope_id").get()) }

この例は、MyFactoryコンポーネントがmy_scope_idというIDを持つスコープインスタンスからMyScopedComponentコンポーネントを解決することを示しています。my_scope_idというIDで作成されたこのスコープは、適切なスコープ定義で作成される必要があります。

INFO

MyScopedComponentコンポーネントはスコープセクション内で定義されている必要があり、スコープインスタンスは"my_scope_id"というIDで作成されている必要があります。