이 페이지는 탐색 코드를 모듈화하는 방법을 안내합니다. 이 가이드는 일반적인 앱 모듈화 가이드를 보완하기 위한 것입니다.
개요
탐색 코드를 모듈화하는 것은 관련 탐색 키와 이 키가 나타내는 콘텐츠를 개별 모듈로 분리하는 프로세스입니다. 이렇게 하면 책임을 명확하게 구분하고 앱의 여러 기능 간에 이동할 수 있습니다.
탐색 코드를 모듈화하려면 다음 단계를 따르세요.
- 앱의 각 기능에 대해
api및impl라는 두 개의 하위 모듈을 만듭니다. - 각 기능의 탐색 키를
api모듈에 배치합니다. - 각 기능의
entryProviders및 탐색 가능한 콘텐츠를 연결된impl모듈에 배치합니다. - 직접 또는 종속 항목 삽입을 사용하여 기본 앱 모듈에
entryProviders를 제공합니다.
기능을 api 및 implementation 하위 모듈로 분리
앱의 각 기능에 대해 api 및 impl('implementation'의 약어)이라는 두 개의 하위 모듈을 만듭니다. 다음 표를 사용하여 탐색 코드를 배치할 위치를 결정합니다.
모듈 이름 |
포함 |
|
|
|
|
이 접근 방식을 사용하면 impl 모듈에 포함된 콘텐츠가 다른 모듈의 api 모듈에 포함된 탐색 키에 종속되도록 허용하여 한 기능이 다른 기능으로 이동할 수 있습니다.

확장 함수를 사용하여 탐색 항목 분리
Navigation 3에서는 탐색 항목을 사용하여 탐색 가능한 콘텐츠를 정의합니다. 이러한 항목을 별도의 모듈로 분리하려면 EntryProviderScope에서 확장 함수를 만들고 해당 기능의 impl 모듈로 이동합니다.
이를 항목 빌더라고 합니다.
다음 코드 예시에서는 두 개의 탐색 항목을 빌드하는 항목 빌더를 보여줍니다.
// import androidx.navigation3.runtime.EntryProviderScope // import androidx.navigation3.runtime.NavKey fun EntryProviderScope<NavKey>.featureAEntryBuilder() { entry<KeyA> { ContentRed("Screen A") { // Content for screen A } } entry<KeyA2> { ContentGreen("Screen A2") { // Content for screen A2 } } }
기본 앱 모듈에서 entryProvider를 정의할 때 entryProvider DSL을 사용하여 이 함수를 호출합니다.
// import androidx.navigation3.runtime.entryProvider // import androidx.navigation3.ui.NavDisplay NavDisplay( entryProvider = entryProvider { featureAEntryBuilder() }, // ... )
종속 항목 삽입을 사용하여 기본 앱에 항목 추가
위의 코드 예시에서 각 항목 빌더는 entryProvider DSL을 사용하여 기본 앱에서 직접 호출됩니다. 앱에 화면이나 기능 모듈이 많으면 이 패턴은 확장성이 떨어질 수 있습니다.
이 문제를 해결하려면 각 기능 모듈이 종속 항목 삽입을 사용하여 앱의 활동에 항목 빌더를 제공하도록 합니다.
예를 들어 다음 코드는 Dagger 멀티바인딩(특히 @IntoSet)을 사용하여 항목 빌더를 MainActivity가 소유한 Set에 삽입합니다. 그런 다음 entryProvider 내에서 반복적으로 호출되므로 수많은 항목 빌더 함수를 명시적으로 호출할 필요가 없습니다.
기능 모듈
// import dagger.Module // import dagger.Provides // import dagger.hilt.InstallIn // import dagger.hilt.android.components.ActivityRetainedComponent // import dagger.multibindings.IntoSet @Module @InstallIn(ActivityRetainedComponent::class) object FeatureAModule { @IntoSet @Provides fun provideFeatureAEntryBuilder() : EntryProviderScope<NavKey>.() -> Unit = { featureAEntryBuilder() } }
앱 모듈
// import android.os.Bundle // import androidx.activity.ComponentActivity // import androidx.activity.compose.setContent // import androidx.navigation3.runtime.EntryProviderScope // import androidx.navigation3.runtime.NavKey // import androidx.navigation3.runtime.entryProvider // import androidx.navigation3.ui.NavDisplay // import javax.inject.Inject class MainActivity : ComponentActivity() { @Inject lateinit var entryBuilders: Set<@JvmSuppressWildcards EntryProviderScope<NavKey>.() -> Unit> override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContent { NavDisplay( entryProvider = entryProvider { entryBuilders.forEach { builder -> this.builder() } }, // ... ) } } }
탐색 항목이 탐색해야 하는 경우(예: 새 화면으로 이동하는 UI 요소가 포함된 경우) 앱의 탐색 상태를 수정할 수 있는 객체를 각 빌더 함수에 삽입합니다.
딥 링크 일치자 모듈화
앱이 딥 링크를 지원하고 모듈화된 경우 각 기능 모듈은 소유한 대상의 DeepLinkMatcher 인스턴스를 정의해야 합니다.
앱 전체에서 모든 매처를 조합하려면 종속 항목 삽입 멀티바인딩을 사용하면 됩니다. 예를 들어 각 기능 모듈은 일치자를 Dagger @IntoSet 멀티바인딩에 제공할 수 있습니다.
기능 모듈
@Module @InstallIn(ActivityRetainedComponent::class) object FeatureADeepLinkModule { @IntoSet @Provides fun provideUserMatcher(): DeepLinkMatcher<*, *> { return UriDeepLinkMatcher( DeepLinkUri("www.example.com/users/{id}"), serializer<UserProfileKey>() ) } }
그런 다음 MainActivity와 같은 기본 앱 모듈에서 일치자 집합을 삽입하고 이를 사용하여 수신 요청을 일치시킬 수 있습니다.
앱 모듈
@AndroidEntryPoint class MainActivityWithDI : ComponentActivity() { @Inject lateinit var deepLinkMatchers: Set<@JvmSuppressWildcards DeepLinkMatcher<*, *>> override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) val request = DeepLinkRequest(intent = intent) val matchResult = deepLinkMatchers .mapNotNull { it.match(request) } .maxOrNull() val backStack = when (matchResult) { null -> listOf(HomeKey) is BackStackMatchResult<*, *> -> { @Suppress("UNCHECKED_CAST") matchResult.backStack as List<NavKey> } else -> listOf(matchResult.key) } } }
딥 링크 정의 및 처리에 관한 자세한 내용은 딥 링크 지원을 참고하세요.
리소스
Navigation 3 코드를 모듈화하는 방법을 보여주는 코드 샘플은 다음을 참고하세요.