アプリケーション、設定、およびモジュール

@KoinApplication によるアプリケーションのブートストラップ

アプリケーションのエントリポイントを定義するには、@KoinApplication を使用します。

@KoinApplication(modules = [MyModule::class])
class MyApp

型指定された API を使用して Koin を開始します。

fun main() {
    startKoin<MyApp>()

    // または設定を伴う場合
    startKoin<MyApp> {
        printLogger()
    }
}

利用可能な型指定された API

API	説明
startKoin<T>()	Koin をグローバルに開始する
startKoin<T> { }	設定ブロックを使用して開始する
koinApplication<T>()	隔離された KoinApplication を作成する
koinConfiguration<T>()	設定を作成する（Compose、Ktor 用）

@KoinApplication のパラメータ

• modules: 含めるモジュールクラスの配列
• configurations: ロードする設定ラベルの配列

@KoinApplication(
    modules = [CoreModule::class],
    configurations = ["production"]
)
class ProdApp

INFO

設定が指定されていない場合、@Configuration（デフォルトラベル）でマークされたモジュールが自動的にロードされます。

@Configuration による設定管理

@Configuration アノテーションを使用すると、モジュールを異なる設定（環境、フレーバーなど）に整理できます。これは、デプロイ環境や機能セットごとにモジュールを整理するのに便利です。

基本的な設定の使用方法

// モジュールをデフォルトの Configuration に配置
@Module
@Configuration
class CoreModule

INFO

デフォルトの設定名は "default" です。@Configuration または @Configuration("default") として使用できます。

設定からモジュールをスキャンできるようにするには、@KoinApplication を使用する必要があります。

// モジュール A
@Module
@Configuration
class ModuleA

// モジュール B
@Module
@Configuration
class ModuleB

// アプリケーションモジュール、すべての @Configuration モジュールをスキャン
@KoinApplication
object MyApp

複数設定のサポート

モジュールは複数の設定に関連付けることができます。

// このモジュールは "prod" と "test" 両方の設定で使用可能です
@Module
@Configuration("prod", "test")
class DatabaseModule {
    @Single
    fun database() = PostgreSQLDatabase()
}

// このモジュールは default、test、development で使用可能です
@Module
@Configuration("default", "test", "development") 
class LoggingModule {
    @Single
    fun logger() = Logger()
}

環境固有の設定

// 開発環境専用の設定
@Module
@Configuration("development")
class DevDatabaseModule {
    @Single
    fun database() = InMemoryDatabase()
}

// 本番環境専用の設定  
@Module
@Configuration("production")
class ProdDatabaseModule {
    @Single
    fun database() = PostgreSQLDatabase()
}

// 複数の環境で使用可能
@Module
@Configuration("default", "production", "development")
class CoreModule {
    @Single
    fun logger() = Logger()
}

@KoinApplication での設定の使用

デフォルトでは、@KoinApplication はすべてのデフォルト設定（@Configuration でタグ付けされたモジュール）をロードします。

アプリケーションのブートストラップでこれらの設定を参照することもできます。

@KoinApplication(configurations = ["default", "production"])
class ProductionApp

@KoinApplication(configurations = ["default", "development"])  
class DevelopmentApp

// デフォルト設定のみをロード（パラメータなしの @KoinApplication と同じ）
@KoinApplication
class SimpleApp

INFO

• 空の @Configuration は @Configuration("default") と同等です
• 特定の設定が指定されていない場合、"default" 設定が自動的にロードされます
• アノテーション内にリストすることで、モジュールを複数の設定に所属させることができます

モジュールによる整理

定義は常に @Module を使用して明示的なモジュールに整理してください。

@Module によるクラスモジュール

モジュールを宣言するには、クラスに @Module アノテーションを付与します。

@Module
class MyModule

@KoinApplication 内でモジュールを参照します。

@KoinApplication(modules = [MyModule::class])
class MyApp

fun main() {
    startKoin<MyApp>()
}

@ComponentScan によるコンポーネントスキャン

アノテーションが付与されたコンポーネントを自動的に検出するには、@ComponentScan を使用します。

@Module
@ComponentScan
class MyModule

これにより、現在のパッケージおよびサブパッケージからアノテーション付きコンポーネントがスキャンされます。次のようにパッケージを明示的に指定することもできます。

@Module
@ComponentScan("com.myapp.features")
class FeatureModule

INFO

@ComponentScan は同じパッケージを対象にすべての Gradle モジュールを横断してスキャンします。

クラスモジュール内での定義

コード内で直接定義を宣言するには、関数に定義用のアノテーションを付与します。

// 例 
// class MyComponent(val myDependency : MyDependency)

@Module
class MyModule {

  @Single
  fun myComponent(myDependency : MyDependency) = MyComponent(myDependency)
}

注意: @InjectedParam (startKoin からの注入パラメータ用) および @Property (プロパティ注入用) も関数メンバで使用可能です。これらのアノテーションの詳細については、定義（definitions）のドキュメントを参照してください。

モジュールの包含 (Including Modules)

モジュールを構成するには、includes 属性を使用します。

@Module
class ModuleA

@Module(includes = [ModuleA::class])
class ModuleB

アプリケーションでルートモジュールを参照します。

@KoinApplication(modules = [ModuleB::class])  // ModuleA が自動的に含まれます
class MyApp

fun main() {
    startKoin<MyApp>()
}