Aggiunta del supporto per il gesto Indietro predittivo

Indietro predittivo, una funzionalità di navigazione tramite gesti, consente agli utenti di visualizzare l'anteprima dello scorrimento indietro.

Ad esempio, l'utilizzo di un gesto Indietro può mostrare un'anteprima animata della schermata Home dietro l'app, come mostrato nel mockup in Figura 1.

A partire da Android 15, l'opzione sviluppatore per le animazioni Indietro predittive non è più disponibile. Le animazioni di sistema, come il ritorno alla schermata Home, il passaggio da un'attività all'altra e il passaggio da un'attività all'altra, ora vengono visualizzate per le app che hanno attivato il gesto Indietro predittivo, in toto o a livello di attività.

Puoi testare questa animazione di ritorno alla home page (come descritto nella sezione successiva di questa pagina).

Per supportare il gesto di ritorno predittivo è necessario aggiornare l'app utilizzando l'API OnBackPressedCallback AppCompat 1.6.0-alpha05 (AndroidX) o versioni successive compatibili con le versioni precedenti o la nuova API di piattaforma OnBackInvokedCallback. La maggior parte delle app utilizza l'API AndroidX compatibile con le versioni precedenti.

Questo aggiornamento fornisce un percorso di migrazione per intercettare correttamente la navigazione a ritroso, il che comporta la sostituzione delle intercettazioni a ritroso di KeyEvent.KEYCODE_BACK e di qualsiasi classe con metodi onBackPressed, come Activity e Dialog, con le nuove API Indietro del sistema.

Video di codelab e Google I/O

Oltre a utilizzare la documentazione in questa pagina, prova il nostro codelab. Fornisce un'implementazione comune di un componente WebView che gestisce il gesto Indietro predittivo utilizzando le API AndroidX Activity.

Puoi anche guardare il nostro video della conferenza Google I/O, che illustra ulteriori esempi di implementazione delle API AndroidX e della piattaforma.

Aggiornare un'app che utilizza la navigazione a ritroso predefinita

Aggiornare l'app per supportare questa funzionalità è semplice se l'app non implementa alcun comportamento personalizzato per il pulsante Indietro (in altre parole, lascia la gestione del pulsante Indietro al sistema). Attiva questa funzionalità come descritto in questa guida.

Se la tua app utilizza Frammenti o il componente di navigazione, esegui anche l'upgrade ad AndroidX Activity 1.6.0-alpha05 o versioni successive.

Aggiornare un'app che utilizza la navigazione a ritroso personalizzata

Se la tua app implementa un comportamento personalizzato per il pulsante Indietro, esistono diversi percorsi di migrazione, a seconda che utilizzi AndroidX e di come gestisce la navigazione a ritroso.

Eseguire la migrazione di un'implementazione di navigazione a ritroso di AndroidX

Questo caso d'uso è il più comune (e il più consigliato). Si applica alle app nuove o esistenti che implementano la gestione della navigazione tramite gesti personalizzata con OnBackPressedDispatcher, come descritto in Fornire una navigazione indietro personalizzata.

Se la tua app rientra in questa categoria, segui questi passaggi per aggiungere il supporto per il gesto di ritorno predittivo:

1. Per assicurarti che le API che utilizzano già le API OnBackPressedDispatcher (come Frammenti e il componente di navigazione) funzionino perfettamente con il gesto Indietro predittivo, esegui l'upgrade all'Attività di AndroidX 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. Attiva il gesto Indietro predittivo, come descritto in questa pagina.

Esegui la migrazione di un'app AndroidX che contiene API di navigazione a ritroso non supportate alle API AndroidX

Se la tua app utilizza librerie AndroidX, ma implementa o fa riferimento ad API di navigazione a ritroso non supportate, dovrai eseguire la migrazione all'utilizzo delle API AndroidX per supportare il nuovo comportamento.

Per eseguire la migrazione delle API non supportate alle API AndroidX:

1. Esegui la migrazione della logica di gestione del pulsante Indietro del sistema a OnBackPressedDispatcher di AndroidX con un'implementazione di OnBackPressedCallback. Per indicazioni dettagliate, consulta Fornire la navigazione a ritroso personalizzata.

2. Disattiva OnBackPressedCallback quando vuoi interrompere l'intercettazione del gesto Indietro.

3. Interrompi l'intercettazione degli eventi di ritorno tramite OnBackPressed o KeyEvent.KEYCODE_BACK.

4. Assicurati di eseguire l'upgrade a 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. Dopo aver eseguito correttamente la migrazione dell'app, attiva il gesto di ritorno predittivo (come descritto su questa pagina) per vedere l'animazione di sistema di ritorno alla home page.

