Best practice di gestione della memoria

Questo documento presuppone che tu abbia seguito le indicazioni sulle best practice per le app per Android soggette a gestione della memoria, ad esempio Gestire la memoria delle app.

Introduzione

Una fuga di memoria è un tipo di perdita di risorse che si verifica quando un programma per computer non libera la memoria allocata che non è più necessaria. Una perdita può portare l'applicazione a richiedere all'OS più memoria di quella disponibile, causandone l'arresto anomalo. Una serie di pratiche improprie può causare perdite di memoria nelle app per Android, come il mancato smaltimento delle risorse o il mancato annullamento della registrazione dei listener quando non sono più necessari.

Questo documento fornisce alcune best practice per aiutarti a prevenire, rilevare e risolvere le perdite di memoria nel codice. Se hai provato i metodi in questo documento e sospetti una perdita di memoria nei nostri SDK, consulta Come segnalare problemi con gli SDK Google.

Prima di contattare l'assistenza

Prima di segnalare una perdita di memoria al team di assistenza di Google, segui le migliori pratiche e i passaggi di debug forniti in questo documento per assicurarti che l'errore non sia nel codice. Questi passaggi potrebbero risolvere il problema e, in caso contrario, generano le informazioni necessarie al team dell'Assistenza Google per aiutarti.

Previeni le fughe di memoria

Segui queste best practice per evitare alcune delle cause più comuni di perdite di memoria nel codice che utilizza gli SDK Google.

Best practice per le app per Android

Verifica di aver eseguito tutti i seguenti passaggi nella tua applicazione per Android:

1. Rilascia le risorse inutilizzate.
2. Annullare la registrazione degli ascoltatori quando non sono più necessari.
3. Annulla le attività quando non sono necessarie.
4. Inoltra i metodi del ciclo di vita per rilasciare le risorse.
5. Utilizzare le versioni più recenti degli SDK

Per informazioni specifiche su ciascuna di queste pratiche, consulta le sezioni seguenti.

Rilascia le risorse inutilizzate

Quando la tua app per Android utilizza una risorsa, assicurati di rilasciarla quando non è più necessaria. In caso contrario, la risorsa continuerà a occupare memoria anche al termine dell'utilizzo da parte dell'applicazione. Per saperne di più, consulta la sezione Il ciclo di vita dell'attività nella documentazione di Android.

Rilasciare riferimenti GoogleMap obsoleti nei GeoSDK

Un errore comune è che una mappa di Google può causare una perdita di memoria se memorizzata nella cache utilizzando NavigationView o MapView. Una mappa di Google Maps ha una relazione di 1 a 1 con la vista di navigazione o con la mappa da cui viene recuperata. Devi assicurarti che una mappa di Google Maps non sia memorizzata nella cache o che il riferimento venga rilasciato quando viene chiamato NavigationView#onDestroy o MapView#onDestroy. Se utilizzi NavigationSupportFragment, MapSupportFragment o il tuo frammento che racchiude queste visualizzazioni, il riferimento deve essere rilasciato in Fragment#onDestroyView.

class NavFragment : SupportNavigationFragment() {

  var googleMap: GoogleMap?

  override fun onCreateView(
    inflater: LayoutInflater,
    parent: ViewGroup?,
    savedInstanceState: Bundle?,
  ): View  {
    super.onCreateView(inflater,parent,savedInstanceState)
    getMapAsync{map -> googleMap = map}
  }

  override fun onDestroyView() {
    googleMap = null
  }
}

Annulla la registrazione dei listener quando non sono più necessari

Quando la tua app per Android registra un listener per un evento, ad esempio un clic su un pulsante o una modifica dello stato di una vista, assicurati di annullare la registrazione del listener quando l'applicazione non deve più monitorare l'evento. In caso contrario, i listener continueranno a occupare memoria anche dopo che l'applicazione li avrà utilizzati.

Ad esempio, supponiamo che la tua applicazione utilizzi l'SDK Navigation e chiami il seguente listener per rilevare gli eventi di arrivo: metodo addArrivalListener per rilevare gli eventi di arrivo, deve anche chiamare removeArrivalListener quando non è più necessario monitorare gli eventi di arrivo.

var arrivalListener: Navigator.ArrivalListener? = null

fun registerNavigationListeners() {
  arrivalListener =
    Navigator.ArrivalListener {
      ...
    }
  navigator.addArrivalListener(arrivalListener)
}

