Sprawdzone metody zarządzania pamięcią

W tym dokumencie zakładamy, że postępujesz zgodnie ze sprawdzonymi metodami dotyczącymi zarządzania pamięcią w aplikacjach na Androida, np. Zarządzanie pamięcią aplikacji.

Wprowadzenie

Wyciek pamięci to typ wycieku zasobów, który występuje, gdy program komputerowy nie zwolni przydzielonej pamięci, która nie jest już potrzebna. Wyciek pamięci może spowodować, że aplikacja żąda od systemu więcej pamięci, niż ma dostępnej, i w konsekwencji się zawiesza. W aplikacjach na Androida wiele niewłaściwych praktyk może powodować wycieki pamięci, np. nieprawidłowe usuwanie zasobów lub nierejestrowanie odsłuchiwania, gdy nie jest już potrzebne.

Ten dokument zawiera kilka sprawdzonych metod, które pomagają zapobiegać wyciekom pamięci w kodzie, wykrywać je i rozwiązywać. Jeśli wypróbowałeś metody opisane w tym dokumencie i podejrzewasz, że w pakietach SDK występuje wyciek pamięci, zapoznaj się z artykułem Jak zgłaszać problemy z pakietami Google SDK.

Zanim skontaktujesz się z zespołem pomocy

Zanim zgłosisz wyciek pamięci do zespołu pomocy Google, postępuj zgodnie ze wskazówkami dotyczącymi najlepszych praktyk i instrukcjami debugowania podanymi w tym dokumencie, aby upewnić się, że błąd nie występuje w Twoim kodzie. Te czynności mogą rozwiązać problem, a jeśli to nie zadziałają, wygenerują informacje potrzebne zespołowi pomocy Google.

Zapobieganie wyciekom pamięci

Postępuj zgodnie z tymi sprawdzonymi metodami, aby uniknąć niektórych najczęstszych przyczyn wycieków pamięci w kodzie, który korzysta z pakietów SDK Google.

Sprawdzone metody dotyczące aplikacji na Androida

Sprawdź, czy w aplikacji na Androida zostały wykonane wszystkie te czynności:

  1. Zwolnij nieużywane zasoby.
  2. Wyrejestruj słuchaczy, gdy nie są już potrzebni.
  3. Anuluj zadania, gdy nie są potrzebne.
  4. Wyślij metody cyklu życia, aby zwolnić zasoby
  5. Używaj najnowszych wersji pakietów SDK

Szczegółowe informacje o każdej z tych metod znajdziesz w następnych sekcjach.

Zwalnianie nieużywanych zasobów

Gdy aplikacja na Androida używa zasobu, pamiętaj, aby go zwolnić, gdy nie jest już potrzebny. Jeśli tego nie zrobisz, zasób będzie nadal zajmować pamięć nawet po zakończeniu pracy aplikacji. Więcej informacji znajdziesz w dokumentacji Androida na temat cyklu życia aktywności.

Uwolnienie nieaktualnych odwołań do GoogleMap w GeoSDK

Typowym błędem jest to, że GoogleMap może spowodować wyciek pamięci, jeśli jest przechowywany w pamięci podręcznej za pomocą NavigationView lub MapView. Mapa GoogleMap ma relację 1:1 z obiektem NavigationView lub MapView, z którego jest pobierana. Musisz zadbać o to, aby mapa Google nie była przechowywana w pamięci podręcznej, lub aby odwołanie zostało zwolnione, gdy wywołano metodę NavigationView#onDestroy lub MapView#onDestroy. Jeśli używasz fragmentu NavigationSupportFragment, MapSupportFragment lub własnego fragmentu otaczającego te widoki, musisz zwolnić odwołanie w 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
  }
}

odrejestrowanie słuchaczy, gdy nie są już potrzebne;

Gdy aplikacja na Androida zarejestruje słuchacza zdarzenia, np. kliknięcie przycisku lub zmianę stanu widoku, pamiętaj, aby zarejestrować słuchacza, gdy aplikacja nie będzie już musiała monitorować zdarzenia. Jeśli tego nie zrobisz, detektory będą nadal zajmować pamięć nawet po zakończeniu działania aplikacji.

Załóżmy na przykład, że Twoja aplikacja korzysta z pakietu Navigation SDK i wywołuje ten detektor w celu nasłuchiwania zdarzeń przyjazdu: addArrivalListener w celu nasłuchiwania zdarzeń przyjazdu, powinna także wywoływać metodę removeArrivalListener, gdy nie musi już monitorować zdarzeń przyjazdu.

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()
}