Esegui la migrazione di un'app che utilizza API di navigazione a ritroso non supportate alle API di piattaforma

Se la tua app non può utilizzare le librerie AndroidX e, al contrario, implementa o fa riferimento alla navigazione a ritroso personalizzata utilizzando le API non supportate, devi eseguire la migrazione all'API di piattaforma OnBackInvokedCallback.

Completa i seguenti passaggi per eseguire la migrazione delle API non supportate all'API della piattaforma:

1. Utilizza la nuova API OnBackInvokedCallback sui dispositivi con Android 13 o versioni successive e utilizza le API non supportate sui dispositivi con Android 12 o versioni precedenti.

2. Registra la logica di ritorno personalizzata in OnBackInvokedCallback con onBackInvokedDispatcher. In questo modo, l'attività corrente non viene completata e il callback ha la possibilità di reagire all'azione Indietro una volta che l'utente ha completato la navigazione Indietro del sistema.

3. Annulla la registrazione di OnBackInvokedCallback quando vuoi interrompere l'intercettazione del gesto Indietro. In caso contrario, gli utenti potrebbero notare comportamenti indesiderati quando utilizzano il pulsante Indietro del sistema, ad esempio "bloccarsi" tra le visualizzazioni e dover forzare l'uscita forzata dall'app.

   Ecco un esempio di come eseguire la migrazione della logica da 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. Interrompi l'intercettazione degli eventi Indietro tramite OnBackPressed o KeyEvent.KEYCODE_BACK per Android 13 e versioni successive.

5. Dopo aver eseguito la migrazione dell'app, attiva il gesto di ritorno predittivo (come descritto su questa pagina) in modo che OnBackInvokedCallback venga applicato.

Puoi registrare un OnBackInvokedCallback con PRIORITY_DEFAULT o PRIORITY_OVERLAY, che non è disponibile nell'analogo AndroidX OnBackPressedCallback. In alcuni casi, la registrazione di un callback con PRIORITY_OVERLAY è utile.

Questo vale quando esegui la migrazione da onKeyPreIme() e il tuo callback deve ricevere il gesto Indietro anziché un IME aperto. Gli IME registrano i callback con PRIORITY_DEFAULT quando vengono aperti. Registra il tuo callback con PRIORITY_OVERLAY per assicurarti che OnBackInvokedDispatcher invii il gesto Indietro al tuo callback anziché all'IME aperto.

Attivare il gesto Indietro predittivo

Una volta stabilito come aggiornare l'app in base alla tua richiesta, attiva il supporto del gesto di ritorno predittivo.

Per attivare la funzionalità, in AndroidManifest.xml, nel tag <application>, imposta il android:enableOnBackInvokedCallback flag su true.

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

Se non specifichi un valore, il valore predefinito è false e viene eseguito quanto segue:

• Disattiva l'animazione di sistema dei gesti Indietro predittivi.
• Ignora OnBackInvokedCallback, ma le chiamate OnBackPressedCallback continuano a funzionare.

Attivare la funzionalità a livello di attività

A partire da Android 14, il flag android:enableOnBackInvokedCallback consente di attivare le animazioni di sistema predittive a livello di attività. Questo comportamento semplifica la migrazione di app multi-attività di grandi dimensioni ai gesti di scorrimento prevedibili. Con Android 15, il pulsante Indietro predittivo non è più nascosto dietro l'opzione per gli sviluppatori. Le app possono attivare il ritorno predittivo completamente o a livello di attività.

Il seguente codice mostra un esempio di utilizzo di enableOnBackInvokedCallback per attivare l'animazione di sistema di ritorno alla home page da MainActivity:

<manifest ...>
    <application . . .

        android:enableOnBackInvokedCallback="false">

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

Nell'esempio precedente, l'impostazione android:enableOnBackInvokedCallback=true per ".SecondActivity" attiva l'animazione di sistema tra attività.

Tieni presente le seguenti considerazioni quando utilizzi il android:enableOnBackInvokedCallback flag:

• L'impostazione android:enableOnBackInvokedCallback=false disattiva le animazioni di scambio di app predittive a livello di attività o di app, a seconda di dove viene impostato il tag, e indica al sistema di ignorare le chiamate all'API di piattaforma OnBackInvokedCallback. Tuttavia, le chiamate a OnBackPressedCallback continuano a essere eseguite perché OnBackPressedCallback è compatibile con le versioni precedenti e chiama l'API onBackPressed, che non è supportata prima di Android 13.
• L'impostazione del flag enableOnBackInvokedCallback a livello di app stabilisce il valore predefinito per tutte le attività nell'app. Puoi sostituire il valore predefinito per attività impostando il flag a livello di attività, come mostrato nell'esempio di codice precedente.

Best practice per i callback

