マルチモジュールアプリ
このページでは、Gradleモジュール(:app、:feature:*、:core:*)に分割されたAndroidアプリでKoinを構成する方法について説明します。各Koinモジュールの配置場所、アプリによるモジュールの読み込み方法、機能間で型を共有する方法、およびDynamic Featureモジュールについて扱います。モジュールの合成(includes()、パブリックおよびプライベートモジュール、@Configuration`)については、モジュールで説明しています。
プロジェクト構成
:app Application class, startKoin, appModule
:feature:login LoginViewModel, LoginUseCase, loginModule
:feature:profile ProfileViewModel, profileModule
:core:data repositories, Retrofit, Room, dataModule
:core:domain interfaces shared by features (UserRepository)各Gradleモジュールは、自身のクラスに対応するKoinモジュールを宣言します。これにより、クラスをそのGradleモジュールに対してinternalのままに維持でき、Koinモジュールのみを公開(public)にすることができます。:appモジュールだけがすべての機能(feature)を認識しているため、Koinの開始処理はここで行われます。
機能モジュールの宣言とロード
// Gradle module ":feature:login"
internal class LoginUseCase(private val auth: AuthService)
internal class LoginViewModel(private val login: LoginUseCase) : ViewModel()
val loginModule = module {
factory<LoginUseCase>()
viewModel<LoginViewModel>()
}// Gradle module ":app"
val appModule = module {
includes(dataModule, loginModule, profileModule)
}
class MainApplication : Application() {
override fun onCreate() {
super.onCreate()
startKoin {
androidLogger()
androidContext(this@MainApplication)
modules(appModule)
}
}
}// Gradle module ":feature:login"
@Module
@ComponentScan("com.app.feature.login")
@Configuration
class LoginModule
@Factory
internal class LoginUseCase(private val auth: AuthService)
@KoinViewModel
internal class LoginViewModel(private val login: LoginUseCase) : ViewModel()// Gradle module ":app"
@KoinApplication
class MainApplication : Application() {
override fun onCreate() {
super.onCreate()
startKoin<MainApplication> {
androidLogger()
androidContext(this@MainApplication)
}
}
}startKoin<MainApplication>()は、機能のGradleモジュールからのものを含め、アプリのクラスパス上にあるすべての@Configurationモジュールを検出します。機能を追加する作業は、Gradleの依存関係を追加するだけで済み、それ以外の作業は不要です。代わりにモジュールを明示的に指定してリストアップするには、@KoinApplication(modules = [LoginModule::class, ProfileModule::class])を使用します。
// Gradle module ":feature:login"
internal class LoginUseCase(private val auth: AuthService)
internal class LoginViewModel(private val login: LoginUseCase) : ViewModel()
val loginModule = module {
factoryOf(::LoginUseCase)
viewModelOf(::LoginViewModel)
}// Gradle module ":app"
val appModule = module {
includes(dataModule, loginModule, profileModule)
}
class MainApplication : Application() {
override fun onCreate() {
super.onCreate()
startKoin {
androidLogger()
androidContext(this@MainApplication)
modules(appModule)
}
}
}機能間での型の共有
機能が別の機能に依存するべきではありません。:feature:profileが現在のユーザー(current user)を必要とする場合、coreモジュール内のインターフェースに依存し、その実装はそのクラスが存在する場所でバインドされます。
// Gradle module ":core:domain"
interface UserRepository {
suspend fun currentUser(): User
}// Gradle module ":core:data"
internal class UserRepositoryImpl(private val api: ApiService) : UserRepository
val dataModule = module {
single<UserRepositoryImpl>() bind UserRepository::class
}// Gradle module ":core:data"
@Singleton
internal class UserRepositoryImpl(private val api: ApiService) : UserRepository// Gradle module ":core:data"
internal class UserRepositoryImpl(private val api: ApiService) : UserRepository
val dataModule = module {
singleOf(::UserRepositoryImpl) bind UserRepository::class
}これにより、:feature:profile内のProfileViewModel(private val users: UserRepository)は、実行時にUserRepositoryImplを解決します。すべてのKoinモジュールがロードされている限り、KoinはGradleモジュールをまたいで解決するため、機能側はインターフェース型を参照できるだけで十分です。機能ごとに追加のエントリポイントインターフェースやコンポーネントを用意する必要はありません。
Compiler Pluginを使用する場合、機能モジュール自身にはstartKoinがないため、:appがコンパイルされて完全なグラフを組み立てる際に依存関係がチェックされます。コンパイル時の安全性を参照してください。
Dynamic Featureモジュール
Play Feature Deliveryでは、ベースアプリからDynamic Featureモジュールのコードを参照することはできません。依存関係は機能からアプリに向かうためです。機能のエントリActivity内で、loadKoinModules()を使用して機能自身のKoinモジュールを機能自身からロードします。
// Dynamic feature module ":feature:premium"
internal object PremiumKoin {
private val modules = lazy { loadKoinModules(premiumModule) }
fun load() = modules.value
}
class PremiumActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
PremiumKoin.load()
super.onCreate(savedInstanceState)
}
}lazyにより、モジュールがプロセスごとに1回、super.onCreate()の前に確実にロードされます。これら双方が重要である理由やアンロード方法については、AndroidでのKoinの開始で説明しています。
Compiler Pluginはこの方法でロードされたモジュールを認識できません。ベースアプリで使用される型で、このようなモジュールからのみ提供されるものには、@Providedを付与する必要があります(コンパイル時の安全性を参照)。
機能モジュールのテスト
他のモジュールが提供するものに対してフェイク(Fake)を使用し、各機能モジュールを単独でテストします。Compiler Pluginを使用すると、ビルド時にグラフ全体がチェックされます。使用しない場合は、verify()を使用して各モジュールをチェックします(設定の検証を参照)。Koinを使用した単体テストについてはユニットテストで、実機(オンデバイス)テストについてはインストゥルメンテッドテストで解説しています。
関連情報
- モジュール:
includes()、モジュールの可視性、および@Configurationの検出。 - AndroidでのKoinの開始:
startKoinと実行時におけるモジュールのロード。 - コンパイル時の安全性: Gradleモジュールをまたいでグラフをチェックする方法。
- 遅延モジュール: 起動時にバックグラウンドで機能モジュールをロードする。
- Androidライブラリの統合: データ層、ドメイン層、UI層。
