Aggiunta del supporto per il gesto Indietro predittivo

Figura 1. Simulazione del gesto Indietro predittivo su uno smartphone

Android 14 (livello API 34) aggiunge il supporto per ulteriori animazioni di sistema e API per creare animazioni personalizzate. Per ulteriori informazioni, vedi Aggiunta del supporto per animazioni Indietro predittive integrate e personalizzate.

Ad esempio, utilizzando un gesto Indietro puoi visualizzare un'anteprima animata del la schermata Home dietro l'app, come presentata nel modello nella figura 1. A partire da Android 13, puoi testa questa animazione di ritorno a casa attivando un'opzione sviluppatore (come descritto in questa pagina).

Il supporto del gesto Indietro predittivo richiede l'aggiornamento dell'app, utilizzando il compatibile con le versioni precedenti OnBackPressedCallback AppCompat 1.6.0-alpha05 (AndroidX) o versioni successive dell'API oppure tramite la nuova versione di OnBackInvokedCallback. tramite l'API Platform. La maggior parte delle app userà l'API AndroidX compatibile con le versioni precedenti.

Questo aggiornamento fornisce un percorso di migrazione per intercettare correttamente la navigazione a ritroso, che prevede la sostituzione delle intercettazioni arretrate di KeyEvent.KEYCODE_BACK ed eventuali classi con metodi onBackPressed come Activity e Dialog con le nuove API Indietro del sistema.

Nota: Android 13 non rende visibile il gesto Indietro predittivo agli utenti, ma ma fornisce una versione in anteprima della UI come opzione per sviluppatori test. Abbiamo in programma di rendere disponibile questa UI agli utenti in una versione futura di Android. Nel frattempo, ti consigliamo vivamente di aggiornare l'app per assicurarti di ottenere gli ultimi aggiornamenti.

Nota: KeyEvent.KEYCODE_BACK non è deprecato perché è supportato casi di KeyEvent.KEYCODE_BACK; Tuttavia, intercettando gli eventi arretrati KeyEvent.KEYCODE_BACK non è più supportato.

Codelab e video su 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 gesto Indietro predittivo utilizzando le API AndroidX Activity.

Puoi anche guardare il nostro video Google I/O, che presenta altri esempi di che implementa AndroidX e le API della piattaforma.

Aggiornare un'app che utilizza la navigazione a ritroso predefinita

L'aggiornamento dell'app per supportare questa funzionalità è semplice se l'app non supporta implementare un comportamento Indietro personalizzato (in altre parole, lascia la gestione al sistema). Attiva questa funzionalità come descritto in guida.

Se la tua app utilizza Frammenti o il componente di navigazione, esegui anche l'upgrade a Attività di AndroidX 1.6.0-alpha05 o superiore.

Aggiornare un'app che utilizza la navigazione a ritroso personalizzata

Se la tua app implementa un comportamento di ritorno personalizzato, sono disponibili percorsi di migrazione diversi a seconda che utilizzi AndroidX e di come gestisce la navigazione a ritroso.

La tua app utilizza AndroidX	In che modo l'app gestisce la navigazione a ritroso	Percorso di migrazione consigliato (link in questa pagina)
Sì	API AndroidX	Eseguire la migrazione di un'implementazione AndroidX esistente
	API delle piattaforme non supportate	Eseguire la migrazione alle API AndroidX di un'app AndroidX contenente API di navigazione a ritroso non supportate
No	API delle piattaforme non supportate, in grado di eseguire la migrazione	Eseguire la migrazione di un'app che utilizza API di navigazione posteriore non supportate alle API della piattaforma
	API delle piattaforme non supportate, ma impossibile eseguire la migrazione	Posticipa l'attivazione finché non diventerà una funzionalità obbligatoria

Importante: consigliamo vivamente di implementare la navigazione a ritroso predittivo il prima possibile. Altrimenti, gli utenti potrebbero riscontrare comportamenti imprevisti in un release futura di Android.

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

Questo caso d'uso è il più comune (e il più consigliato). Si applica ai nuovi oppure app esistenti che implementano la gestione della navigazione tramite gesti personalizzata con OnBackPressedDispatcher, come descritto in Fornisci una navigazione a ritroso personalizzata.