anulować zadania, gdy nie są już potrzebne.

Gdy aplikacja na Androida rozpocznie zadanie asynchroniczne, takie jak pobieranie lub żądanie sieciowe, pamiętaj, aby je anulować po jego zakończeniu. Jeśli zadanie nie zostanie anulowane, będzie działać w tle nawet po zakończeniu pracy przez aplikację.

Więcej informacji o sprawdzonych metodach znajdziesz w dokumentacji Androida dotyczących zarządzania pamięcią aplikacji.

Przesyłanie metod cyklu życia w celu zwalniania zasobów

Jeśli Twoja aplikacja korzysta z pakietu SDK Nawigacji lub Map, pamiętaj, aby zwolnić zasoby, przekazując metody cyklu życia (wyróżnione pogrubioną czcionką) do navView. Możesz to zrobić, używając funkcji NavigationView w Navigation SDK lub MapView w Mapach lub Navigation SDK. Zamiast operatorów NavigationViewMapView możesz też użyć odpowiednio operatorów SupportNavigationFragment lub SupportMapFragment. Fragmenty obsługujące obsługują przekazywanie metod cyklu życia.

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()
  */
}

Używaj najnowszych wersji pakietów SDK

Pakiety SDK Google są stale aktualizowane o nowe funkcje, poprawki błędów i ulepszenia wydajności. Aby otrzymywać te poprawki, aktualizuj pakiety SDK w swojej aplikacji.

Debugowanie wycieków pamięci

Jeśli po zastosowaniu wszystkich sugestii z początku tego dokumentu nadal występuje wyciek pamięci, wykonaj te czynności, aby przeprowadzić debugowanie.

Zanim zaczniesz, dowiedz się, jak Android zarządza pamięcią. Więcej informacji znajdziesz w artykule Omówienie zarządzania pamięcią na Androidzie.

Aby debugować wycieki pamięci:

  1. Odtwórz problem. Ten krok jest niezbędny do debugowania.
  2. Sprawdź, czy wykorzystanie pamięci jest oczekiwane. Sprawdź, czy zwiększone wykorzystanie, które wydaje się być wyciekiem, nie jest w istocie pamięcią wymaganą do działania aplikacji.
  3. Debugowanie na wysokim poziomie. Do debugowania możesz użyć kilku narzędzi. Do debugowania problemów z pamięcią w Androidzie służą 3 standardowe zestawy narzędzi: Android Studio, Perfeto i narzędzia wiersza poleceń Android Debug Bridge (adb).
  4. Sprawdź wykorzystanie pamięci przez aplikację. Pobierz zrzut stosu i śledzenie alokacji, a następnie przeanalizuj te dane.
  5. Naprawienie wycieków pamięci.

W następnych sekcjach omawiamy te czynności szczegółowo.

Krok 1. Odtwórz problem

Jeśli nie możesz odtworzyć problemu, najpierw rozważ scenariusze, które mogą doprowadzić do wycieku pamięci. Jeśli wiesz, że problem został odtworzony, przejdź od razu do zrzutu stosu. Jeśli jednak zrzut stosu zostanie utworzony tylko przy uruchamianiu aplikacji lub w innym losowym momencie, może to oznaczać, że nie zostały spełnione warunki powodujące wyciek pamięci. Aby odtworzyć problem, przetestuj różne scenariusze:

  • Jaki zestaw funkcji jest aktywowany?

  • Jaka konkretna sekwencja działań użytkownika powoduje wyciek?

    • Czy próbowałeś/próbowałaś wielokrotnie aktywować tę sekwencję?
  • Przez które stany cyklu życia została przeprowadzona aplikacja?

    • Czy przetestowałeś/przetestowałaś już różne stany cyklu życia?

Upewnij się, że możesz odtworzyć problem w najnowszej wersji pakietu SDK. Być może w poprzedniej wersji został już rozwiązany.

Krok 2. Sprawdź, czy zużycie pamięci przez aplikację jest prawidłowe

Każda funkcja wymaga dodatkowej pamięci. Podczas debugowania różnych scenariuszy zastanów się, czy jest to zgodne z oczekiwaniami, czy też jest to wyciek pamięci. Na przykład w przypadku różnych funkcji lub zadań użytkownika weź pod uwagę te możliwości:

  • Prawdopodobnie wyciek: aktywacja scenariusza przez wiele iteracji powoduje wzrost wykorzystania pamięci w miarę upływu czasu.

  • Prawdopodobny oczekiwany poziom wykorzystania pamięci: pamięć jest odzyskiwana po zatrzymaniu scenariusza.

  • Możliwe oczekiwane wykorzystanie pamięci: wykorzystanie pamięci wzrasta przez pewien czas, a potem maleje. Może to być spowodowane ograniczonym buforem lub innym oczekiwanym wykorzystaniem pamięci.

