Intelligentere Beibehaltungsregeln: Wie Bibliotheksanbieter die DEX-Codeoptimierung auf App-Ebene ermöglichen können
Lesezeit: 6 Minuten
Als Entwickler von Android-Apps und -Bibliotheken haben wir alle dasselbe Ziel: leistungsstarke Apps, die eine reibungslose Nutzererfahrung bieten. Ein wichtiger Teil davon ist R8, der App-Optimierer von Android. R8 verbessert die App-Leistung, indem nicht verwendeter Code entfernt und der Rest optimiert und verschleiert wird.
Google Play hat vor Kurzem neue Grenzwerte für die DEX-Codeoptimierung für Apps und Spiele angekündigt. Diese helfen, die Startzeiten zu verbessern, den Speicherbedarf zu reduzieren und die Nutzerfreundlichkeit von Apps mit übermäßigem Speicherbedarf zu verbessern. Diese Grenzwerte gelten zwar für Apps und Spiele, aber die Einhaltung ist eine gemeinsame Verantwortung im gesamten Ökosystem. R8 kann eine App nur innerhalb der vorgegebenen Parameter optimieren. Dazu gehören auch die Keep-Regeln, die von den Bibliotheken gebündelt werden, von denen die App abhängt.
Der R8 Configuration Analyzer ist ein hervorragendes Tool, um die App-Optimierung, die Verkleinerung und die Verschleierung zu bewerten, die im Mittelpunkt der technischen Anforderungen von Google Play stehen. Zusätzlich zu diesen Prozentsätzen zeigt der R8 Configuration Analyzer auch ineffiziente Keep-Regeln an, die nicht nur aus Apps stammen, sondern auch aus Consumer-Keep-Regeln, die in Bibliotheken gebündelt sind, von denen Apps abhängen.
In diesem Leitfaden wird beschrieben, wie Sie einige der häufigsten Probleme beheben können, mit denen Bibliotheksanbieter konfrontiert sind, und wie Sie präzise, leistungsstarke Regeln bereitstellen, damit Ihre Kunden die technischen Anforderungen von Google Play erfüllen können.
Was sind Aufbewahrungsregeln für Verbraucher?
Consumer-Keep-Regeln sind Anweisungen, die in einer Android- oder JAR-Bibliothek enthalten sind und R8 mitteilen, welche Teile des Bibliothekscodes während der Kompilierung auf App-Ebene nicht optimiert werden dürfen. Im Gegensatz zu Standard-Keep-Regeln, die von der App oder Bibliothek geschrieben werden, die für die Minimierung von Artefakten verwendet wird, sind Consumer-Keep-Regeln in Bibliotheken eingebettet. Sie wirken sich darauf aus, wie die Bibliothek während der Optimierung der gesamten App minimiert wird. So wird sichergestellt, dass interne Reflexionsziele und native Schnittstellen intakt bleiben, ohne dass der App-Entwickler sie manuell identifizieren muss.
Gezielte, eng gefasste Keep-Regeln für Nutzer sind eine wichtige Best Practice, von der sowohl die Bibliothek als auch die Apps profitieren, die sie verwenden. Zu weit gefasste Beibehaltungsregeln für Nutzer führen dazu, dass nicht verwendeter Code beibehalten wird, was sich auf die Optimierung und Leistung einer App auswirkt. Mit den Statistiken zur DEX-Codeoptimierung, die der Play Console hinzugefügt wurden, sehen App-Entwickler Messwerte, die die kombinierten Auswirkungen der Regeln sowohl der App als auch der integrierten Bibliotheken darstellen.
Stabilität und Leistung im Gleichgewicht
Anbieter von Bibliotheken haben oft gute Absichten, wenn sie allgemeine Aufbewahrungsregeln für Nutzer bereitstellen. Niemand möchte, dass sein SDK aufgrund einer Klassenentfernung während der Reflexion einen Absturz verursacht.
Paketweite oder anderweitig breit gefasste Keep-Regeln werden jedoch nicht als langfristige Lösung zur Vermeidung von Abstürzen empfohlen, da sie das Potenzial von R8 zur Optimierung der gesamten App stark einschränken. Hier sind einige empfohlene Strategien, mit denen Sie eng gefasste, leistungsstarke Regeln ohne Einbußen bei der Stabilität bereitstellen können:
1. Spezifische Regeln testen und einführen
Beachten Sie die folgenden Best Practices, um eng gefasste Regeln sicher zu veröffentlichen:
- In einer Beispiel-App testen: Die Anleitung für lokale Tests unter Optimierung testen gilt auch für Beispiel-Apps. Testen Sie nach dem Aktivieren von R8 die Critical User Journeys, um sicherzustellen, dass die Funktionen wie erwartet funktionieren.
- Führen Sie den R8 Configuration Analyzer für Ihre Beispiel-App aus, um zu sehen, was App-Entwickler bei der Prüfung ihrer R8-Konfiguration sehen. So können Sie die Auswirkungen Ihrer Beibehaltungsregeln auf nachgelagerte Anwendungen ganz einfach visualisieren.
- Verwenden Sie den Befehl „analyze“ der Android-Befehlszeile, um die Optimierung Ihrer AAR- oder JAR-Datei zu bewerten, einschließlich beibehaltener Methoden, Klassen und Felder. Sie können diese Zahlen über verschiedene Releases hinweg vergleichen, um Regressionen zu erkennen.
- In der Google Play SDK Console können Sie die Nutzung von Bibliotheksversionen und Abstürze im Blick behalten.
- Best Practices finden Sie im Leitfaden Optimierung für Bibliotheksautoren und in der R8-Dokumentation.
2. Reflektions- und JNI-Ziele ohne allgemeine Beibehaltungsregeln beibehalten
Wenn Sie eine Bibliothek mit allgemeinen oder paketweiten Beibehaltungsregeln bereitstellen, wirkt sich das nicht nur auf Ihr SDK aus. Entwickler müssen dann auch Code-Bloat akzeptieren, was die Startzeit der App verlangsamt und die Downloadgröße, die Speichernutzung und die ANR-Raten der App erhöht. Es ist auch möglich, dass leistungsorientierte Apps benutzerdefinierte Regeln schreiben, die die in Ihrer Bibliothek enthaltenen Regeln ersetzen. Dies hält diese Apps auch davon ab, zukünftige Bibliotheksupdates zu übernehmen, um das Risiko zu verringern.
Wenn Ihr SDK auf nativen Code abzielt, z. B. in Spielen oder Foto- und Video-Editoren, geben Sie Regeln für alle Klassen an, die JNI verwenden. Die meisten Spiele laufen auf Spiele-Engines wie Unity und Unreal, die das Spiel in nativen Code kompilieren. Der native Code des Spiels und Ihr Plug-in kommunizieren über JNI-Aufrufe mit dem Android-Framework.
Jetpack Keep-Annotationen, die sich jetzt in der Alphaversion befinden, können dazu beitragen, den Wartungsaufwand für die Reflexion zu reduzieren. Sie können die Reflexionsnutzung annotieren, um dann beim Erstellen Keep-Regeln zu generieren.
Codegenerierung statt Reflexion verwenden
Um Abstürze aufgrund von Reflexion zu vermeiden, empfehlen wir, Reflexion zu vermeiden und nach Möglichkeit codegen zu verwenden.
Durch die Laufzeitreflexion wird die Codenutzung während der Kompilierung vor R8 verborgen. Daher sind Beibehaltungsregeln erforderlich, um Abstürze zu vermeiden. Wenn Sie Codegen verwenden, wird der Code während des Build-Prozesses optimiert. So hat R8 die erforderliche Sichtbarkeit, um den Code mit minimalen Beibehaltungsregeln sicher zu optimieren. Typische Szenarien, in denen die Codegenerierung eine gute Wahl ist, sind Serialisierung und Deserialisierung sowie Dependency Injection (Hilt ist ein Beispiel für eine Bibliothek, die Codegenerierung verwendet).
Codegenerierung ist jedoch nicht für jedes Szenario die richtige Wahl. Für Muster wie optionale Abhängigkeiten ist die Reflexion weiterhin erforderlich. Wir empfehlen, die Reflexion mit engen Beibehaltungsregeln zu kombinieren, die nur erforderliche Einstiegspunkte schützen, wie in der Anleitung zu Reflexion zur Unterstützung optionaler Abhängigkeiten beschrieben.
Regeln eng fassen, auch für voroptimierte Bibliotheks-Builds
Wenn sich die Reflexion nicht vermeiden lässt, müssen Sie dafür sorgen, dass in den Keep-Regeln für Nutzer nur angegeben ist, was Ihre Bibliothek reflektiert. Wenn Ihre Bibliothek dynamisch auf eine Klasse oder Methode zugreift, müssen Sie nur den Einstiegspunkt angeben. R8 kümmert sich um den Rest. R8 verwendet die Einstiegspunkte, um ein Diagramm des referenzierten Codes zu erstellen und alle nicht referenzierten Klassen, Methoden und Felder zu entfernen.
Das gilt auch, wenn Sie Ihren Bibliotheks-Build bereits optimiert oder verschleiert haben. Dies ist eine gute Methode, um ein leistungsstarkes und schlankes SDK zu erhalten. Da Ihre Regeln während des Kompilierungsschritts der App angewendet werden, kann R8 Ihre Bibliothek basierend auf den tatsächlichen Klassen und Methoden, die von der nachgelagerten App verwendet werden, weiter optimieren. Mit dem Android-CLI-Befehl „analyze“ werden sowohl verwendete als auch nicht verwendete paketweite Beibehaltungsregeln proaktiv angezeigt, die zu einer blockierten Optimierung beitragen.
Beibehalten-Regeln für Abhängigkeiten von Drittanbietern eng fassen
Das ist ein gängiges Muster, das wir beobachtet haben:
-keep public class com.google.android.gms.** { *; }Wenn eine App, die Ihr SDK integriert, auch eine andere GMS-Bibliothek verwendet und eine Keep-Regel enthält, um die Menge des beibehaltenen Codes zu begrenzen, wird diese durch die allgemeine Regel ersetzt, was zu unnötigem App-Bloat beiträgt.
Wenn Sie externe Bibliotheken aufrufen, sollten Sie Keep-Regeln entwerfen, die nur die spezifischen Elemente beibehalten, auf die Ihre Bibliothek über Reflexion zugreift. Außerdem ist es so, dass viele Bibliotheken (einschließlich GMS) bereits eigene Consumer-Keep-Regeln enthalten. Wenn eine paketweite Keep-Regel eingeführt wird, können auch sorgfältig geschriebene, eng gefasste Consumer-Regeln aus der nachgelagerten Bibliothek übernommen werden.
Bedingte Beibehaltungsregeln für Adapter für die Anzeigenvermittlung in Betracht ziehen
Wenn Ihre Anzeigenbibliothek über Vermittlungsadapter geladen wird, können Sie weiterhin enge Beibehaltungsregeln verwenden. In diesem Szenario empfehlen wir, bedingte Beibehaltungsregeln zu verwenden, um nur bestimmte Funktionen oder Formate beizubehalten, wenn die App den entsprechenden Adapter enthält. So kann R8 weiterhin Funktionen reduzieren, die die App nicht verwendet. Anstatt komplexe Regeln manuell zu schreiben, können Sie auch die Jetpack-Keep-Annotationen verwenden, um Ihre reflektiven Aufrufe direkt im Quellcode zu annotieren und automatisch bedingte Consumer-Keep-Regeln zu generieren, auch für optionale Add-on-Module.
Regeln in Nutzerregeln, nicht in der Dokumentation bereitstellen
Wenn Sie Ihrer Bibliothek Nutzerregeln hinzufügen, können Apps mit einem R8-fähigen Build Ihre Bibliothek sofort verwenden und die maximale Optimierung nutzen.
Wenn Sie Regeln in Ihrer Dokumentation angeben, führt das zu manuellem Einrichtungsaufwand (insbesondere, da gebündelte Consumer-Keep-Regeln seit Jahren in AARs und JARs unterstützt werden) und zu laufendem Wartungsaufwand. Wenn Sie Ihre Bibliothek aktualisieren (einschließlich Refaktorierung, Umbenennung von Klassen und Änderung der Verwendung von Reflexion), müssen Sie daran denken, die Dokumentation zu aktualisieren. Außerdem müssen Apps nach neuen Regeln suchen. Wenn Apps im Laufe der Zeit mehrere Versionen Ihrer Bibliothek durchlaufen, können sich veraltete Beibehaltungsregeln ansammeln, die nicht mehr benötigt werden. Das führt zu unnötigem App-Bloat.
3. Stacktraces von Releases lesen
Möglicherweise ist aufgrund von verschleiertem Code ein unlesbarer Stacktrace aufgetreten. Um die kritische Analyse zu entsperren, kann es verlockend sein, keepnames zu verwenden, was eine Verkleinerung ermöglicht, aber zusätzliche Optimierungen wie das Umbenennen in der verbrauchenden App verhindert – also genau die Werte, die Sie beim Debuggen eines Stacktrace benötigen.
Sie müssen keine zusätzlichen Optimierungen verhindern, um lesbare Stacktraces zu erhalten.
Firebase Crashlytics, die Play Console und Logcat in Android Studio deobfuskieren Stacktraces für App-Entwickler. Wenn ein App-Entwickler einen Stacktrace mit Ihnen teilt, müssen Sie die Verschleierung also nicht verhindern, um ihn lesen zu können.
Wenn Sie Ihre Zuordnungsdatei in die SDK Console hochladen, können Sie in der SDK Console offengelegte Stacktraces sehen.
Kein Rätselraten mehr bei der Optimierung
Die Optimierung Ihrer Mediathek sollte nicht wie ein Ratespiel sein.
Durch die Pflege von Beibehaltungsregeln für Nutzer können Bibliotheksanbieter dafür sorgen, dass Apps im gesamten Ökosystem für die Optimierung freigegeben werden.
Wenn Bibliotheken bessere Regeln enthalten, werden Apps kleiner und schneller. Überprüfen Sie noch heute Ihre Consumer-Keep-Regeln, damit Apps, die von Ihrer Bibliothek abhängen, optimal funktionieren.
-
AnleitungenWir behandeln die profilgestützte Optimierung, Leistungsverbesserungen bei Jetpack Compose und Überlegungen zur Arbeit hinter den Kulissen.
Ben Weiss, Breana Tate, Jossi Wolf • Lesezeit: 8 Minuten -
AnleitungenWillkommen zurück bei der Blogpost-Reihe „Intelligente Android-Apps entwickeln“. Hier erfahren Sie, wie Sie eine einfache Android-App in eine personalisierte, intelligente und agentische Anwendung verwandeln. In unserem vorherigen Beitrag haben Sie erfahren, wie Sie mithilfe von AppFunctions eine Verbindung zum KI-System herstellen.
Jolanda Verhoef • Lesezeit: 9 Minuten -
AnleitungenMedia3 1.11 ist verfügbar. Diese Version, die die Grundlage für die meisten Top-Android-Medien-Apps bildet, bietet neue Funktionen, Fehlerkorrekturen und Verbesserungen bei Wiedergabe, Bearbeitung und UI-Komponenten.
Toni Heidenreich • Lesezeit: 3 Minuten
Lassen Sie sich Woche für Woche die neuesten Informationen zur Android-Entwicklung zusenden.