Se la tua app rientra in questa categoria, svolgi i passaggi che seguono per aggiungere il supporto del gesto Indietro predittivo:

1. Per assicurarti che le API che utilizzano già le API OnBackPressedDispatcher (come Frammenti e il componente di navigazione) funzionano perfettamente con gesto Indietro predittivo, aggiorna a 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 su 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 ai API di navigazione posteriore non supportate, dovrai eseguire la migrazione alle API AndroidX per supportare il nuovo comportamento.

Nota: consigliamo vivamente di utilizzare le librerie AndroidX. AndroidX automaticamente consente di attivare la navigazione a ritroso del sistema nell'app quando attivi la funzionalità. e offre anche molte altre funzionalità utili che aggiornano automaticamente le API a ogni release per risparmiare tempo e lavoro.

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

1. Esegui la migrazione della logica di gestione della schiena del sistema a quella di AndroidX OnBackPressedDispatcher con un'implementazione OnBackPressedCallback. Per indicazioni dettagliate, vedi Fornisci una navigazione a ritroso personalizzata.

2. Disattiva OnBackPressedCallback quando vuoi smettere di intercettare la parte posteriore gesto.

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

4. Assicurati di eseguire l'upgrade a 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"
   

5. Una volta eseguita correttamente la migrazione dell'app, attivare il gesto Indietro predittivo (come descritto nell'articolo questa pagina) per vedere l'animazione del sistema per il rientro a casa.

   Nota: OnBackPressedCallback viene sempre chiamato indipendentemente dal valore di android:enableOnBackInvokedCallback, In altre parole, la disattivazione l'animazione di sistema non influisce sulla logica di gestione della parte posteriore dell'app se utilizza OnBackPressedCallback.

Eseguire la migrazione alle API della piattaforma di un'app che utilizza API di navigazione posteriore non supportate

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

Nota: consigliamo vivamente di utilizzare le librerie AndroidX. AndroidX automaticamente consente di attivare la navigazione a ritroso del sistema nell'app quando attivi la funzionalità. e offre anche molte altre funzionalità utili che aggiornano automaticamente le API a ogni release per risparmiare tempo e lavoro.

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

1. Usa la nuova API OnBackInvokedCallback sui dispositivi con Android 13 o e di fare affidamento su API non supportate sui dispositivi con Android 12 o in basso.

2. Registra la tua logica di back-up personalizzata in OnBackInvokedCallback con onBackInvokedDispatcher. In questo modo l'attività corrente terminato e il callback ha la possibilità di reagire all'azione Indietro una volta l'utente completa la navigazione indietro del sistema.

3. Annulla la registrazione di OnBackInvokedCallback quando vuoi interrompere l'intercettazione gesto Indietro. In caso contrario, gli utenti potrebbero notare comportamenti indesiderati quando utilizzano un La navigazione a ritroso del sistema, ad esempio "bloccarsi" tra le visualizzazioni che forza l'uscita 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 a ritroso tramite OnBackPressed o KeyEvent.KEYCODE_BACK per Android 13 e versioni successive.

5. Una volta eseguita correttamente la migrazione dell'app, attivare il gesto Indietro predittivo (come descritto nell'articolo questa pagina) in modo che OnBackInvokedCallback abbia effetto.

Puoi registrare un OnBackInvokedCallback con PRIORITY_DEFAULT oppure PRIORITY_OVERLAY, che non è disponibile nell'AndroidX simile OnBackPressedCallback. La registrazione di una richiamata con PRIORITY_OVERLAY è utile in alcuni casi. Questo potrebbe essere applicabile quando esegui la migrazione da onKeyPreIme() e il callback deve ricevere il gesto Indietro di un IME aperto. Gli IME registrano i callback con PRIORITY_DEFAULT all'apertura. Registra la richiamata con PRIORITY_OVERLAY per assicurarti OnBackInvokedDispatcher invia il gesto Indietro al callback dell'IME aperto.

Attiva il gesto Indietro predittivo

Una volta stabilito come aggiornare l'app in base al tuo caso, attiva supportando il gesto Indietro predittivo.

Per l'attivazione, in AndroidManifest.xml, nel tag <application> imposta il valore android:enableOnBackInvokedCallback per true.

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

