Istruzioni

Pubblica regole di conservazione più intelligenti: come i fornitori di librerie possono sbloccare l'ottimizzazione del codice DEX a livello di app

Tempo di lettura: 6 min
Visualizza il profilo di Breana Tate
Breana Tate Developer Relations Engineer

In qualità di sviluppatori di app per Android e librerie, tutti noi puntiamo allo stesso obiettivo: app ad alte prestazioni che offrono un'esperienza utente fluida. Una parte importante di questo processo riguarda R8, lo strumento di ottimizzazione delle app di Android. R8 migliora le prestazioni dell'app rimuovendo il codice inutilizzato e ottimizzando e offuscando il resto.

Google Play ha annunciato di recente nuove soglie di ottimizzazione del codice DEX per app e giochi, che contribuiscono a migliorare i tempi di avvio, ridurre il footprint della memoria e rispettare l'impegno di Android di isolare l'esperienza utente dalle app che utilizzano memoria in eccesso. Sebbene queste soglie si applichino ad app e giochi, il loro rispetto è una responsabilità condivisa nell'ecosistema: R8 può ottimizzare un'app solo entro i parametri forniti, che includono le regole di conservazione raggruppate dalle librerie da cui dipende l'app.

R8 Configuration Analyzer è un ottimo strumento per valutare le percentuali di ottimizzazione, riduzione e offuscamento dell'app, che sono alla base dei requisiti tecnici di Google Play. Oltre a monitorare queste percentuali, l'analizzatore della configurazione R8 mostra anche regole di conservazione inefficienti provenienti non solo dalle app, ma anche dalle regole di conservazione dei consumer raggruppate nelle librerie da cui dipendono le app.

Questa guida illustra come risolvere alcuni dei problemi più comuni che i fornitori di librerie devono affrontare e come fornire regole specifiche e ad alte prestazioni per aiutare i tuoi clienti a soddisfare i requisiti tecnici di Google Play.

Che cosa sono le regole di conservazione dei consumatori?

Le regole di conservazione per i consumer sono istruzioni raggruppate all'interno di una libreria Android o JAR che indicano a R8 quali parti del codice della libreria non possono essere ottimizzate durante il processo di compilazione a livello di app. A differenza delle regole di conservazione standard scritte dall'app o dalla libreria utilizzata nella minimizzazione degli artefatti, le regole di conservazione consumer sono incorporate nelle librerie e influiscono sulla modalità di minimizzazione della libreria durante l'ottimizzazione dell'intera app, garantendo che i target di riflessione interni e le interfacce native rimangano intatti senza che lo sviluppatore di app debba identificarli manualmente.

Le regole di conservazione dei consumer intenzionali e con ambito limitato sono una best practice fondamentale che avvantaggia sia la libreria sia le app che la utilizzano. Le regole di conservazione dei consumer troppo ampie conservano il codice inutilizzato e, di conseguenza, influiscono sull'ottimizzazione e sulle prestazioni di un'app. Con l'aggiunta degli insight sull'ottimizzazione del codice DEX a Play Console, le metriche che gli sviluppatori di app vedranno rappresentano l'impatto combinato delle regole dell'app e delle sue librerie integrate.

Bilanciamento di stabilità e prestazioni

I fornitori di librerie spesso hanno buone intenzioni quando applicano regole di conservazione ampie per i consumatori. Nessuno vuole che il proprio SDK attivi un arresto anomalo a causa della rimozione della classe durante la riflessione. 

Tuttavia, le regole di conservazione a livello di pacchetto o comunque ampie non sono consigliate come soluzione a lungo termine per la prevenzione degli arresti anomali, in quanto limitano notevolmente il potenziale di ottimizzazione dell'app per l'intero programma di R8. Ecco alcune strategie consigliate per aiutarti a creare regole specifiche e ad alte prestazioni senza sacrificare la stabilità:

1. Test e implementazione di regole specifiche