Di seguito sono riportate le best practice per l'utilizzo dei callback di sistema supportati:BackHandler (per Componi), OnBackPressedCallback o OnBackInvokedCallback.

Determina lo stato dell'interfaccia utente che attiva e disattiva ogni callback

Lo stato dell'interfaccia utente è una proprietà che descrive l'interfaccia utente. Ti consigliamo di seguire questi passaggi generali.

1. Determina lo stato dell'interfaccia utente che attiva e disattiva ogni callback.

2. Definisci questo stato utilizzando un tipo di contenitore di dati osservabili, ad esempio StateFlow o Compose State, e attiva o disattiva il callback man mano che lo stato cambia.

Se in precedenza la tua app associava la logica di ritorno a istruzioni condizionali, potrebbe significare che stai reagendo all'evento di ritorno dopo che è già avvenuto. Evita questo pattern con i callback più recenti. Se possibile, sposta il callback al di fuori dell'istruzione condizionale e associa invece il callback a un tipo di titolare dei dati osservabile.

Usa i callback del sistema per la logica UI

La logica dell'interfaccia utente prescrive come visualizzare l'interfaccia utente. Utilizza i callback del sistema per eseguire la logica dell'interfaccia utente, ad esempio per visualizzare un popup o eseguire un'animazione.

Se la tua app attiva un callback Indietro di sistema, le animazioni predittive non vengono eseguite e devi gestire l'evento Indietro. Non creare callback solo per eseguire logica non UI.

Ad esempio, se intercetti gli eventi di ritorno solo per registrarli, registrali invece nel ciclo di vita dell'attività o del frammento.

• Per i casi da attività ad attività o da frammento ad attività, registra se isFinishing in onDestroy è true durante il ciclo di vita dell'attività.
• Per i casi da frammento a frammento, registra se isRemoving in onDestroy è vero nel ciclo di vita della visualizzazione del frammento. In alternativa, accedi utilizzando i metodi onBackStackChangeStarted o onBackStackChangeCommitted in FragmentManager.OnBackStackChangedListener.

Per la richiesta Componi, registra il log all'interno del callback onCleared() di un ViewModel associato alla destinazione Componi. Questo è il segnale migliore per sapere quando una destinazione di composizione viene rimossa e eliminata.

Creare callback con una sola responsabilità

Puoi aggiungere più callback al gestore. I callback vengono aggiunti a uno stack in cui l'ultimo callback attivato aggiunto gestisce il gesto Indietro successivo con un gesto Indietro per ogni gesto Indietro.

È più facile gestire lo stato abilitato di un callback se questo ha una sola responsabilità. Ad esempio:

La Figura 2 mostra come disporre di più callback nello stack, ognuno responsabile di un'unica cosa. Un callback viene eseguito solo se i callback precedenti nello stack sono disabilitati. In questo esempio, il callback "Sei sicuro…" viene attivato quando l'utente inserisce dati in un modulo e disattivato in caso contrario. Il callback apre una finestra di dialogo di conferma quando l'utente scorre verso il retro per uscire dal form.

L'altro callback può includere un componente Material che supporta il riavvolgimento predittivo, una transizione AndroidX che utilizza le API Progress o un altro callback personalizzato.

Il callback di childFragmentManager viene eseguito se i callback precedenti sono disabilitati e il back stack per questo FragmentManager non è vuoto, dove childFragmentManager è collegato all'interno di un Frammento. In questo esempio, questo callback interno è disattivato.

Allo stesso modo, il callback interno di supportFragmentManager viene eseguito se i callback precedenti sono disabilitati e il relativo stack non è vuoto. Questo comportamento è coerente quando utilizzi FragmentManager o NavigationComponent per la navigazione, poiché NavigationComponent si basa su FragmentManager. In questo esempio, questo callback viene eseguito se l'utente non ha inserito del testo nel modulo, causando la disattivazione del callback "Sei sicuro…".

Infine, super.onBackPressed()è il callback a livello di sistema, che viene eseguito di nuovo se i callback precedenti sono disattivati. Per attivare le animazioni di sistema come il ritorno alla home page, le animazioni tra attività e tra attività, la pila di supportFragmentManager deve essere vuota, quindi il suo callback interno deve essere disattivato.

Testare l'animazione del gesto Indietro predittivo

Se utilizzi ancora Android 13 o Android 14, puoi testare l'animazione di ritorno alla casa mostrata in Figura 1.

Per testare questa animazione, completa i seguenti passaggi:

1. Sul dispositivo, vai a Impostazioni > Sistema > Opzioni sviluppatore.

2. Seleziona Animazioni Indietro predittive.

3. Avvia l'app aggiornata e usa il gesto Indietro per vederla in azione.