override fun onDestroy() {
  navView.onDestroy()
  if (arrivalListener != null) {
    navigator.removeArrivalListener(arrivalListener)
  }

  ...
  super.onDestroy()
}

Annulla le attività quando non sono necessarie

Quando un'app per Android avvia un'attività asincrona, ad esempio un download o una richiesta di rete, assicurati di annullarla al termine. Se l'attività non viene annullata, continua a essere eseguita in background anche dopo che l'app ha terminato l'esecuzione.

Per ulteriori dettagli sulle best practice, consulta Gestire la memoria dell'app nella documentazione di Android.

Inoltra i metodi del ciclo di vita per rilasciare risorse

Se la tua app utilizza l'SDK di navigazione o Maps, assicurati di rilasciare le risorse inoltrando i metodi del ciclo di vita (mostrati in grassetto) a navView. Puoi eseguire questa operazione utilizzando NavigationView nell'SDK di navigazione oppure MapView in Maps o nell'SDK di navigazione. Puoi anche utilizzare SupportNavigationFragment o SupportMapFragment anziché NavigationView e MapView, rispettivamente. I frammenti di supporto gestiscono inoltro dei metodi di ciclo di vita.

class NavViewActivity : AppCompatActivity() {

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    ...
    navView = ...
    navView.onCreate(savedInstanceState)
    ...
  }

  override fun onSaveInstanceState(savedInstanceState: Bundle) {
    super.onSaveInstanceState(savedInstanceState)
    navView.onSaveInstanceState(savedInstanceState)
  }

  override fun onTrimMemory(level: Int) {
    super.onTrimMemory(level)
    navView.onTrimMemory(level)
  }

  /* Same with
    override fun onStart()
    override fun onResume()
    override fun onPause()
    override fun onConfigurationChanged(...)
    override fun onStop()
    override fun onDestroy()
  */
}

Utilizza le versioni più recenti degli SDK

Gli SDK Google vengono aggiornati costantemente con nuove funzionalità, correzioni di bug e miglioramenti delle prestazioni. Mantieni aggiornati gli SDK nella tua app per ricevere queste correzioni.

Debug delle fughe di memoria

Se noti ancora perdite di memoria dopo aver implementato tutti i suggerimenti applicabili in precedenza in questo documento, segui questa procedura per eseguire il debug.

Prima di iniziare, devi conoscere la modalità di gestione della memoria da parte di Android. Per informazioni, leggi la panoramica della gestione della memoria di Android.

Per eseguire il debug delle perdite di memoria, segui questa procedura:

1. Ricrea il problema. Questo passaggio è essenziale per il debug.
2. Controlla se l'utilizzo della memoria è previsto. Verifica che l'aumento dell'utilizzo che sembra essere una perdita non sia in realtà la memoria richiesta per l'esecuzione dell'applicazione.
3. Esegui il debug a livello generale. Esistono diverse utilità che puoi usare per il debug. Tre diversi set di strumenti standard aiutano a eseguire il debug dei problemi di memoria in Android: Android Studio, Perfetto e le utilità a riga di comando Android Debug Bridge (adb).
4. Controlla la memoria utilizzata dall'app. recupera il dump dell'heap e il monitoraggio dell'allocazione e poi analizzalo.
5. Risolvi le perdite di memoria.

Le sezioni seguenti illustrano questi passaggi in dettaglio.

Passaggio 1: ricrea il problema

Se non riesci a ricreare il problema, valuta innanzitutto gli scenari che potrebbero causare la perdita di memoria. Se sai che il problema è stato ricreato, potresti andare subito al dump dell'heap. Tuttavia, se ricevi solo un dump dell'heap all'avvio dell'app o in un altro momento casuale, è possibile che non siano state attivate le condizioni per attivare una perdita. Prova a esaminare vari scenari quando provi a ricreare il problema:

• Quale insieme di funzionalità è attivato?

• Quale sequenza specifica di azioni dell'utente attiva la fuga di dati?

  • Hai provato più volte ad attivare questa sequenza?

• Quali stati del ciclo di vita ha attraversato l'app?

  • Hai provato più iterazioni in stati del ciclo di vita diversi?

Assicurati di poter ricreare il problema nell'ultima versione degli SDK. Il problema di una versione precedente potrebbe essere già stato risolto.

Passaggio 2: controlla se l'utilizzo della memoria per l'app è previsto