Se non specifichi un valore, il valore predefinito è false e:

• Disattiva l'animazione di sistema dei gesti Indietro predittivi.
• Ignora OnBackInvokedCallback, ma OnBackPressedCallback chiamate continuare a lavorare.

Attivazione a livello di attività

A partire da Android 14, il flag android:enableOnBackInvokedCallback consente attivi le animazioni di sistema predittive a livello di attività. Questo comportamento rende più gestibile la migrazione di app multiattività di grandi dimensioni a gesti Indietro.

Il codice seguente mostra un esempio di utilizzo di enableOnBackInvokedCallback per attiva l'animazione del sistema per il rientro a casa 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 di android:enableOnBackInvokedCallback=true per ".SecondActivity" consente di attivare l'animazione del sistema interattività.

Quando utilizzi il comando android:enableOnBackInvokedCallback flag:

• L'impostazione di android:enableOnBackInvokedCallback=false disattiva la funzionalità Indietro predittiva le animazioni in corrispondenza dell'attività o a livello di app, a seconda di dove hai impostato il tag, e indica al sistema ignori le chiamate all'API della piattaforma OnBackInvokedCallback. Tuttavia, le chiamate al numero OnBackPressedCallback continuano a essere eseguite perché OnBackPressedCallback è compatibile con le versioni precedenti e chiama 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 eseguire l'override predefinito per attività impostando il flag a livello di attività, come mostrato in nell'esempio di codice precedente.

Best practice per il callback

Di seguito sono riportate le best practice per utilizzare i callback di sistema supportati: BackHandler (per Compose), OnBackPressedCallback o OnBackInvokedCallback.

Determina lo stato dell'interfaccia utente che abilita e disabilita ogni callback

Stato UI è una proprietà che descrive l'interfaccia utente. Ti consigliamo di seguire le best practice passaggi.

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

2. Definisci lo stato utilizzando un titolare dei dati osservabile tipo, ad esempio StateFlow o Scrivi lo stato e attiva o disattiva il callback quando lo stato cambia.

Se in precedenza l'app associava la logica di nuovo alle istruzioni condizionali, Ciò potrebbe significare che stai reagendo all'evento "back" dopo che è stato già verificato: un pattern che dovresti evitare con i callback più recenti. Se possibile, sposta il callback al di fuori dell'istruzione condizionale e associare il callback a un tipo di titolare dei dati osservabile.

Usa i callback del sistema per la logica UI

Logica UI indica come visualizzare la UI. Utilizza i callback del sistema per eseguire la logica dell'interfaccia utente, ad esempio mostrare un popup o eseguire un'animazione.

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

Ad esempio, se stai intercettando gli eventi solo per registrare, registra all'interno della Attività o Ciclo di vita di un frammento.

• Per i casi da attività ad attività o da frammento ad attività, registra se isFinishing in onDestroy è true nel ciclo di vita dell'attività.
• Per i casi da frammento a frammento, registra se isRemoving in onDestroy è true all'interno del ciclo di vita della vista Framment; oppure accedi utilizzando onBackStackChangeStarted o onBackStackChangeCommitted in FragmentManager.OnBackStackChangedListener.

Per la richiesta Compose, accedi al callback onCleared() di una ViewModel associate alla destinazione Compose. Questo è il segnale migliore per sapere quando una destinazione di composizione è stata rimossa dallo stack precedente ed eliminata.

Crea callback di responsabilità singola

Questo è possibile perché puoi aggiungere più callback al supervisore. I callback vengono aggiunti a uno stack in cui è stato aggiunto l'ultimo callback abilitato gestisce il gesto Indietro successivo con un callback per ogni gesto Indietro.

Testa l'animazione del gesto Indietro predittivo

Attenzione: questo componente di animazione della funzionalità del gesto Indietro predittivo non sarà disponibile fino alla release finale di Android 13. Vedi Spostamenti, traguardi e aggiornamenti per ulteriori dettagli.

A partire dalla release finale di Android 13, dovresti essere in grado di attivare una opzione sviluppatore per testare l'animazione per il rientro a casa mostrata nella Figura 1.

Per testare questa animazione, procedi nel seguente modo:

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

2. Seleziona Animazioni predittive per il retro.

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