Instructivos

Envía reglas de conservación más inteligentes: Cómo los proveedores de bibliotecas pueden desbloquear la optimización de código DEX a nivel de la app

Lectura de 6 min
Ver el perfil de Breana Tate
Breana Tate Ingeniero de relaciones con desarrolladores

Como desarrolladores de apps y bibliotecas para Android, todos nos esforzamos por alcanzar el mismo objetivo: crear apps de alto rendimiento que brinden una experiencia del usuario fluida. Una parte importante de eso implica R8, el optimizador de apps de Android. R8 mejora el rendimiento de la app, ya que quita el código sin usar, y optimiza y ofusca el resto.

Google Play anunció recientemente nuevos umbrales de optimización de código DEX para apps y juegos, que ayudan a mejorar los tiempos de inicio, reducir el espacio en memoria y alinearse con el compromiso de Android de aislar la experiencia del usuario de las apps que usan memoria en exceso. Si bien estos umbrales se aplican a las apps y los juegos, cumplirlos es una responsabilidad compartida en todo el ecosistema: R8 solo puede optimizar una app dentro de los parámetros que se le proporcionan, lo que incluye las reglas de conservación que agrupan las bibliotecas de las que depende la app.

El Analizador de configuración de R8 es una excelente herramienta para evaluar los porcentajes de optimización, reducción y ofuscación de la app, que son fundamentales para los requisitos técnicos de Google Play. Además de hacer un seguimiento de estos porcentajes, el Analizador de configuración de R8 también muestra reglas de conservación ineficientes que se originan no solo en las apps, sino también en las reglas de conservación del consumidor empaquetadas en las bibliotecas de las que dependen las apps.

En esta guía, se describe cómo puedes resolver algunos de los desafíos más comunes que enfrentan los proveedores de bibliotecas y enviar reglas estrictas y de alto rendimiento para ayudar a tus clientes a cumplir con los requisitos técnicos de Google Play.

¿Qué son las reglas de conservación de consumidores?

Las reglas de conservación del consumidor son instrucciones empaquetadas en una biblioteca de Android o JAR que le indican a R8 qué partes del código de la biblioteca no se pueden optimizar durante el proceso de compilación a nivel de la app. A diferencia de las reglas de conservación estándar escritas por la app o la biblioteca que se usan en la reducción de artefactos, las reglas de conservación del consumidor se incorporan en las bibliotecas y afectan la forma en que se reduce la biblioteca durante la optimización de toda la app, lo que garantiza que los destinos de reflexión interna y las interfaces nativas permanezcan intactos sin que el desarrollador de la app deba identificarlos manualmente.

Las reglas de conservación de consumidores intencionales y de alcance limitado son una práctica recomendada fundamental que beneficia tanto a la biblioteca como a las apps que la consumen. Las reglas de conservación de consumidores demasiado amplias conservan el código no utilizado y, como resultado, afectan la optimización y el rendimiento de una app. Con las estadísticas de la optimización de código DEX que se agregaron a Play Console, las métricas que verán los desarrolladores de apps representarán el impacto combinado de las reglas de la app y sus bibliotecas integradas.

Equilibrio entre estabilidad y rendimiento

Los proveedores de bibliotecas suelen tener buenas intenciones cuando envían reglas de conservación amplias para los consumidores. Nadie quiere que su SDK active una falla debido a la eliminación de una clase durante la reflexión. 

Sin embargo, no se recomiendan las reglas de conservación amplias o que abarquen todo el paquete como solución a largo plazo para evitar fallas, ya que limitan de forma significativa el potencial de optimización de la app de todo el programa de R8. Estas son algunas estrategias recomendadas para ayudarte a enviar reglas específicas y de alto rendimiento sin sacrificar la estabilidad:

1. Prueba y lanzamiento de reglas específicas

