Перенос навигации Jetpack в Navigation Compose

API Navigation Compose позволяет перемещаться между компонуемыми элементами в приложении Compose, используя при этом преимущества компонентов, инфраструктуры и функций Jetpack Navigation .

На этой странице описывается, как перейти от навигации Jetpack на основе фрагментов к Navigation Compose в рамках более масштабной миграции пользовательского интерфейса на основе представлений к Jetpack Compose.

Предпосылки миграции

Вы можете перейти на Navigation Compose, как только сможете заменить все свои Fragments соответствующими компонуемыми экранами . Компонуемые экраны могут содержать смесь содержимого Compose и View , но все пункты назначения навигации должны быть компонуемыми, чтобы включить миграцию Navigation Compose. До тех пор вам следует продолжать использовать компонент Navigation на основе Fragment в кодовой базе Interop View и Compose. Дополнительную информацию см. в документации по взаимодействию навигации .

Использование Navigation Compose в приложении Compose-only не является обязательным условием. Вы можете продолжать использовать компонент Fragment-based Navigation , пока вы сохраняете Fragments для размещения вашего компонуемого контента .

Этапы миграции

Независимо от того, следуете ли вы нашей рекомендуемой стратегии миграции или используете другой подход, вы достигнете точки, в которой все пункты назначения навигации будут экранными компонуемыми, а фрагменты будут действовать только как компонуемые контейнеры. На этом этапе вы можете перейти на Navigation Compose.

Если ваше приложение уже соответствует шаблону проектирования UDF и нашему руководству по архитектуре , переход на Jetpack Compose и Navigation Compose не потребует серьезных рефакторингов других слоев вашего приложения, за исключением слоя пользовательского интерфейса.

Чтобы перейти на Navigation Compose, выполните следующие действия:

  1. Добавьте зависимость Navigation Compose в свое приложение.

  2. Создайте компонуемый объект App-level и добавьте его в Activity в качестве точки входа Compose, заменив настройку макета View: 

    class SampleActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // setContentView<ActivitySampleBinding>(this, R.layout.activity_sample)
        setContent {
            SampleApp(/* ... */)
        }
    }
}
    MigrationCommonScenariosSnippets.kt

  3. Создайте типы для каждого пункта назначения навигации. Используйте data object для пунктов назначения, которые не требуют никаких данных, и data class или class для пунктов назначения, которые требуют данных. 

    @Serializable data object First
@Serializable data class Second(val id: String)
@Serializable data object Third

    MigrationCommonScenariosSnippets.kt

  4. Установите NavController в месте, где все компонуемые элементы, которым нужно ссылаться на него, будут иметь к нему доступ (обычно это внутри вашего компонуемого элемента App ). Этот подход следует принципам подъема состояния и позволяет использовать NavController в качестве источника истины для навигации между компонуемыми экранами и поддержания обратного стека: 

    @Composable
fun SampleApp() {
    val navController = rememberNavController()
    // ...
}
    MigrationCommonScenariosSnippets.kt

  5. Создайте NavHost вашего приложения внутри компонуемого App и передайте navController : 

    @Composable
fun SampleApp() {
    val navController = rememberNavController()

    SampleNavHost(navController = navController)
}

@Composable
fun SampleNavHost(
    navController: NavHostController
) {
    NavHost(navController = navController, startDestination = First) {
        // ...
    }
}
    MigrationCommonScenariosSnippets.kt

  6. Добавьте composable пункты назначения для построения вашего навигационного графика. Если каждый экран был ранее перенесен в Compose, этот шаг состоит только из извлечения этих компонуемых экранов из ваших фрагментов в composable пункты назначения: 

    class FirstFragment : Fragment() {

    override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View {
        return ComposeView(requireContext()).apply {
            setContent {
                // FirstScreen(...) EXTRACT FROM HERE
            }
        }
    }
}

@Composable
fun SampleNavHost(
    navController: NavHostController
) {
    NavHost(navController = navController, startDestination = First) {
        composable<First> {
            FirstScreen(/* ... */) // EXTRACT TO HERE
        }
        composable<Second> {
            SecondScreen(/* ... */)
        }
        // ...
    }
}
    MigrationCommonScenariosSnippets.kt

  7. Если вы следовали руководству по архитектуре вашего Compose UI , в частности, как ViewModel и события навигации должны передаваться в компонуемые элементы, следующим шагом будет изменение способа предоставления ViewModel для каждого компонуемого элемента экрана. Часто можно использовать внедрение Hilt и его точку интеграции с Compose и Navigation через hiltViewModel : 

    @Composable