Per aiutarti a rilasciare regole specifiche con sicurezza, tieni presente queste best practice:

  • Esegui i test in un'app di esempio: le indicazioni per i test locali riportate in Testa l'ottimizzazione si applicano anche alle app di esempio. Dopo aver attivato R8, testa i Critical User Journey per assicurarti che la funzionalità funzioni come previsto.
  • Esegui R8 Configuration Analyzer sulla tua app di esempio per vedere cosa vedono gli sviluppatori di app quando controllano la configurazione R8. Ti consente di visualizzare facilmente l'impatto delle regole di conservazione sulle app downstream.
  • Utilizza il comando analyze dall'interfaccia a riga di comando di Android per valutare l'ottimizzazione del tuo file AAR o JAR, inclusi i metodi, le classi e i campi conservati. Puoi confrontare questi numeri tra le varie release per monitorare le regressioni.
  • Monitora l'utilizzo delle versioni della libreria e gli arresti anomali in Google Play SDK Console.
  • Consulta le indicazioni relative all'ottimizzazione per gli autori di librerie e la documentazione di R8 per le best practice.

2. Preservare i target di riflessione e JNI senza regole di conservazione ampie

La distribuzione di una libreria con regole di conservazione ampie o a livello di pacchetto non influisce solo sul tuo SDK, ma costringe anche gli sviluppatori ad accettare un codice eccessivo che rallenta il tempo di avvio dell'app e aumenta le dimensioni di download dell'app, la memoria utilizzata e le percentuali di ANR. È anche possibile che le app orientate alle prestazioni scrivano regole personalizzate che sostituiscono quelle incluse nella libreria, il che scoraggia anche queste app dall'adottare futuri aggiornamenti della libreria per ridurre i rischi.

Se l'SDK ha come target il codice nativo, ad esempio quello di giochi o editor di foto e video, fornisci regole per tutte le classi che utilizzano JNI. La maggior parte dei giochi viene eseguita su motori grafici come Unity e Unreal, che compilano il gioco in codice nativo. Il codice nativo del gioco e il tuo plug-in comunicano con il framework Android tramite chiamate JNI.

Jetpack Keep annotations, ora in versione alpha, può contribuire a ridurre la manutenzione richiesta dalla riflessione, consentendoti di annotare l'utilizzo della riflessione, che può poi essere utilizzato per generare regole di conservazione in fase di build.

Considera la generazione di codice rispetto alla riflessione

Per evitare arresti anomali dovuti alla reflection, il nostro consiglio principale è di evitare la reflection e utilizzare codegen, se possibile. 

La riflessione in fase di runtime nasconde l'utilizzo del codice da R8 durante la compilazione, il che richiede regole di conservazione per evitare arresti anomali. Se utilizzi la generazione di codice, il codice viene ottimizzato durante il processo di build, consentendo a R8 di avere la visibilità necessaria per ottimizzare il codice in modo sicuro con regole di conservazione minime. Gli scenari comuni in cui la generazione di codice è un'ottima scelta includono la serializzazione e la deserializzazione, nonché l'inserimento delle dipendenze (Hilt è un esempio di libreria che utilizza la generazione di codice).

Tuttavia, la generazione di codice non è la scelta giusta per ogni scenario. Per pattern come le dipendenze facoltative, la riflessione è ancora necessaria. Ti consigliamo di abbinare la reflection a regole di conservazione ristrette che proteggano solo i punti di accesso richiesti, come descritto nelle indicazioni su Reflection per supportare le dipendenze facoltative. 

Definisci regole con un ambito ristretto, anche per le build di librerie pre-ottimizzate

Se non è possibile evitare la riflessione, assicurati che le regole di conservazione del consumer specifichino solo ciò su cui la libreria riflette. Quando la tua libreria accede a una classe o a un metodo in modo dinamico, devi solo specificare l'entry point e R8 si occuperà del resto. R8 utilizza gli entry point per creare un grafico del codice di riferimento e rimuovere eventuali classi, metodi e campi non di riferimento.

Questo vale anche se hai già ottimizzato o offuscato la build della libreria, una best practice per garantire un SDK leggero e dalle prestazioni elevate. Poiché le regole vengono applicate durante la fase di compilazione dell'app, R8 può ottimizzare ulteriormente la libreria in base alle classi e ai metodi effettivi utilizzati dall'app downstream. Il comando di analisi dell'interfaccia a riga di comando di Android mostra in modo proattivo le regole keep a livello di pacchetto utilizzate e non utilizzate che contribuiscono all'ottimizzazione bloccata.

