Инструкции

Как поставщики библиотек могут разблокировать оптимизацию DEX-кода на уровне приложения

Время на чтение: 6 минут
Посмотреть профиль пользователя Breana Tate
Breana Tate Developer Relations Engineer

Как разработчики приложений и библиотек для Android, мы все стремимся к одной цели – создавать эффективные приложения, которые обеспечивают удобство для пользователей. R8 – оптимизатор приложений Android. R8 повышает производительность приложения, удаляя неиспользуемый код, а также оптимизируя и обфусцируя оставшийся.

Недавно Google Play объявил о новых пороговых значениях оптимизации кода DEX для приложений и игр. Они помогают сократить время запуска, уменьшить объем потребляемой памяти и соответствуют стремлению Android защитить пользователей от приложений, которые используют слишком много памяти. Хотя эти пороговые значения применяются к приложениям и играм, ответственность за их соблюдение лежит на всей экосистеме. R8 может оптимизировать приложение только в рамках заданных параметров, включая правила сохранения, связанные с библиотеками, от которых зависит приложение.

Анализатор конфигурации R8 – отличный инструмент для оценки оптимизации приложения, сокращения кода и процента обфускации, которые лежат в основе технических требований Google Play. Помимо отслеживания этих процентов, анализатор конфигурации R8 также выявляет неэффективные правила сохранения, исходящие не только из приложений, но и из пользовательских правил сохранения, связанных с библиотеками, от которых зависят приложения.

В этом руководстве рассказывается, как решить самые распространенные проблемы, с которыми сталкиваются поставщики библиотек, и создать узкие и эффективные правила, чтобы помочь клиентам соблюдать технические требования Google Play.

Что такое правила хранения для потребителей?

Правила сохранения для потребителей – это инструкции, включенные в библиотеку Android или JAR. Они указывают R8, какие части кода библиотеки не могут быть оптимизированы во время компиляции на уровне приложения. В отличие от стандартных правил сохранения, написанных приложением или библиотекой, которые используются при минификации артефактов, правила сохранения для потребителей встроены в библиотеки и влияют на то, как библиотека минифицируется во время оптимизации всего приложения. Это гарантирует, что внутренние цели отражения и нативные интерфейсы останутся нетронутыми, и разработчику приложения не придется идентифицировать их вручную.

Продуманные правила сохранения с узкой областью действия – это важная рекомендация, которая приносит пользу как библиотеке, так и приложениям, которые ее используют. Слишком широкие правила сохранения потребителей сохраняют неиспользуемый код и, как следствие, влияют на оптимизацию и производительность приложения. В Play Console добавлена статистика по оптимизации кода DEX. Показатели, которые видят разработчики приложений, отражают совокупное влияние правил как из приложения, так и из интегрированных в него библиотек.

Баланс между стабильностью и производительностью

Поставщики библиотек часто руководствуются благими намерениями, когда поставляют широкие правила сохранения для потребителей. Никто не хочет, чтобы его SDK вызывал сбой из-за удаления класса во время рефлексии. 

Однако правила сохранения, действующие на уровне пакета или в более широком масштабе, не рекомендуется использовать в качестве долгосрочного решения для предотвращения сбоев, поскольку они значительно ограничивают возможности R8 по оптимизации приложения на уровне всей программы. Вот несколько рекомендаций, которые помогут вам создавать узкие и эффективные правила, не жертвуя стабильностью:

1. Тестирование и развертывание узких правил

Чтобы уверенно выпускать узкие правила, следуйте этим рекомендациям:

  • Протестируйте оптимизацию в примере приложения. Инструкции по локальному тестированию в разделе Протестируйте оптимизацию также применимы к примерам приложений. После включения R8 протестируйте критические пути пользователей, чтобы убедиться, что все работает правильно.
  • Запустите анализатор конфигурации R8 в примере приложения, чтобы увидеть, что разработчики приложений видят при аудите конфигурации R8. Это позволяет легко визуализировать влияние правил хранения на приложения, расположенные ниже по цепочке.
  • Используйте команду analyze из Android CLI, чтобы оценить оптимизацию AAR или JAR, включая сохраненные методы, классы и поля. Сравнивая эти показатели в разных выпусках, вы сможете отслеживать регрессии.
  • Отслеживайте использование версий библиотек и сбои в Google Play SDK Console.
  • Ознакомьтесь с рекомендациями в руководстве Оптимизация для авторов библиотек и документации по R8.

2. Сохранение целей рефлексии и JNI без широких правил сохранения

Если вы поставляете библиотеку с правилами сохранения, которые распространяются на весь пакет или его большую часть, это влияет не только на ваш SDK. Разработчикам приходится мириться с раздутым кодом, который замедляет запуск приложения, увеличивает его размер и использование памяти, а также повышает долю ошибок ANR. Также возможно, что разработчики приложений, ориентированных на производительность, напишут собственные правила, заменяющие правила, поставляемые с вашей библиотекой. Это также может помешать им внедрять будущие обновления библиотеки, чтобы снизить риски.

Если ваш SDK предназначен для нативного кода, например в играх или редакторах фото и видео, укажите правила для всех классов, использующих JNI. Большинство игр работают на базе игровых движков, таких как Unity и Unreal, которые компилируют игру в нативный код. Нативный код игры и плагин взаимодействуют с фреймворком Android через вызовы JNI.

Аннотации Jetpack Keep, которые сейчас находятся на стадии альфа-тестирования, позволяют аннотировать использование рефлексии и генерировать правила сохранения во время сборки. Это помогает сократить объем обслуживания, необходимого для рефлексии.

