Dodano obsługę gestu przewidywanego przejścia wstecz

Rysunek 1. Mockup przewidującego gestu wstecz na telefonie

Przejście wstecz na podstawie przewidywania to funkcja nawigacji za pomocą gestów, która pozwala użytkownikom wyświetlić podgląd miejsca, do którego doprowadzi ich gest przesunięcia wstecz.

Na przykład gest cofania może wyświetlić animowany podgląd ekranu głównego za aplikacją, jak pokazano na makiecie na rysunku 1.

Od Androida 15 opcja przewidywania animacji wstecz nie jest już dostępna. Animacje systemowe, takie jak animacja powrotu do ekranu głównego, animacja przełączania zadań i animacja przełączania aktywności, są teraz wyświetlane w aplikacjach, które korzystają z przewidywanego gestu wstecz, niezależnie od tego, czy korzystają z niego całkowicie, czy tylko na poziomie aktywności.

Możesz przetestować animację powrotu do strony głównej (jak opisano w następnej sekcji tej strony).

Obsługa przewidującego gestu wstecz wymaga zaktualizowania aplikacji przy użyciu zgodnego z poprzednimi wersjami interfejsu OnBackPressedCallback AppCompat 1.6.0-alpha05 (AndroidX) lub nowszego albo nowego interfejsu OnBackInvokedCallback platformy API. Większość aplikacji korzysta z interfejsu AndroidX API zgodnego ze starszymi wersjami.

Ta aktualizacja zapewnia ścieżkę migracji, która umożliwia prawidłowe przechwytywanie przekierowań wstecz. Polega ona na zastąpieniu przechwytywania wstecz z interfejsu KeyEvent.KEYCODE_BACK i wszystkich klas z metodami onBackPressed, takimi jak Activity i Dialog, nowymi interfejsami API systemu Back.

Filmy z Codelab i Google I/O

Oprócz korzystania z tej dokumentacji możesz też wypróbować nasze ćwiczenia z programowania. Udostępnia ona implementację WebView obsługującą przewidujący gest wstecz za pomocą interfejsów Activity API z AndroidX.

Możesz też obejrzeć nasz film z Google I/O, który zawiera dodatkowe przykłady implementacji interfejsów API AndroidX i platformy.

Zaktualizuj aplikację, która używa domyślnej nawigacji wstecz

Zaktualizowanie aplikacji, aby obsługiwała tę funkcję, jest proste, jeśli aplikacja nie implementuje żadnego niestandardowego zachowania przy cofaniu (czyli pozostawia obsługę cofnięcia systemowi). Zaakceptuj tę funkcję zgodnie z instrukcjami podanymi w tym przewodniku.

Jeśli Twoja aplikacja używa fragmentów lub komponentu nawigacji, uaktualnij je do wersji AndroidX Activity 1.6.0-alpha05 lub nowszej.

Aktualizacja aplikacji, która korzysta z niestandardowej nawigacji wstecz

Jeśli aplikacja implementuje niestandardowe zachowanie przy wstecznym przechodzeniu, dostępne są różne ścieżki migracji w zależności od tego, czy korzysta ona z AndroidX i jak obsługuje nawigację wsteczną.

Twoja aplikacja używa AndroidX Jak aplikacja obsługuje przekierowanie wstecz Zalecany sposób migracji (link na tej stronie)
Tak Interfejsy API AndroidX Migracja istniejącej implementacji AndroidX back
Nieobsługiwane interfejsy API platform Przejście z aplikacji AndroidX zawierającej nieobsługiwane interfejsy API nawigacji wstecz na interfejsy API AndroidX
Nie Interfejsy API nieobsługiwanych platform, które można przenieść Przejście z aplikacji korzystającej z nieobsługiwanych interfejsów API nawigacji wstecz na interfejsy API platformy
Nieobsługiwane interfejsy API platformy, ale nie można przeprowadzić migracji Odrocz akceptację do czasu, gdy ta funkcja stanie się wymagana.