Ogni funzionalità richiede memoria aggiuntiva. Quando esegui il debug di diversi scenari, valuta se si tratta di un utilizzo previsto o meno o se si tratta effettivamente di una fuga di memoria. Ad esempio, per diverse funzionalità o attività utente, considera le seguenti possibilità:

• Probabile perdita: l'attivazione dello scenario tramite più iterazioni comporta un aumento dell'utilizzo della memoria nel tempo.

• Utilizzo della memoria previsto: la memoria viene recuperata dopo l'arresto dello scenario.

• Possibile utilizzo previsto della memoria: l'utilizzo della memoria aumenta per un determinato periodo di tempo e poi si riduce. Ciò potrebbe essere dovuto a una cache limitata o a un altro utilizzo previsto della memoria.

Se il comportamento dell'app è probabilmente l'utilizzo della memoria previsto, il problema può essere risolto gestendo la memoria dell'app. Per assistenza, consulta Gestire la memoria dell'app.

Passaggio 3: esegui il debug a livello generale

Quando esegui il debug di una perdita di memoria, inizia a un livello generale e poi visualizza i dettagli una volta ristrette le possibilità. Utilizza uno di questi strumenti di debug di alto livello per analizzare innanzitutto se c'è una fuga di dati nel tempo:

• Profilo della memoria di Android Studio (consigliato)

• Contatori memoria Perfetto

• Utilità a riga di comando di Android Debug Bridge (adb)

• Monitoraggio dell'allocazione

Profiler di memoria di Android Studio

Questo strumento fornisce un istogramma visivo della memoria consumata. Dalla stessa interfaccia possono essere attivati anche i dump dell'heap e il monitoraggio dell'allocazione. Questo strumento è il suggerimento predefinito. Per ulteriori informazioni, consulta Android Studio Memory Profiler.

Contatori della memoria di Perfetto

Perfetto ti offre un controllo preciso sul monitoraggio di diverse metriche e presenta tutto in un singolo istogramma. Per ulteriori informazioni, consulta Contatori della memoria di Perfetto.

Utilità a riga di comando Android Debug Bridge (adb)

Gran parte di ciò che puoi monitorare con Perfetto è disponibile anche come adb utilità a riga di comando a cui puoi eseguire query direttamente. Due esempi importanti sono:

• Meminfo ti consente di visualizzare informazioni dettagliate sulla memoria in un determinato momento.

• Procstats fornisce alcune statistiche aggregate importanti nel tempo.

Una statistica fondamentale da esaminare qui è l'impronta in memoria fisica massima (maxRSS) richiesta dall'app nel tempo. Il valore MaxPSS potrebbe non essere così preciso. Per un modo per aumentare la precisione, consulta il flag adb shell dumpsys procstats --help –start-testing.

Monitoraggio dell'allocazione

Il monitoraggio dell'allocazione identifica l'analisi dello stack in cui è stata allocata la memoria e se non è stata liberata. Questo passaggio è particolarmente utile per rilevare perdite nel codice nativo. Poiché questo strumento identifica la traccia dello stack, può essere un ottimo modo per eseguire rapidamente il debug della causa principale o per capire come ricreare il problema. Per la procedura di utilizzo del monitoraggio dell'allocazione, consulta Eseguire il debug della memoria nel codice nativo con il monitoraggio dell'allocazione.

Passaggio 4: controlla l'utilizzo della memoria dell'app con un dump dell'heap

Un modo per rilevare una perdita di memoria è generare un dump dell'heap della tua app e poi controllarla per rilevare eventuali perdite. Un dump dell'heap è uno snapshot di tutti gli oggetti nella memoria di un'app. Può essere utilizzato per diagnosticare perdite di memoria e altri problemi relativi alla memoria.

Android Studio è in grado di rilevare perdite di memoria non correggibili dal GC. Quando acquisisci un dump dell'heap, Android Studio controlla se è presente un'attività o un frammento ancora raggiungibile, ma già distrutto.

1. Acquisisci un dump dell'heap.
2. Analizza il dump dell'heap per individuare le perdite di memoria.
3. Risolvi le perdite di memoria.

Per maggiori dettagli, consulta le sezioni seguenti.

Acquisisci un dump dell'heap

Per acquisire un dump dell'heap, puoi utilizzare Android Debug Bridge (adb) o lo strumento di analisi della memoria di Android Studio.

Utilizza adb per acquisire un dump dell'heap

Per acquisire un dump dell'heap utilizzando adb, segui questi passaggi:

1. Collega il dispositivo Android al computer.
2. Apri un prompt dei comandi e vai alla directory in cui si trovano gli strumenti ADB.

