สูตรการนำทางแบบโมดูลาร์ (Koin)
สูตรนี้แสดงวิธีจัดโครงสร้างแอปพลิเคชันแบบหลายโมดูลโดยใช้ Navigation 3 และ Koin สำหรับการแทรกทรัพยากร Dependency เป้าหมายคือการสร้างสถาปัตยกรรมที่แยกออกจากกัน ซึ่งมีการกำหนดและใช้งานการนำทางในโมดูลฟีเจอร์ที่แยกกัน โดยจะใช้ Artifact koin-compose-navigation3
วิธีการทำงาน
แอปพลิเคชันแบ่งออกเป็นโมดูล Android หลายโมดูล ดังนี้
-
โมดูล
app: นี่คือโมดูลแอปพลิเคชันหลัก ซึ่งมีKoinDeepLinkActivity(จุดเริ่มต้นที่แสดงการเปิดใช้ Intent ของ Deep Link และ Intent ปกติ),KoinModularActivity(ซึ่งโฮสต์NavDisplayและมอบสิทธิ์ Intent ของ Deep Link ให้Navigator.handleDeepLink(intent)) และเริ่มต้นNavigatorทั่วไป (แก้ปัญหาBackStackMatcher<*, NavKey>ที่ลงทะเบียนทั้งหมดผ่านgetAll()) -
โมดูล
common: โมดูลนี้มีตรรกะการนำทางหลักที่โมดูลแอปพลิเคชันและโมดูลฟีเจอร์ใช้ร่วมกัน ซึ่งรวมถึง- คลาส
Navigatorที่จัดการ Back Stack, แก้ปัญหา Intent ของ Deep Link ขาเข้า และสร้าง Back Stack สังเคราะห์ผ่านhandleDeepLink(intent) startDestination: NavKeyที่ใช้เริ่มต้น Back StackBackStackMatcher<*, NavKey>ซึ่งโมดูลฟีเจอร์ใช้เพื่อมีส่วนร่วมในการจับคู่ Deep Link กับ Back Stack สังเคราะห์
- คลาส
-
โมดูลฟีเจอร์ (เช่น
conversation,profile): แต่ละฟีเจอร์จะแบ่งออกเป็น 2 โมดูลย่อย ดังนี้- โมดูล
api: กำหนด API สาธารณะสำหรับฟีเจอร์ ซึ่งรวมถึงเส้นทางการนำทางและรูปแบบ URI ของ Deep Link ซึ่งจะช่วยให้โมดูลอื่นๆ นำทางไปยังฟีเจอร์นี้ได้โดยไม่ต้องทราบรายละเอียดการใช้งาน - โมดูล
impl: ให้การใช้งานฟีเจอร์ ซึ่งรวมถึง Composable และModuleของ Koin โมดูล Koin ใช้navigationDSL เพื่อกำหนดตัวติดตั้งผู้ให้บริการรายการและsingle<BackStackMatcher<*, NavKey>>(named<...>())ที่กำหนดค่าด้วย.withBackStackเพื่อสร้าง Back Stack แบบลำดับชั้นที่เหมาะสม (เช่น[ConversationList, ConversationDetail(id)])
- โมดูล
แนวทางแบบโมดูลาร์นี้ช่วยให้แยกความกังวลออกจากกันได้อย่างชัดเจน ทำให้ฐานของโค้ดมีความสามารถในการปรับขนาดและดูแลรักษาได้มากขึ้น แต่ละฟีเจอร์มีหน้าที่รับผิดชอบตรรกะการนำทางของตนเอง และโมดูล app จะรวมส่วนต่างๆ เหล่านี้เข้าด้วยกันเท่านั้น
package com.example.nav3recipes.modular.koin import androidx.compose.foundation.background import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Column import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.foundation.layout.padding import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text import androidx.compose.runtime.Composable import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.unit.dp import androidx.navigation3.runtime.NavKey import androidx.navigation3.runtime.deeplink.BackStackMatcher import androidx.navigation3.runtime.deeplink.DeepLinkUri import androidx.navigation3.runtime.deeplink.UriDeepLinkMatcher import androidx.navigation3.runtime.deeplink.withBackStack import kotlinx.serialization.Serializable import org.koin.androidx.scope.dsl.activityRetainedScope import org.koin.core.annotation.KoinExperimentalAPI import org.koin.core.qualifier.named import org.koin.dsl.module import org.koin.dsl.navigation3.navigation // API @Serializable object Profile : NavKey const val PROFILE_URI = "https://www.nav3recipes.com/profile" // IMPL @OptIn(KoinExperimentalAPI::class) val profileModule = module { activityRetainedScope { navigation<Profile> { ProfileScreen() } } single<BackStackMatcher<*, NavKey>>(named<Profile>()) { UriDeepLinkMatcher( uriPattern = DeepLinkUri(PROFILE_URI), serializer = Profile.serializer(), ).withBackStack { matchResult -> listOf(ConversationList, matchResult.key) } } } @Composable private fun ProfileScreen() { val profileColor = MaterialTheme.colorScheme.surfaceVariant Column( modifier = Modifier .fillMaxSize() .background(profileColor) .padding(16.dp), horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.Center ) { Text( text = "Profile Screen", style = MaterialTheme.typography.headlineMedium, color = MaterialTheme.colorScheme.onSurface ) } }
package com.example.nav3recipes.modular.koin import androidx.compose.foundation.background import androidx.compose.foundation.clickable import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Column import androidx.compose.foundation.layout.Spacer import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.foundation.layout.height import androidx.compose.foundation.layout.padding import androidx.compose.foundation.lazy.LazyColumn import androidx.compose.material3.Button import androidx.compose.material3.ListItem import androidx.compose.material3.ListItemDefaults import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text import androidx.compose.runtime.Composable import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.Color import androidx.compose.ui.unit.dp import androidx.lifecycle.compose.dropUnlessResumed import androidx.navigation3.runtime.NavKey import androidx.navigation3.runtime.deeplink.BackStackMatcher import androidx.navigation3.runtime.deeplink.DeepLinkUri import androidx.navigation3.runtime.deeplink.UriDeepLinkMatcher import androidx.navigation3.runtime.deeplink.withBackStack import com.example.nav3recipes.ui.theme.colors import kotlinx.serialization.Serializable import org.koin.androidx.scope.dsl.activityRetainedScope import org.koin.core.annotation.KoinExperimentalAPI import org.koin.core.qualifier.named import org.koin.dsl.module import org.koin.dsl.navigation3.navigation // API object ConversationList : NavKey @Serializable data class ConversationDetail(val id: Int) : NavKey { val color: Color get() = colors[id % colors.size] } const val CONVERSATION_URI = "https://www.nav3recipes.com/conversation" // IMPL @OptIn(KoinExperimentalAPI::class) val conversationModule = module { activityRetainedScope { navigation<ConversationList> { ConversationListScreen( onConversationClicked = { conversationDetail -> get<Navigator>().goTo(conversationDetail) } ) } navigation<ConversationDetail> { key -> ConversationDetailScreen(key) { get<Navigator>().goTo(Profile) } } } single<BackStackMatcher<*, NavKey>>(named<ConversationDetail>()) { UriDeepLinkMatcher( uriPattern = DeepLinkUri("$CONVERSATION_URI/{id}"), serializer = ConversationDetail.serializer(), ).withBackStack { matchResult -> listOf(ConversationList, matchResult.key) } } } @Composable private fun ConversationListScreen( onConversationClicked: (ConversationDetail) -> Unit ) { LazyColumn( modifier = Modifier.fillMaxSize(), ) { items(10) { index -> val conversationId = index + 1 val conversationDetail = ConversationDetail(conversationId) val backgroundColor = conversationDetail.color ListItem( modifier = Modifier .fillMaxWidth() .clickable(onClick = dropUnlessResumed { onConversationClicked(conversationDetail) }), headlineContent = { Text( text = "Conversation $conversationId", style = MaterialTheme.typography.headlineSmall, color = MaterialTheme.colorScheme.onSurface ) }, colors = ListItemDefaults.colors( containerColor = backgroundColor // Set container color directly ) ) } } } @Composable private fun ConversationDetailScreen( conversationDetail: ConversationDetail, onProfileClicked: () -> Unit ) { Column( modifier = Modifier .fillMaxSize() .background(conversationDetail.color) .padding(16.dp), horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.Center ) { Text( text = "Conversation Detail Screen: ${conversationDetail.id}", style = MaterialTheme.typography.headlineMedium, color = MaterialTheme.colorScheme.onSurface ) Spacer(modifier = Modifier.height(16.dp)) Button(onClick = dropUnlessResumed(block = onProfileClicked)) { Text("View Profile") } } }
package com.example.nav3recipes.modular.koin import android.content.Intent import androidx.compose.runtime.mutableStateListOf import androidx.compose.runtime.snapshots.SnapshotStateList import androidx.navigation3.runtime.NavKey import androidx.navigation3.runtime.deeplink.BackStackMatcher import androidx.navigation3.runtime.deeplink.DeepLinkRequest import androidx.navigation3.runtime.deeplink.invoke class Navigator( startDestination: NavKey, private val deepLinkMatchers: List<BackStackMatcher<*, NavKey>>, ) { val backStack: SnapshotStateList<NavKey> = mutableStateListOf(startDestination) fun goTo(destination: NavKey) { backStack.add(destination) } fun handleDeepLink(intent: Intent) { if (intent.data == null && intent.extras == null) return val request = DeepLinkRequest(intent) val matchResult = deepLinkMatchers.firstNotNullOfOrNull { matcher -> matcher.match(request) } ?: return backStack.clear() backStack.addAll(matchResult.backStack) } fun goBack() { backStack.removeLastOrNull() } }
package com.example.nav3recipes.modular.koin import org.koin.androidx.scope.dsl.activityRetainedScope import org.koin.dsl.module val appModule = module { includes(profileModule, conversationModule) activityRetainedScope { scoped { Navigator( startDestination = ConversationList, deepLinkMatchers = getAll(), ) } } }
package com.example.nav3recipes.modular.koin import android.os.Bundle import androidx.activity.ComponentActivity import androidx.activity.compose.setContent import androidx.compose.foundation.layout.padding import androidx.compose.material3.Scaffold import androidx.compose.ui.Modifier import androidx.navigation3.ui.NavDisplay import com.example.nav3recipes.ui.setEdgeToEdgeConfig import org.koin.android.ext.android.inject import org.koin.android.scope.AndroidScopeComponent import org.koin.androidx.compose.navigation3.getEntryProvider import org.koin.androidx.scope.activityRetainedScope import org.koin.core.Koin import org.koin.core.annotation.KoinExperimentalAPI import org.koin.core.component.KoinComponent import org.koin.core.scope.Scope import org.koin.dsl.koinApplication /** * This recipe demonstrates how to use a modular approach with Navigation 3, * where different parts of the application are defined in separate modules and injected * into the main app using Koin. * * Features (Conversation and Profile) are split into two modules: * - api: defines the public facing routes for this feature * - impl: defines the entryProviders for this feature, these are injected into the app's main activity * The common module defines: * - a common navigator class that exposes a back stack and methods to modify that back stack * - a type that should be used by feature modules to inject entryProviders into the app's main activity * The app module creates the navigator by supplying a start destination and provides this navigator * to the rest of the app module (i.e. MainActivity) and the feature modules. */ @OptIn(KoinExperimentalAPI::class) class KoinModularActivity : ComponentActivity(), AndroidScopeComponent, KoinComponent { // Local Koin Context Instance companion object { private val localKoin = koinApplication { modules(appModule) }.koin } // Override default Koin context to use the local one override fun getKoin(): Koin = localKoin override val scope : Scope by activityRetainedScope() val navigator: Navigator by inject() override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setEdgeToEdgeConfig() navigator.handleDeepLink(intent) setContent { Scaffold { paddingValues -> NavDisplay( backStack = navigator.backStack, modifier = Modifier.padding(paddingValues), onBack = { navigator.goBack() }, entryProvider = getEntryProvider() ) } } } }