Migracja implementacji przechodzenia wstecz w AndroidX

Ten przypadek użycia jest najczęstszy (i najbardziej zalecany). Dotyczy to nowych lub istniejących aplikacji, które implementują niestandardowe gesty nawigacyjne za pomocą OnBackPressedDispatcher, zgodnie z opisem w artykule Niestandardowa nawigacja wstecz.

Jeśli Twoja aplikacja pasuje do tej kategorii, wykonaj te czynności, aby dodać obsługę przewidującego gestu wstecz:

  1. Aby zapewnić płynne działanie interfejsów API, które już korzystają z interfejsów API OnBackPressedDispatcher (takich jak fragmenty i komponent nawigacji), z użyciem przewidującego gestu wstecz, zaktualizuj AndroidX Activity 1.6.0-alpha05.

    // In your build.gradle file:
dependencies {

// Add this in addition to your other dependencies
implementation "androidx.activity:activity:1.6.0-alpha05"

  2. Włącz gest przewidywanego przejścia wstecz zgodnie z opisem na tej stronie.

Migracja aplikacji AndroidX zawierającej nieobsługiwane interfejsy API nawigacji wstecz do interfejsów API AndroidX

Jeśli Twoja aplikacja korzysta z bibliotek AndroidX, ale implementuje lub odwołuje się do nieobsługiwanych interfejsów API nawigacji wstecz, musisz przejść na korzystanie z interfejsów API AndroidX, aby obsługiwać nowe działanie.

Aby przenieść nieobsługiwane interfejsy API do interfejsów API AndroidX:

  1. Przejdź na system AndroidX OnBackPressedDispatcher z implementacją OnBackPressedCallback. Szczegółowe wskazówki znajdziesz w artykule Dodawanie niestandardowej opcji Wstecz.

  2. Gdy chcesz przestać przechwytywać gest wstecz, wyłącz OnBackPressedCallback.

  3. Przestań przechwytywać zdarzenia „back” za pomocą funkcji OnBackPressed lub KeyEvent.KEYCODE_BACK.

  4. Zaktualizuj do AndroidX Activity 1.6.0-alpha05.

    // In your build.gradle file:
dependencies {

// Add this in addition to your other dependencies
implementation "androidx.activity:activity:1.6.0-alpha05"

  5. Po zakończeniu migracji aplikacji zezwól na użycie przewidującego gestu wstecz (jak opisano na tej stronie), aby wyświetlić animację powrotu do ekranu głównego.

Migracja aplikacji, która korzysta z nieobsługiwanych interfejsów API nawigacji wstecz, do interfejsów API platformy

Jeśli Twoja aplikacja nie może używać bibliotek AndroidX, a zamiast tego implementuje lub odwołuje się do niestandardowej nawigacji wstecz za pomocą nieobsługiwanych interfejsów API, musisz przejść na interfejs API platformy OnBackInvokedCallback.

Aby przenieść nieobsługiwane interfejsy API do interfejsu API platformy, wykonaj te czynności:

  1. Używaj nowego interfejsu API OnBackInvokedCallback na urządzeniach z Androidem 13 lub nowszym, a na urządzeniach z Androidem 12 lub starszym korzystaj z nieobsługiwanych interfejsów API.

  2. Zarejestruj niestandardową logikę w funkcji OnBackInvokedCallback za pomocą funkcji onBackInvokedDispatcher. Dzięki temu bieżąca aktywność nie zostanie zakończona, a Twoja funkcja wywołania zwrotnego będzie mogła zareagować na działanie Wstecz, gdy użytkownik użyje tej opcji w systemie.

  3. Gdy chcesz przestać przechwytywać gest wstecz, zarejestruj OnBackInvokedCallback. W przeciwnym razie użytkownicy mogą zauważyć niepożądane działanie podczas korzystania z systemu Wstecz – np. „zawieszanie się” między widokami, co zmusza ich do przymusowego zamknięcia aplikacji.

    Oto przykład migracji logiki z poziomu onBackPressed:

    Kotlin

    @Override
fun onCreate() {
    if (BuildCompat.isAtLeastT()) {
        onBackInvokedDispatcher.registerOnBackInvokedCallback(
            OnBackInvokedDispatcher.PRIORITY_DEFAULT
        ) {
            /**
             * onBackPressed logic goes here. For instance:
             * Prevents closing the app to go home screen when in the
             * middle of entering data to a form
             * or from accidentally leaving a fragment with a WebView in it
             *
             * Unregistering the callback to stop intercepting the back gesture:
             * When the user transitions to the topmost screen (activity, fragment)
             * in the BackStack, unregister the callback by using
             * OnBackInvokeDispatcher.unregisterOnBackInvokedCallback
             * (https://developer.android.com/reference/kotlin/android/window/OnBackInvokedDispatcher#unregisteronbackinvokedcallback)
             */
        }
    }
}

    Java

    @Override
void onCreate() {
  if (BuildCompat.isAtLeastT()) {
    getOnBackInvokedDispatcher().registerOnBackInvokedCallback(
        OnBackInvokedDispatcher.PRIORITY_DEFAULT,
        () -> {
          /**
           * onBackPressed logic goes here - For instance:
           * Prevents closing the app to go home screen when in the
           * middle of entering data to a form
           * or from accidentally leaving a fragment with a WebView in it
           *
           * Unregistering the callback to stop intercepting the back gesture:
           * When the user transitions to the topmost screen (activity, fragment)
           * in the BackStack, unregister the callback by using
           * OnBackInvokeDispatcher.unregisterOnBackInvokedCallback
           * (https://developer.android.com/reference/kotlin/android/view/OnBackInvokedDispatcher#unregisteronbackinvokedcallback)
           */
        }
    );
  }
}

  4. Przestań przechwytywać zdarzenia wstecz za pomocą OnBackPressed lub KeyEvent.KEYCODE_BACK w Androidzie 13 i nowszych.

  5. Po migracji aplikacji zezwól na użycie przewidującego gestu wstecz (jak opisano na tej stronie), aby OnBackInvokedCallback zaczęło działać.

Można zarejestrować OnBackInvokedCallback za pomocą PRIORITY_DEFAULT lub PRIORITY_OVERLAY, co nie jest możliwe w przypadku podobnego pakietu AndroidX OnBackPressedCallback. W niektórych przypadkach przydatne może być zarejestrowanie wywołania zwrotnego za pomocą funkcji PRIORITY_OVERLAY.

Dotyczy to sytuacji, gdy migrujesz z onKeyPreIme() i Twoje wywołanie zwrotne musi otrzymać gest wstecz zamiast otwartego IME. Gdy IME zostanie otwarte, rejestruje wywołania zwrotne z PRIORITY_DEFAULT. Zarejestruj wywołanie zwrotne w PRIORITY_OVERLAY, aby mieć pewność, że OnBackInvokedDispatcher przekaże gest wstecz do wywołania zwrotnego zamiast do otwartego IME.

Włączanie gestu przewidywanego przejścia wstecz

Gdy określisz, jak zaktualizować aplikację na podstawie swojego przypadku, włącz obsługę przewidującego gestu wstecz.

Aby to zrobić, w tagu AndroidManifest.xml ustaw flagę android:enableOnBackInvokedCallback na true.<application>

<application
    ...
    android:enableOnBackInvokedCallback="true"
    ... >
...
</application>

Jeśli nie podasz wartości, zostanie użyta domyślna wartość false, a w ramach tej wartości:

  • Wyłącza animację systemową przewidywanego gestu cofania.
  • Ignoruje OnBackInvokedCallback, ale OnBackPressedCallback nadal działa.

Akceptacja na poziomie aktywności

Od Androida 14 flaga android:enableOnBackInvokedCallback umożliwia włączenie animacji systemowych przewidujących na poziomie aktywności. Dzięki temu przenoszenie dużych aplikacji wielozadaniowych na przewidujące gesty wstecz jest łatwiejsze. W Androidzie 15 przewidywane cofnięcie nie jest już opcją dla deweloperów. Aplikacje mogą korzystać z przewidywania wstecznego w pełni lub na poziomie aktywności.

Poniższy kod pokazuje przykład użycia funkcji enableOnBackInvokedCallback do włączenia animacji systemu powrotu do domu z poziomu MainActivity:

<manifest ...>
    <application . . .

        android:enableOnBackInvokedCallback="false">

        <activity
            android:name=".MainActivity"
            android:enableOnBackInvokedCallback="true"
            ...
        </activity>
        <activity
            android:name=".SecondActivity"
            android:enableOnBackInvokedCallback="false"
            ...
        </activity>
    </application>
</manifest>

W powyższym przykładzie ustawienie android:enableOnBackInvokedCallback=true dla ".SecondActivity" powoduje włączenie animacji systemowej obejmującej wiele aktywności.

Podczas korzystania z flagi android:enableOnBackInvokedCallback należy wziąć pod uwagę te kwestie:

  • Ustawienie android:enableOnBackInvokedCallback=false wyłącza przewidywane animacje wsteczne na poziomie aktywności lub aplikacji (w zależności od tego, gdzie ustawisz tag), a także zleci systemowi zignorowanie wywołań interfejsu API platformy OnBackInvokedCallback. Wywołania interfejsu OnBackPressedCallback są jednak nadal wykonywane, ponieważ interfejs OnBackPressedCallback jest zgodny ze starszymi wersjami i wywołuje interfejs API onBackPressed, który nie jest obsługiwany w wersjach Androida wcześniejszych niż 13.
  • Ustawienie flagi enableOnBackInvokedCallback na poziomie aplikacji ustala wartość domyślną dla wszystkich aktywności w aplikacji. Możesz ją zastąpić dla danej aktywności, ustawiając flagę na poziomie aktywności, jak pokazano w poprzednim przykładzie kodu.

Sprawdzone metody dotyczące wywołania zwrotnego

Oto sprawdzone metody korzystania z obsługiwanych wywołań zwrotnych systemu: BackHandler (dla funkcji tworzenia wiadomości), OnBackPressedCallback lub OnBackInvokedCallback.

Określ stan interfejsu użytkownika, który włącza i wyłącza poszczególne wywołania zwrotne.

Stan interfejsu użytkownika to właściwość opisująca interfejs użytkownika. Zalecamy wykonanie tych ogólnych czynności.

  1. Określ stan interfejsu użytkownika, który włącza i wyłącza poszczególne połączenia zwrotne.

  2. Określ ten stan za pomocą obserwowalnego typu danych, takiego jak StateFlow lub Stan tworzenia, i włącz lub wyłącz wywołanie zależnie od stanu.

Jeśli Twoja aplikacja wcześniej powiązała logikę cofnięcia z oświadczeniami warunkowymi, może to oznaczać, że reagujesz na zdarzenie cofnięcia po tym, jak już ono nastąpiło. Unikaj tego w przypadku nowych wywołań zwrotnych. Jeśli to możliwe, przenieś funkcję z powrotem poza instrukcję warunkową, a zamiast tego powiązaj ją z obserwowalnym typem uchwytu danych.

Używanie wywołań zwrotnych systemu do obsługi logiki interfejsu użytkownika

Logika interfejsu określa sposób wyświetlania interfejsu. Używaj wywołań zwrotnych systemu do wykonywania logiki interfejsu, np. wyświetlania wyskakującego okienka lub animacji.

Jeśli Twoja aplikacja umożliwia wywołanie systemu wstecz, animacje przewidujące nie są uruchamiane i musisz obsłużyć zdarzenie wstecz. Nie twórz funkcji wywołujących zwrotnych tylko po to, aby wykonać logikę bez interfejsu użytkownika.

Jeśli na przykład przechwytujesz zdarzenia back tylko po to, aby je rejestrować, zamiast tego rejestruj je w cyklu życia Activity lub Fragment.

  • W przypadku przypadków aktywności do aktywności lub fragmentu do aktywności odnotuj, czy isFinishing w onDestroy jest true w cyklu życia aktywności.
  • W przypadku fragmentów względem siebie rejestruj, czy isRemoving w onDestroy jest prawdziwe w cyklu życia widoku fragmentu. Możesz też zalogować się w FragmentManager.OnBackStackChangedListener, używając metod onBackStackChangeStarted lub onBackStackChangeCommitted.

W przypadku Compose loguj w wywołaniu zwrotnym onCleared() funkcji ViewModel powiązanej z miejscem docelowym Compose. To najlepszy sygnał o tym, kiedy miejsce docelowe w komponowaniu jest usuwane ze stosu i niszczone.

Tworzenie wywołań o jednym zadaniu

Do rozsyłacza możesz dodać wiele wywołań zwrotnych. Odwołania są dodawane do stosu, w którym ostatnie dodane włączone odwołanie obsługuje następny gest wstecz. Każdy gest wstecz ma przypisane jedno odwołanie.

Łatwiej jest zarządzać stanem włączenia wywołania zwrotnego, jeśli ma ono tylko jedną odpowiedzialność. Przykład:

kolejność wywołań zwrotnych w stosie.
Rysunek 2. Diagram stosu wywołania zwrotnego

Na rysunku 2 widać, jak można mieć w grupie wiele wywołań zwrotnych, z których każde odpowiada za coś innego. Funkcja wywołania zwrotnego jest wykonywana tylko wtedy, gdy funkcje wywołania zwrotnego znajdujące się nad nią w zbiorze są wyłączone. W tym przykładzie wywołanie „Czy na pewno…” jest włączone, gdy użytkownik wpisuje dane w formularzu, i wyłączone w innych przypadkach. Gdy użytkownik przesunie palcem w bok, aby zamknąć formularz, wywołanie zwrotne otworzy okno potwierdzenia.

Drugi wywołanie zwrotne może zawierać komponent Material, który obsługuje przewidywanie powrotów, przejście AndroidX za pomocą interfejsów API Progress lub inne niestandardowe wywołanie zwrotne.

childFragmentManager wywoływana jest, jeśli powyższe wywołania są wyłączone, a stół zagnieżdżony tego FragmentManager nie jest pusty. childFragmentManager jest dołączony do Fragmentu. W tym przykładzie wywołanie zwrotne wewnętrzne jest wyłączone.

Podobnie wywołanie wewnętrzne supportFragmentManager jest wykonywane, jeśli powyższe wywołania są wyłączone, a stos nie jest pusty. To zachowanie jest spójne, gdy do nawigacji używasz FragmentManager lub NavigationComponent, ponieważ NavigationComponent korzysta z FragmentManager. W tym przykładzie ta funkcja wywołania zwrotnego jest wykonywana, jeśli użytkownik nie wpisał tekstu w formularzu, co spowodowało wyłączenie funkcji wywołania zwrotnego „Czy na pewno…?”.

Na koniec super.onBackPressed() to wywołanie na poziomie systemu, które jest wykonywane, jeśli powyższe wywołania są wyłączone. Aby wywołać animacje systemowe, takie jak powrót do ekranu głównego, przełączanie między aktywnościami i zadaniami, wewnętrzny wywołujący supportFragmentManager musi być pusty, aby jego wewnętrzny wywołujący był wyłączony.

Testowanie animacji przewidywanego przejścia wstecz

Jeśli nadal używasz Androida 13 lub Androida 14, możesz przetestować animację powrotu do ekranu głównego, którą przedstawia rysunek 1.

Aby przetestować tę animację, wykonaj te czynności:

  1. Na urządzeniu wybierz Ustawienia > System > Opcje programisty.

  2. Wybierz Animacje przewidywanego przejścia wstecz.

  3. Uruchom zaktualizowaną aplikację i użyj gestu wstecz, aby zobaczyć, jak działa.