Выбирайте библиотеки с умом

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

Общие советы по выбору библиотек

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

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

Выбирайте библиотеки, которые используют генерацию кода (codegen) вместо рефлексии. С помощью генерации кода оптимизатор может определить, какой код действительно используется во время выполнения, а какой можно удалить. Иногда бывает сложно определить, что используется в библиотеке – генерация кода или рефлексия. В этом случае вам помогут советы.

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

Проверьте, используется ли рефлексия (для опытных пользователей)

Чтобы узнать, использует ли библиотека рефлексию, изучите ее код. Если библиотека использует рефлексию, убедитесь, что в ней есть связанные правила сохранения. Библиотека, скорее всего, использует рефлексию, если она:

  • Использует классы или методы из пакетов kotlin.reflect или java.lang.reflect.
  • Используются функции Class.forName или classLoader.getClass.
  • Считывает аннотации во время выполнения, например если сохраняет значение аннотации с помощью val value = myClass.getAnnotation() или val value = myMethod.getAnnotation(), а затем выполняет действие с value.
  • Вызывает методы, используя название метода в виде строки, как в следующем примере:

    // Calls the private `processData` API with reflection
    myObject.javaClass.getMethod("processData", DataType::class.java)
    ?.invoke(myObject, data)
    

Проверьте, нет ли проблем с оптимизацией

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

  • Библиотеки AndroidX и другие библиотеки, например Hilt, хорошо работают с оптимизацией приложений, поскольку в основном используют генерацию кода, а не рефлексию. Если же рефлексия используется, то в минимальном объеме, чтобы сохранить только необходимый код.
  • Библиотеки сериализации часто используют рефлексию, чтобы избежать шаблонного кода при создании экземпляров или сериализации объектов. Вместо подходов, основанных на рефлексии (например, Gson для JSON), ищите библиотеки, которые используют генерацию кода, чтобы избежать этих проблем, например Kotlin Serialization или Moshi с генерацией кода.
  • По возможности избегайте библиотек, в которых есть правила сохранения для всего пакета. Правила сохранения на уровне пакета могут помочь устранить ошибки, но в конечном итоге широкие правила сохранения должны быть уточнены, чтобы сохранить только необходимый код. Подробнее о том, как постепенно внедрять оптимизацию…
  • Прежде чем публиковать приложение, в котором используется сторонняя библиотека, проверьте ее правила сохранения с помощью анализатора конфигурации R8. Проанализировав отчет, вы сможете понять, не слишком ли широки правила сохранения библиотеки, что мешает R8 выполнять критически важные оптимизации в вашей базе кода. Это позволит убедиться, что выбранные библиотеки соответствуют целям по эффективности приложения и не усложняют его конфигурацию.
  • Библиотеки не должны требовать от вас копирования и вставки правил сохранения из документации в файл вашего проекта, особенно правил сохранения на уровне пакета. В долгосрочной перспективе такие правила становятся обузой для разработчика приложения, и их сложно оптимизировать и изменять со временем.

Включить оптимизацию после добавления новой библиотеки

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

Отфильтруйте неверные правила хранения (для опытных пользователей)

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

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

// If you're using AGP 8.4 and higher
buildTypes {
    release {
        optimization.keepRules {
          it.ignoreFrom("com.somelibrary:somelibrary")
        }
    }
}

// If you're using AGP 7.3-8.3
buildTypes {
    release {
        optimization.keepRules {
          it.ignoreExternalDependencies("com.somelibrary:somelibrary")
        }
    }
}

Рекомендуемый рабочий процесс для правил библиотеки широкого соответствия

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

  1. Обновите библиотеку. Убедитесь, что вы используете последнюю версию библиотеки, отмеченной анализатором конфигурации R8, поскольку в более новых версиях могут поставляться более узкие правила сохранения для потребителей. Чтобы найти последнюю версию, ознакомьтесь с документацией библиотеки или ее репозиторием Maven. Android Studio также помечает новые версии многих зависимостей. После обновления снова запустите анализатор конфигурации R8, чтобы проверить, остались ли общие правила сохранения.
  2. Проверьте потенциальное улучшение локально. Скопируйте правила потребителя, связанные с библиотекой, в локальный файл правил сохранения, отфильтруйте связанные правила, как показано в разделе Фильтрация плохих правил сохранения, и сузьте скопированные правила. Запустите анализатор конфигурации R8 до и после сужения правил, чтобы сравнить показатели сжатия, оптимизации и обфускации приложения.
  3. Сообщите о результатах. Отправьте отчет об ошибке разработчику библиотеки, включив в него эмпирические данные из отчета R8 Configuration Analyzer (например, укажите точное количество классов или методов без ссылок, сохраненных правилом с подстановочным знаком).

Пример: почему Gson не работает с оптимизацией

Gson – это библиотека сериализации, которая часто вызывает проблемы с оптимизацией приложения, поскольку активно использует рефлексию. В следующем фрагменте кода показано, как обычно используется Gson, что может привести к сбоям во время выполнения. Обратите внимание, что при использовании Gson для получения списка объектов User вы не вызываете конструктор и не передаете фабрику в функцию fromJson(). Создание или использование определенных приложением классов без любого из следующих элементов является признаком того, что библиотека может использовать неограниченную рефлексию:

  • Класс приложения, реализующий библиотеку, стандартный интерфейс или класс.
  • Плагин для генерации кода, например KSP.
class User(val name: String)
class UserList(val users: List<User>)

// This code runs in debug mode, but crashes when optimizations are enabled
Gson().fromJson("""[{"name":"myname"}]""", User::class.java).toString()

Чтобы понять, как R8 работает с Gson, ознакомьтесь с правилами для пользователей Gson. Когда R8 анализирует этот код и не видит, что экземпляр UserList или User где-либо создан, он может переименовать поля или удалить конструкторы, которые, по-видимому, не используются, что приведет к сбою приложения. Если вы используете другие библиотеки аналогичным образом, убедитесь, что они не мешают оптимизации приложения. Если это так, не используйте их.

Используйте @SerializedName с более поздними версиями Gson

Чтобы определить модели данных в соответствии с правилами Gson, добавьте к полям аннотацию @SerializedName, как показано в следующем фрагменте кода:

import com.google.gson.annotations.SerializedName

class User(@SerializedName("name") val name: String)
class UserList(@SerializedName("users") val users: List<User>)

Используя аннотацию @SerializedName, вы разрешаете R8 сопоставлять классы моделей с правилами сохранения, включенными в Gson версии 2.11.0 и выше. R8 автоматически сохраняет аннотированные поля и необходимые конструкторы, позволяя вам полагаться на правила, включенные в библиотеку, без необходимости вручную поддерживать конфигурации ProGuard в вашем проекте.

Обратите внимание, что Room, Hilt и Moshi с codegen создают типы, определенные приложением, но используют codegen, чтобы избежать необходимости рефлексии.