マルチモジュールAndroidアプリ

このガイドでは、Koinを使用したマルチモジュールアーキテクチャのAndroid特有の側面について説明します。

INFO

モジュールの中心的な概念（includes()、構成、オーバーライド）については、Modulesを参照してください。

Androidアプリケーションのセットアップ

アノテーションを使用する場合

@KoinApplication(AppModule::class)
class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        startKoin<MyApplication> {
            androidLogger()
            androidContext(this@MyApplication)
        }
    }
}

// ルートモジュールにすべての機能を含めます
@Module(includes = [LoginModule::class, HomeModule::class, ProfileModule::class])
class AppModule

DSLを使用する場合

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        startKoin {
            androidLogger()
            androidContext(this@MyApplication)
            modules(appModule)  // 単一のルートモジュール
        }
    }
}

// ルートモジュールにすべての機能を含めます
val appModule = module {
    includes(
        loginModule,
        homeModule,
        profileModule
    )
}

フィーチャーモジュールの例

// :feature:login モジュール
@KoinViewModel
class LoginViewModel(
    private val loginUseCase: LoginUseCase,
    private val userRepository: UserRepository
) : ViewModel()

@Factory
class LoginUseCase(private val authService: AuthService)

@Module(includes = [DataModule::class])
@ComponentScan("com.app.feature.login")
class LoginModule

// DSLでの同等コード
val loginModule = module {
    includes(dataModule)
    viewModel<LoginViewModel>()
    factory<LoginUseCase>()
}

動的なモジュールのロード

Activityのライフサイクルに合わせて、必要に応じて（オンデマンドで）フィーチャーモジュールをロードします。

class FeatureActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        loadKoinModules(featureModule)
        super.onCreate(savedInstanceState)
    }

    override fun onDestroy() {
        super.onDestroy()
        unloadKoinModules(featureModule)
    }
}

KoinとHiltの比較

Hilt	Koin
@HiltAndroidApp	startKoin { androidContext() }
@InstallIn(SingletonComponent)	startKoin {} 内でロードされたモジュール
モジュール間連携のための @EntryPoint	自動解決
コンポーネントの依存関係	includes()
@ApplicationContext	androidContext() (自動)

INFO

Koinの利点: @EntryPoint インターフェースは不要です。すべてのモジュールがロードされている限り、依存関係はモジュールをまたいで自動的に解決されます。

Androidでのテスト

モジュールを単体でテストする

class LoginViewModelTest : KoinTest {

    @get:Rule
    val koinTestRule = KoinTestRule.create {
        modules(
            loginModule,
            module {
                single<UserRepository> { mockk() }
                single<AuthService> { mockk() }
            }
        )
    }

    private val viewModel: LoginViewModel by inject()

    @Test
    fun `test login`() {
        // モック化された依存関係を使用してテストする
    }
}

すべてのモジュールを検証する

class ModuleCheckTest : KoinTest {

    @Test
    fun `verify all modules`() {
        appModule.verify()  // 含まれているモジュールも検証します
    }
}

関連項目

• Modules - includes() を使用したコアモジュールの概念
• Android Module Loading - 動的なモジュールのロード
• Lazy Modules - バックグラウンドでのモジュールのロード
• Testing - Androidテストガイド