Definisci l'ambito delle regole keep in modo restrittivo per le dipendenze di terze parti

Questo è un pattern comune che abbiamo osservato:

-keep public class com.google.android.gms.** { *; }

Se un'app che integra il tuo SDK utilizza anche un'altra libreria GMS e include una regola di conservazione per limitare la quantità di codice conservato, questa regola generale prevale su quella di conservazione, contribuendo a un inutile aumento delle dimensioni dell'app. 

Quando richiami librerie esterne, devi progettare regole di conservazione che preservino rigorosamente solo gli elementi specifici a cui la tua libreria accede tramite reflection. Inoltre, la realtà è che molte librerie (tra cui GMS) forniscono già le proprie regole di conservazione per i consumer. L'introduzione di una regola di conservazione a livello di pacchetto può anche includere regole per i consumer scritte con cura e con un ambito limitato della libreria downstream.

Prendi in considerazione le regole di conservazione condizionale per gli adattatori di mediazione degli annunci 

Se la libreria di annunci viene caricata utilizzando gli adattatori di mediazione, le regole di conservazione ristrette sono comunque un'opzione. In questo scenario, ti consigliamo di utilizzare regole di conservazione condizionali per conservare solo determinate funzionalità o formati se l'app include l'adattatore corrispondente. In questo modo, R8 può comunque ridurre le funzionalità non utilizzate dall'app. In alternativa, invece di scrivere manualmente regole complesse, puoi anche utilizzare le annotazioni Jetpack Keep per annotare le chiamate di riflessione direttamente nel codice sorgente e generare automaticamente regole keep condizionali per i consumer, anche per i moduli aggiuntivi facoltativi.

Invia le regole nelle regole per i consumatori, non nella documentazione

Se includi le regole per i consumer nella tua libreria, ti assicuri che le app con una build abilitata per R8 possano utilizzare la tua libreria immediatamente e sbloccare la massima ottimizzazione. 

La specifica delle regole nella documentazione aggiunge attrito alla configurazione manuale (soprattutto perché le regole di conservazione dei consumer in bundle sono supportate negli AAR e nei JAR da anni) e crea un overhead di manutenzione continuo. Quando aggiorni la libreria (inclusi il refactoring, la ridenominazione delle classi e la modifica del modo in cui viene utilizzata la riflessione), devi ricordarti di aggiornare la documentazione e le app devono ricordarsi di verificare la presenza di nuove regole. Nel tempo, man mano che le app vengono aggiornate tramite più versioni della tua libreria, potrebbero accumulare regole di conservazione legacy non più necessarie, causando un aumento inutile delle dimensioni dell'app.

3. Lettura delle analisi dello stack delle release

Potresti aver riscontrato un'analisi dello stack illeggibile a causa del codice offuscato. Per sbloccare l'analisi critica, può essere allettante utilizzare keepnames, che consente la riduzione, ma impedisce ulteriori ottimizzazioni come la ridenominazione nell'app di consumo, ovvero i valori precisi di cui hai bisogno durante il debug di un'analisi dello stack. 

Non è necessario impedire ulteriori ottimizzazioni per ottenere analisi dello stack leggibili.

Firebase Crashlytics, Play Console e Logcat in Android Studio deoffuscano le analisi dello stack per gli sviluppatori di app. Ciò significa che, se uno sviluppatore di app condivide con te un'analisi dello stack, non devi impedire l'offuscamento per poterla leggere.

Se carichi il file di mappatura in SDK Console, potrai visualizzare le analisi dello stack deoffuscate in SDK Console.

Elimina le congetture dall'ottimizzazione

Ottimizzare la tua raccolta non dovrebbe essere un processo di tentativi ed errori.

Mantenendo le regole di conservazione dei consumer, i fornitori di librerie possono garantire che le app nell'ecosistema non vengano bloccate dall'ottimizzazione.

Quando le librerie forniscono regole migliori, le app diventano più piccole e veloci. Inizia oggi stesso a controllare le regole di conservazione dei consumer per aiutare le app che dipendono dalla tua libreria a funzionare al meglio.

Scritto da:
Continua a leggere