Para ayudarte a lanzar reglas estrictas con confianza, ten en cuenta estas prácticas recomendadas:

  • Prueba en una app de ejemplo: La guía de pruebas locales que se encuentra en Prueba tu optimización también se aplica a las apps de ejemplo. Después de habilitar R8, prueba los recorridos críticos del usuario para asegurarte de que la funcionalidad se comporte como se espera.
  • Ejecuta el Analizador de configuración de R8 en tu app de ejemplo para ver lo que ven los desarrolladores de apps cuando auditan su configuración de R8. Te permite visualizar fácilmente los impactos de tus reglas de conservación en las apps downstream.
  • Usa el comando analyze de la CLI de Android para evaluar la optimización de tu AAR o JAR, incluidos los métodos, las clases y los campos que se conservaron. Puedes comparar estos números entre versiones para supervisar las regresiones.
  • Supervisa el uso de las versiones de la biblioteca y las fallas en Google Play SDK Console.
  • Consulta la guía de Optimización para autores de bibliotecas y la documentación de R8 para conocer las prácticas recomendadas.

2. Preserva los destinos de reflexión y JNI sin reglas de conservación amplias

Enviar una biblioteca con reglas de conservación amplias o para todo el paquete no solo afecta a tu SDK, sino que también obliga a los desarrolladores a aceptar un código inflado que ralentiza el tiempo de inicio de la app y aumenta el tamaño de descarga, el uso de memoria y las tasas de ANR. También es posible que las apps que se enfocan en el rendimiento escriban reglas personalizadas que reemplacen las que se incluyen en tu biblioteca, lo que también desalienta a estas apps a adoptar futuras actualizaciones de la biblioteca para reducir el riesgo.

Si tu SDK se orienta a código nativo, como el de los juegos o los editores de fotos y videos, proporciona reglas para todas las clases que usen JNI. La mayoría de los juegos se ejecutan sobre motores de juegos, como Unity y Unreal, que compilan el juego en código nativo. El código nativo del juego y tu complemento se comunican con el framework de Android a través de llamadas de JNI.

Jetpack Keep annotations, que ahora está en versión alfa, puede ayudar a reducir el mantenimiento que requiere la reflexión, ya que te permite anotar el uso de la reflexión, que luego se puede usar para generar reglas de conservación en el momento de la compilación.

Considera usar la generación de código en lugar de la reflexión

Para evitar fallas debido a la reflexión, nuestro consejo más importante es evitar la reflexión y usar codegen siempre que sea posible. 

La reflexión del entorno de ejecución oculta el uso del código de R8 durante la compilación, lo que requiere reglas de conservación para evitar fallas. Si usas la generación de código, este se optimiza durante el proceso de compilación, lo que permite que R8 tenga la visibilidad necesaria para optimizar el código de forma segura con reglas de conservación mínimas. Entre los casos comunes en los que la generación de código es una excelente opción, se incluyen la serialización y la deserialización, y la inserción de dependencias (Hilt es un ejemplo de una biblioteca que usa la generación de código).

Sin embargo, la generación de código no es la opción correcta para todas las situaciones. Para patrones como dependencias opcionales, la reflexión sigue siendo necesaria. Te recomendamos vincular la reflexión con reglas de conservación estrictas que protejan solo los puntos de entrada obligatorios, como se describe en la guía sobre Reflexión para admitir dependencias opcionales. 

Define reglas de alcance de forma precisa, incluso para compilaciones de bibliotecas preoptimizadas

Si no es posible evitar la reflexión, asegúrate de que las reglas de conservación de tu consumidor especifiquen solo lo que refleja tu biblioteca. Cuando tu biblioteca acceda a una clase o un método de forma dinámica, solo deberás especificar el punto de entrada, y R8 se encargará del resto. R8 usa los puntos de entrada para compilar un gráfico del código al que se hace referencia y quitar las clases, los métodos y los campos a los que no se hace referencia.

Esto también se aplica si ya optimizaste o ofuscaste la compilación de tu biblioteca, lo que es una práctica excelente para garantizar un SDK ligero y de alto rendimiento. Debido a que tus reglas se aplican durante el paso de compilación de la app, R8 puede optimizar aún más tu biblioteca en función de las clases y los métodos reales que usa la app downstream. El comando de análisis de la CLI de Android muestra de forma proactiva las reglas de conservación de todo el paquete que se usan y las que no, y que contribuyen a la optimización bloqueada.

