Navigation 3 в Compose Multiplatform

Один модуль с запечатанным типом

Для небольших проектов, в которых все маршруты находятся в одном модуле, используйте sealed interface. Это самый простой подход, поскольку Kotlin Serialization автоматически обрабатывает иерархию:

@Serializable
sealed interface Route : NavKey

@Serializable
data object RouteA : Route

@Serializable
data class RouteB(val id: String) : Route

// Backstack with default serializer
val backStack: MutableList<Route> =
    rememberSerializable(serializer = SnapshotStateListSerializer()) {
        mutableStateListOf(RouteA)
    }

Также можно явно использовать функцию rememberNavBackStack(). В таком случае конфигурация будет немного отличаться:

private val config = SavedStateConfiguration {
    serializersModule = SerializersModule {
        polymorphic(NavKey::class) {
            subclassesOfSealed<Route>()
        }
    }
}
val backStack = rememberNavBackStack(config, RouteA)

Несколько модулей с объединёнными запечатанными типами

В более сложных проектах, где маршруты определены в нескольких модулях, можно определить запечатанный тип для каждого модуля. Затем объедините сериализаторы в модуле app с помощью функции subclassesOfSealed().

// Module A
@Serializable sealed interface FeatureA : NavKey
@Serializable data object RouteA1 : FeatureA
@Serializable data object RouteA2 : FeatureA

// Module B
@Serializable sealed interface FeatureB : NavKey
@Serializable data class RouteB1(val id: String) : FeatureB
@Serializable data class RouteB2(val id: String) : FeatureB

// Module app
private val config = SavedStateConfiguration {
    serializersModule = SerializersModule {
        polymorphic(NavKey::class) {
            subclassesOfSealed<FeatureA>()
            subclassesOfSealed<FeatureB>()
        }
    }
}
val backStack = rememberNavBackStack(config, RouteA1)

При использовании внедрения зависимостей (DI) можно также использовать контейнеры DI, чтобы динамически собирать сериализаторы запечатанных типов из каждого модуля в Set<KSerializer>.

Несколько модулей с отдельной регистрацией маршрутов

Если маршруты нельзя сгруппировать в запечатанные типы, можно вручную объединить экземпляры SerializersModule из разных модулей.

// Module A
@Serializable data object RouteA1 : NavKey
@Serializable data object RouteA2 : NavKey

val serializerModuleA = SerializersModule {
    polymorphic(NavKey::class) {
        subclass(RouteA1::class, RouteA1.serializer())
        subclass(RouteA2::class, RouteA2.serializer())
    }
}

// Module B
@Serializable data class RouteB1(val id: String) : NavKey
@Serializable data class RouteB2(val id: String) : NavKey

val serializerModuleB = SerializersModule {
    polymorphic(NavKey::class) {
        subclass(RouteB1::class, RouteB1.serializer())
        subclass(RouteB2::class, RouteB2.serializer())
    }
}

// Module app
private val config = SavedStateConfiguration {
    serializersModule = serializerModuleA + serializerModuleB
}
val backStack = rememberNavBackStack(config, RouteA1)

Этот подход обеспечивает высокую гибкость и слабую связанность, однако требует большего объёма ручного сопровождения. Как и в подходе с несколькими модулями с объединёнными запечатанными типами, для динамического формирования списка сериализаторов можно использовать DI, что повысит гибкость.