Jeśli działanie aplikacji jest najprawdopodobniej oczekiwane przy wykorzystaniu pamięci, problem można rozwiązać, zarządzając pamięcią aplikacji. Więcej informacji znajdziesz w artykule Zarządzanie pamięcią aplikacji.

Krok 3. Debugowanie na wysokim poziomie

Podczas debugowania wycieku pamięci zacznij od ogólnego poziomu, a potem przejdź do bardziej szczegółowego poziomu, gdy już zawęzisz zakres możliwości. Aby sprawdzić, czy występuje wyciek danych, użyj jednego z tych ogólnych narzędzi debugowania:

Narzędzie Memory Profiler w Android Studio

To narzędzie wyświetla histogram zużytej pamięci. W tym samym interfejsie możesz też wywołać zrzuty stosu i śledzenie alokacji. To narzędzie jest zalecane domyślnie. Więcej informacji znajdziesz w profilu pamięci w Android Studio.

Liczniki pamięci w Perfetto

Raport Perfetto zapewnia precyzyjną kontrolę nad śledzeniem kilku rodzajów danych i przedstawia je wszystkie na jednym histogramie. Więcej informacji znajdziesz w artykule o licznikach pamięci Perfetto.

Interfejs użytkownika Perfetto

Narzędzia wiersza poleceń Android Debug Bridge (adb)

Wiele z tych informacji możesz śledzić za pomocą narzędzia adb wiersza poleceń, do którego możesz bezpośrednio kierować zapytania. Oto kilka ważnych przykładów:

  • Meminfo pozwala wyświetlić szczegółowe informacje o pamięci w określonym momencie.

  • Procstats zawiera ważne zsumowane statystyki na przestrzeni czasu.

Kluczową statystyką, na którą należy tu zwrócić uwagę, jest maksymalny rozmiar fizycznej pamięci (maxRSS), którego aplikacja wymaga z upływem czasu. Maksymalna wartość mocy sygnału (MaxPS) może być mniej dokładna. Sposób zwiększenia dokładności znajdziesz w sekcji dotyczącej flagi adb shell dumpsys procstats --help –start-testing.

Śledzenie alokacji

Śledzenie przydziału identyfikuje ślad stosu, w którym przydzielona została pamięć, oraz czy nie została ona zwolniona. Ten krok jest szczególnie przydatny podczas śledzenia wycieków w natywnym kodzie. Ponieważ to narzędzie identyfikuje ślad stosu, może być ono przydatne do szybkiego debugowania głównej przyczyny problemu lub dowiedzieć się, jak go odtworzyć. Instrukcje korzystania ze śledzenia alokacji znajdziesz w artykule Debugowanie pamięci w kodzie natywnym ze śledzeniem alokacji.

Krok 4. Sprawdź wykorzystanie pamięci przez aplikację za pomocą zrzutu stosu

Jednym ze sposobów wykrycia wycieku pamięci jest pobranie zrzutu stosu aplikacji i sprawdzenie, czy nie ma w niej wycieku pamięci. Zrzut stosu to zrzut wszystkich obiektów w pamięci aplikacji. Można go używać do diagnozowania wycieków pamięci i innych problemów z pamięcią.

Android Studio może wykrywać wycieki pamięci, których nie można naprawić za pomocą GC. Gdy tworzysz zrzut stosu, Android Studio sprawdza, czy istnieje aktywność lub fragment, do których można jeszcze dotrzeć, ale które zostały już usunięte.

  1. Zapisz zrzut stosu.
  2. Przeanalizuj zrzut stosu, aby znaleźć wycieki pamięci.
  3. Napraw wycieki pamięci

Szczegółowe informacje znajdziesz w kolejnych sekcjach.

Wykonywanie zrzutu stosu

Aby wykonać zrzut stosu, możesz użyć narzędzia Android Debug Bridge (adb) lub narzędzia do profilowania pamięci w Android Studio.

Używanie narzędzia adb do przechwytywania zrzutu stosu

