多模組 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 測試指南