Limita el alcance de las reglas de conservación para las dependencias de terceros

Este es un patrón común que hemos visto:

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

Si una app que integra tu SDK también usa otra biblioteca de GMS y, además, incluye una regla de conservación para limitar la cantidad de código que se conserva, esta regla general la reemplaza, lo que contribuye a que la app se infle innecesariamente. 

Cuando invoques bibliotecas externas, debes diseñar reglas de conservación que preserven estrictamente solo los elementos específicos a los que accede tu biblioteca a través de la reflexión. Además, la realidad es que muchas bibliotecas (incluidos los GMS) ya envían sus propias reglas de conservación para consumidores. Introducir una regla de conservación para todo el paquete también puede incluir reglas para consumidores escritas con cuidado y de alcance limitado de la biblioteca downstream.

Considera usar reglas de conservación condicionales para los adaptadores de mediación de anuncios 

Si tu biblioteca de anuncios se carga con adaptadores de mediación, las reglas de conservación restringidas siguen siendo una opción. En este caso, te recomendamos que uses reglas de conservación condicionales para conservar solo ciertas funciones o formatos si la app incluye el adaptador correspondiente. Esto garantiza que R8 pueda seguir reduciendo las funciones que la app no usa. Como otra opción, en lugar de escribir reglas complejas de forma manual, también puedes usar las anotaciones de Keep de Jetpack para anotar tus llamadas reflexivas directamente en el código fuente y generar automáticamente reglas de conservación condicionales para los consumidores, incluso para los módulos complementarios opcionales.

Envía reglas en las reglas para consumidores, no en la documentación

Si envías reglas de consumidor con tu biblioteca, te aseguras de que las apps con una compilación habilitada para R8 puedan usar tu biblioteca de inmediato y desbloquear la optimización máxima. 

Especificar reglas en la documentación agrega fricción en la configuración manual (especialmente porque las reglas de conservación de consumidores empaquetadas se admiten en AAR y JAR desde hace años) y genera una sobrecarga de mantenimiento continuo. Cuando actualizas tu biblioteca (incluida la refactorización, el cambio de nombre de las clases y el cambio de la forma en que se usa la reflexión), debes recordar actualizar la documentación, y las apps deben recordar verificar si hay reglas nuevas. Con el tiempo, a medida que las apps se actualizan a través de varias versiones de tu biblioteca, pueden acumular reglas de conservación heredadas que ya no son necesarias, lo que genera un aumento innecesario del tamaño de la app.

3. Cómo leer los seguimientos de pila de las versiones

Es posible que hayas encontrado un seguimiento de pila ilegible debido a un código ofuscado. Para desbloquear el análisis crítico, puede ser tentador usar keepnames, que permite la reducción, pero evita optimizaciones adicionales, como el cambio de nombre en la app de consumo, que son los valores precisos que necesitas cuando depuras un seguimiento de pila. 

No es necesario que evites optimizaciones adicionales para obtener seguimientos de pila legibles.

Firebase Crashlytics, Play Console y Logcat en Android Studio desofuscan los seguimientos de pila para los desarrolladores de apps. Esto significa que, si un desarrollador de apps comparte un seguimiento de pila contigo, no necesitas evitar la ofuscación para poder leerlo.

Si subes tu archivo de asignación a SDK Console, podrás ver seguimientos de pila desofuscados en SDK Console.

Elimina las conjeturas de la optimización

Optimizar tu biblioteca no debería ser un juego de prueba y error.

Si mantienen las reglas de conservación de consumidores, los proveedores de bibliotecas pueden garantizar que las apps de todo el ecosistema no se bloqueen para la optimización.

Cuando las bibliotecas envían mejores reglas, las apps se vuelven más pequeñas y rápidas. Comienza a auditar tus reglas de conservación de consumidores hoy mismo para ayudar a que las apps que dependen de tu biblioteca tengan el mejor rendimiento posible.

Escrito por:
Seguir leyendo