3. Per acquisire un dump dell'heap, esegui questo comando:

   adb shell am dumpheap my.app.name $PHONE_FILE_OUT

4. Per recuperare il dump dell'heap, esegui questo comando:

   adb pull $PHONE_FILE_OUT $LOCAL_FILE.

Utilizzare Android Studio per acquisire un dump dell'heap

Per acquisire un dump dell'heap utilizzando il Profiler di memoria di Android Studio, segui questi passaggi nella sezione Acquisire un heapdump di Android.

Analizza il dump dell'heap per trovare perdite di memoria

Dopo aver acquisito un dump dell'heap, puoi utilizzare il profiler di memoria di Android Studio per analizzarlo. Per farlo, segui questi passaggi:

1. Apri il progetto Android in Android Studio.

2. Seleziona Esegui e poi la configurazione Debug.

3. Apri la scheda Android Profiler.

4. Seleziona Memoria.

5. Seleziona Apri dump dell'heap e seleziona il file di dump dell'heap che hai generato. Il profiler di memoria mostra un grafico della memoria utilizzata dalla tua app.

6. Utilizza il grafico per analizzare il dump dell'heap:

   • Identifica gli oggetti che non vengono più utilizzati.

   • Identifica gli oggetti che utilizzano molta memoria.

   • Scopri quanta memoria utilizza ogni oggetto.

7. Utilizza queste informazioni per individuare l'origine della perdita di memoria e correggerla.

Passaggio 5: correggi le perdite di memoria

Una volta identificata la causa della perdita di memoria, puoi risolverla. La correzione di perdite di memoria nelle app Android consente di migliorare le prestazioni e la stabilità delle app. A seconda dello scenario, i dettagli variano. Tuttavia, i seguenti suggerimenti possono essere utili:

• Assicurati che la tua app allochi e dealhi la memoria come consigliato dall'argomento Android Gestire la memoria dell'app.

• Rimuovi risorse o codice inutilizzati dalla tua app. Per maggiori dettagli sulle app per Android, consulta Best practice per le app per Android.

Altri strumenti di debug

Al termine di questi passaggi, se non hai ancora trovato e corretto la perdita di memoria, prova questi strumenti:

• Esegui il debug della memoria nel codice nativo con il monitoraggio dell'allocazione.
• Identifica le fughe di informazioni con LeakCanary.

Memoria di debug nel codice nativo con monitoraggio dell'allocazione

Anche se non utilizzi direttamente il codice nativo, diverse librerie Android comuni lo fanno, inclusi gli SDK di Google. Se pensi che la perdita di memoria sia nel codice nativo, puoi utilizzare diversi strumenti per eseguirne il debug. Il monitoraggio dell'allocazione con Android Studio o heapprofd (compatibile anche con Perfetto) è un ottimo modo per identificare le potenziali cause di una perdita di memoria ed è spesso il modo più rapido per eseguire il debug.

Il monitoraggio dell'allocazione ha anche il vantaggio di consentirti di condividere i risultati senza includere informazioni sensibili che possono essere trovate in un heap.

Identificare le perdite con LeakCanary

LeakCanary è un potente strumento per identificare le perdite di memoria nelle app per Android. Per scoprire di più su come utilizzare LeakCanary nella tua app, visita LeakCanary.

Come segnalare problemi con gli SDK Google

Se hai provato i metodi in questo documento e sospetti una perdita di memoria nei nostri SDK, contatta l'assistenza clienti fornendo quante più informazioni possibili:

• Passaggi per ricreare la perdita di memoria. Se i passaggi richiedono una codifica complessa, potrebbe essere utile copiare il codice che replica il problema nella nostra app di esempio e fornire i passaggi aggiuntivi da seguire nell'interfaccia utente per attivare la perdita.

• Dump dell'heap acquisiti dalla tua app con il problema ricreato. Acquisisci dump heap in due momenti diversi che mostrano che l'utilizzo della memoria è aumentato in modo significativo.

• Se è prevista una perdita di memoria nativa, condividi l'output del monitoraggio dell'allocazione da heapprofd.

• Una segnalazione di bug eseguita dopo aver ricreato la condizione di perdita.

• Tracce dello stack di eventuali arresti anomali correlati alla memoria.

  Nota importante: in genere, le analisi dello stack non sono sufficienti per eseguire il debug di un problema di memoria, quindi assicurati di fornire anche una delle altre forme di informazioni.