fun FirstScreen(
    // viewModel: FirstViewModel = viewModel(),
    viewModel: FirstViewModel = hiltViewModel(),
    onButtonClick: () -> Unit = {},
) {
    // ...
}
    MigrationCommonScenariosSnippets.kt

  8. Замените все навигационные вызовы findNavController() на вызовы navController и передайте их как навигационные события на каждый составной экран, а не передавайте весь navController . Этот подход следует лучшим практикам предоставления событий из составных функций вызывающим и сохраняет navController как единственный источник истины.

    Данные могут быть переданы в пункт назначения путем создания экземпляра класса маршрута, определенного для этого пункта назначения. Затем их можно получить либо напрямую из записи обратного стека в пункте назначения, либо из ViewModel с помощью SavedStateHandle.toRoute() . 

    @Composable
fun SampleNavHost(
    navController: NavHostController
) {
    NavHost(navController = navController, startDestination = First) {
        composable<First> {
            FirstScreen(
                onButtonClick = {
                    // findNavController().navigate(firstScreenToSecondScreenAction)
                    navController.navigate(Second(id = "ABC"))
                }
            )
        }
        composable<Second> { backStackEntry ->
            val secondRoute = backStackEntry.toRoute<Second>()
            SecondScreen(
                id = secondRoute.id,
                onIconClick = {
                    // findNavController().navigate(secondScreenToThirdScreenAction)
                    navController.navigate(Third)
                }
            )
        }
        // ...
    }
}
    MigrationCommonScenariosSnippets.kt

  9. Удалите все фрагменты, соответствующие XML-макеты, ненужную навигацию и другие ресурсы, а также устаревшие зависимости фрагментов и навигации Jetpack.

Те же шаги с более подробной информацией, связанной с навигацией, можно найти в документации по настройке .

Распространенные варианты использования

Независимо от того, какой компонент навигации вы используете, применяются одни и те же принципы навигации .

Распространенные варианты использования при миграции включают в себя следующее:

Более подробную информацию об этих вариантах использования см. в разделе Навигация с помощью Compose .

Извлекайте сложные данные при навигации

Мы настоятельно рекомендуем не передавать сложные объекты данных при навигации. Вместо этого передайте минимально необходимую информацию, такую ​​как уникальный идентификатор или другую форму идентификатора, в качестве аргументов при выполнении действий навигации. Сложные объекты следует хранить как данные в едином источнике истины, таком как уровень данных . Для получения дополнительной информации см. Извлечение сложных данных при навигации .

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

Ограничения

В этом разделе описываются текущие ограничения для Navigation Compose.

Поэтапная миграция в Navigation Compose

В настоящее время вы не можете использовать Navigation Compose, пока используете Fragments в качестве пунктов назначения в вашем коде. Чтобы начать использовать Navigation Compose, все ваши пункты назначения должны быть компонуемыми. Вы можете отслеживать этот запрос на функцию в Issue Tracker .

Анимация перехода

Начиная с Navigation 2.7.0-alpha01 , поддержка настройки пользовательских переходов, ранее от AnimatedNavHost , теперь напрямую поддерживается в NavHost . Прочитайте заметки о выпуске для получения дополнительной информации.

Узнать больше

Дополнительную информацию о переходе на Navigation Compose можно найти в следующих ресурсах:

  • Лабораторная работа по созданию Navigation Compose : изучите основы Navigation Compose с помощью практической лабораторной работы.
  • Теперь в репозитории Android : полнофункциональное приложение Android, созданное полностью с использованием Kotlin и Jetpack Compose, которое соответствует лучшим практикам проектирования и разработки Android и включает Navigation Compose.
  • Миграция Sunflower в Jetpack Compose : запись в блоге, в которой описывается процесс миграции примера приложения Sunflower с Views на Compose, который также включает миграцию на Navigation Compose.
  • Jetnews для каждого экрана : запись в блоге, в которой описывается рефакторинг и миграция примера Jetnews для поддержки всех экранов с помощью Jetpack Compose и Navigation Compose.
{% дословно %} {% endverbatim %} {% дословно %} {% endverbatim %}