Используйте генерацию кода вместо рефлексии

Чтобы избежать сбоев, связанных с рефлексией, мы рекомендуем не использовать ее и по возможности применять генерацию кода.

Рефлексия во время выполнения скрывает использование кода от R8 во время компиляции, поэтому для предотвращения сбоев требуются правила сохранения. Если вы используете генерацию кода, он оптимизируется во время сборки, что позволяет R8 безопасно оптимизировать код с минимальным количеством правил сохранения. Типичные сценарии, в которых генерация кода является отличным выбором, включают сериализацию и десериализацию, а также внедрение зависимостей (Hilt – пример библиотеки, использующей генерацию кода).

Однако генерация кода подходит не для всех сценариев. Для таких шаблонов, как необязательные зависимости, рефлексия по-прежнему необходима. Рекомендуем использовать рефлексию со строгими правилами сохранения, которые защищают только необходимые точки входа, как описано в руководстве Рефлексия для поддержки необязательных зависимостей. 

Задавайте узкие области действия правил, даже для предварительно оптимизированных сборок библиотек

Если избежать рефлексии невозможно, убедитесь, что правила сохранения потребителей указывают только на то, что отражает ваша библиотека. Если библиотека обращается к классу или методу динамически, вам нужно указать только точку входа, а R8 сделает все остальное. R8 использует точки входа, чтобы построить граф кода, на который есть ссылки, и удалить все классы, методы и поля, на которые ссылок нет.

Это также относится к случаям, когда вы уже оптимизировали или обфусцировали сборку библиотеки, что является отличной практикой для обеспечения производительности и легкости SDK. Поскольку правила применяются на этапе компиляции приложения, R8 может дополнительно оптимизировать библиотеку на основе фактических классов и методов, используемых нижестоящим приложением. Команда analyze в Android CLI упреждающе выявляет как используемые, так и неиспользуемые правила сохранения на уровне пакета, которые способствуют блокировке оптимизации.

Ограничивайте область действия правил сохранения для сторонних зависимостей

Вот распространенный пример:

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

Если приложение, интегрирующее ваш SDK, также использует другую библиотеку GMS и включает правило keep, ограничивающее объем сохраняемого кода, это общее правило заменяет его, способствуя ненужному раздуванию приложения. 

При вызове внешних библиотек следует создавать правила сохранения, которые строго сохраняют только те элементы, к которым библиотека обращается через рефлексию. Кроме того, многие библиотеки (включая GMS) уже поставляются с собственными правилами сохранения. Введение правила сохранения на уровне пакета может также включать тщательно написанные правила сохранения с узкой областью действия из нижестоящей библиотеки.

Используйте условные правила сохранения для адаптеров медиации объявлений

Если библиотека объявлений загружается с помощью адаптеров медиации, вы по-прежнему можете использовать узкие правила сохранения. В этом случае мы рекомендуем использовать условные правила сохранения, чтобы сохранять только определенные функции или форматы, если в приложении есть соответствующий адаптер. Это позволит R8 по-прежнему сокращать функции, которые не используются в приложении. Вместо того чтобы вручную писать сложные правила, вы можете использовать аннотации Jetpack Keep, чтобы аннотировать вызовы рефлексии непосредственно в исходном коде и автоматически генерировать условные правила сохранения для потребителей, в том числе для дополнительных модулей.

Правила должны быть в правилах для потребителей, а не в документации

Если вы добавите правила для потребителей в библиотеку, приложения со сборкой, в которой включен R8, смогут использовать вашу библиотеку без дополнительной настройки и с максимальной оптимизацией. 

Указание правил в документации усложняет настройку вручную (особенно с учетом того, что правила сохранения потребителей, включенные в пакет, поддерживаются в AAR и JAR в течение многих лет) и создает постоянные накладные расходы на обслуживание. При обновлении библиотеки (в том числе при рефакторинге, переименовании классов и изменении способа использования рефлексии) необходимо обновить документацию, а в приложениях – проверить наличие новых правил. Со временем, когда приложения обновляются до новых версий библиотеки, в них могут накапливаться устаревшие правила сохранения, которые больше не нужны и только увеличивают размер приложения.

3. Чтение трассировок стека в рабочей версии

Если код обфусцирован, трассировка стека может быть нечитаемой. Чтобы разблокировать критический анализ, может возникнуть соблазн использовать keepnames, который позволяет сжимать, но предотвращает дополнительные оптимизации, такие как переименование в потребляющем приложении – точные значения, которые вам нужны при отладке трассировки стека. 

Чтобы получить читаемые трассировки стека, не нужно отключать дополнительные оптимизации.

Firebase Crashlytics, Play Console и Logcat в Android Studio деобфусцируют трассировки стека для разработчиков приложений. Это значит, что если разработчик приложения поделится с вами трассировкой стека, вам не нужно будет отключать обфускацию, чтобы прочитать ее.

Если вы загрузите файл сопоставления в SDK Console, то сможете просматривать деобфусцированные трассировки стека.

Оптимизация без догадок

Оптимизация библиотеки не должна быть похожа на игру методом проб и ошибок.

Если поставщики библиотек будут поддерживать правила сохранения потребителей, то приложения в экосистеме не будут заблокированы для оптимизации.

Если библиотеки поставляют более эффективные правила, приложения становятся меньше и быстрее. Проверьте правила сохранения потребителей, чтобы приложения, зависящие от вашей библиотеки, работали максимально эффективно.

Автор:
Продолжить чтение