Aby wykonać zrzut stosu za pomocą adb, wykonaj te czynności:

  1. Podłącz urządzenie z Androidem do komputera.
  2. Otwórz wiersz polecenia i otwórz katalog, w którym znajdują się narzędzia adb.
  3. Aby uzyskać zrzut stosu, uruchom to polecenie:

    adb shell am dumpheap my.app.name $PHONE_FILE_OUT

  4. Aby pobrać zrzut stosu, uruchom to polecenie:

    adb pull $PHONE_FILE_OUT $LOCAL_FILE.

Użyj Android Studio, aby zrobić zrzut stosu

Aby zrobić zrzut stosu za pomocą narzędzia Android Studio Memory Profiler, wykonaj czynności opisane w sekcji Przechwytywanie zrzutu stosu w Androidzie.

Przeanalizuj zrzut stosu, aby znaleźć wycieki pamięci

Po przechwyceniu zrzutu stosu możesz go przeanalizować za pomocą narzędzia Android Studio Memory Profiler. W tym celu wykonaj następujące czynności:

  1. Otwórz projekt Androida w Android Studio.

  2. Kliknij Uruchom, a potem wybierz konfigurację Debugowanie.

  3. Otwórz kartę Profilator Androida.

  4. Wybierz Pamięć.

  5. Kliknij Otwórz zrzut stosu i wybierz wygenerowany plik zrzutu stosu. Profilator pamięci wyświetla wykres wykorzystania pamięci przez aplikację.

  6. Aby przeanalizować zrzut stosu, użyj wykresu:

    • identyfikować obiekty, których już nie używasz;

    • Identyfikowanie obiektów, które wykorzystują dużo pamięci.

    • Sprawdź, ile pamięci używa każdy obiekt.

  7. Użyj tych informacji, aby zawęzić lub znaleźć źródło wycieku pamięci i je naprawić.

Krok 5. Napraw wycieki pamięci

Gdy poznasz źródło wycieku pamięci, możesz rozwiązać ten problem. Naprawy wycieków pamięci w aplikacjach na Androida pomagają poprawić wydajność i stabilność aplikacji. Szczegóły zależą od scenariusza. Pomogą jednak następujące sugestie:

Inne narzędzia do debugowania

Jeśli po wykonaniu tych czynności nadal nie udało Ci się znaleźć i usunąć wycieku pamięci, wypróbuj te narzędzia:

Debugowanie pamięci w kodzie natywnym z wykorzystaniem śledzenia alokacji

Nawet jeśli nie używasz bezpośrednio kodu natywnego, wiele popularnych bibliotek na Androida, w tym pakiety SDK Google, korzysta z niego. Jeśli uważasz, że wyciek pamięci występuje w kodzie natywnym, możesz użyć kilku narzędzi do debugowania. Śledzenie alokacji za pomocą Android Studio lub heapprofd (również zgodnego z Perfetto) to świetny sposób na identyfikowanie potencjalnych przyczyn wycieku pamięci i często najszybszy sposób debugowania.

Śledzenie alokacji ma też tę zaletę, że umożliwia udostępnianie wyników bez uwzględniania informacji poufnych, które można znaleźć w stosie.

Identyfikuj wycieki za pomocą aplikacji LeakCanary

LeakCanary to zaawansowane narzędzie do identyfikowania wycieków pamięci w aplikacjach na Androida. Aby dowiedzieć się więcej o tym, jak używać LeakCanary w swojej aplikacji, wejdź na stronę LeakCanary.

Jak zgłaszać problemy z pakietami SDK Google

Jeśli po wypróbowaniu metod opisanych w tym dokumencie podejrzewasz, że w naszych pakietach SDK występuje wyciek pamięci, skontaktuj się z obsługą klienta i podaj jak najwięcej z tych informacji:

  • Etapy odtwarzania wycieku pamięci. Jeśli czynności wymagają skomplikowanego kodowania, skopiuj kod, który odtwarza problem w naszej przykładowej aplikacji, i podaj dodatkowe czynności, które należy wykonać w interfejsie, aby wywołać wyciek.

  • zrzuty stosu z aplikacji z odtworzonym problemem. Utwórz zrzuty stosu w 2 różnych momentach, które pokazują, że wykorzystanie pamięci znacznie wzrosło.

  • Jeśli spodziewasz się wycieku pamięci natywnych funkcji, udostępnij dane wyjściowe śledzenia alokacji z heapprofd.

  • Raport o błędzie utworzony po odtworzeniu stanu wycieku.

  • zrzuty stosu dotyczące awarii związanych z pamięcią.

    Ważna uwaga: zrzuty stosu zwykle nie są wystarczające do debugowania problemu z pamięcią, więc pamiętaj, by podać też jedną z pozostałych form informacji.