Настройка вариантов сборки

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

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

Варианты сборки — это результат использования Gradle определенного набора правил для объединения настроек, кода и ресурсов, настроенных в ваших типах сборки и вариантах продукта. Хотя вы не настраиваете варианты сборки напрямую, вы настраиваете типы сборок и варианты продуктов, которые их формируют.

Например, в «демо-версии» продукта могут быть указаны определенные функции и требования к устройствам, такие как собственный исходный код, ресурсы и минимальные уровни API, тогда как в типе сборки «отладка» применяются другие параметры сборки и упаковки, такие как параметры отладки и подписывание. ключи. Вариант сборки, который объединяет эти два варианта, представляет собой версию вашего приложения «demoDebug» и включает в себя комбинацию конфигураций и ресурсов, включенных в «демо» вариант продукта, тип сборки «отладка» и main/ исходный набор.

Настройка типов сборки

Вы можете создавать и настраивать типы сборки внутри блока android файла build.gradle.kts на уровне модуля. Когда вы создаете новый модуль, Android Studio автоматически создает типы сборки отладки и выпуска. Хотя тип отладочной сборки не отображается в файле конфигурации сборки, Android Studio настраивает его с помощью debuggable true . Это позволяет отлаживать приложение на защищенных устройствах Android и настраивать подпись приложения с помощью общего хранилища ключей отладки.

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

Котлин 

android {
    defaultConfig {
        manifestPlaceholders["hostName"] = "www.example.com"
        ...
    }
    buildTypes {
        getByName("release") {
            isMinifyEnabled = true
            proguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")
        }

        getByName("debug") {
            applicationIdSuffix = ".debug"
            isDebuggable = true
        }

        /**
         * The `initWith` property lets you copy configurations from other build types,
         * then configure only the settings you want to change. This one copies the debug build
         * type, and then changes the manifest placeholder and application ID.
         */
        create("staging") {
            initWith(getByName("debug"))
            manifestPlaceholders["hostName"] = "internal.example.com"
            applicationIdSuffix = ".debugStaging"
        }
    }
}

классный

android {
    defaultConfig {
        manifestPlaceholders = [hostName:"www.example.com"]
        ...
    }
    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }

        debug {
            applicationIdSuffix ".debug"
            debuggable true
        }

        /**
         * The `initWith` property lets you copy configurations from other build types,
         * then configure only the settings you want to change. This one copies the debug build
         * type, and then changes the manifest placeholder and application ID.
         */
        staging {
            initWith debug
            manifestPlaceholders = [hostName:"internal.example.com"]
            applicationIdSuffix ".debugStaging"
        }
    }
}

Примечание. Когда вы вносите изменения в файл конфигурации сборки, Android Studio требует, чтобы вы синхронизировали проект с новой конфигурацией. Чтобы синхронизировать проект, нажмите «Синхронизировать сейчас» на панели уведомлений, которая появляется при внесении изменений, или нажмите «Синхронизировать проект». с панели инструментов. Если Android Studio обнаружит какие-либо ошибки в вашей конфигурации, появится окно «Сообщения» с описанием проблемы.

Чтобы узнать больше обо всех свойствах, которые можно настроить с помощью типов сборки, прочтите справочник BuildType .

Настройка вкусов продукта

Создание вариантов продукта аналогично созданию типов сборки. Добавьте варианты продукта в блок productFlavors в конфигурации сборки и включите нужные настройки. Варианты продукта поддерживают те же свойства, что и defaultConfig , поскольку defaultConfig фактически принадлежит классу ProductFlavor . Это означает, что вы можете предоставить базовую конфигурацию для всех вариантов в блоке defaultConfig , и каждый вариант может изменить любое из этих значений по умолчанию, например applicationId . Дополнительные сведения об идентификаторе приложения см. в разделе Установка идентификатора приложения .

Примечание. Вам все равно необходимо указать имя пакета, используя атрибут package в файле main/ manifest. Вы также должны использовать это имя пакета в исходном коде для ссылки на класс R или для разрешения любых относительных действий или регистрации службы. Это позволяет вам использовать applicationId чтобы присвоить каждому варианту продукта уникальный идентификатор для упаковки и распространения без необходимости изменять исходный код.

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

  Error: All flavors must now belong to a named flavor dimension.
  The flavor 'flavor_name' is not assigned to a flavor dimension.

Если данный модуль указывает только одно измерение, плагин Android Gradle автоматически назначает все варианты модуля этому измерению.

В следующем примере кода создается измерение варианта с именем «версия» и добавляются «демонстрационный» и «полный» варианты продукта. Эти варианты предоставляют свои собственные applicationIdSuffix и versionNameSuffix :

Котлин 

android {
    ...
    defaultConfig {...}
    buildTypes {
        getByName("debug"){...}
        getByName("release"){...}
    }
    // Specifies one flavor dimension.
    flavorDimensions += "version"
    productFlavors {
        create("demo") {
            // Assigns this product flavor to the "version" flavor dimension.
            // If you are using only one dimension, this property is optional,
            // and the plugin automatically assigns all the module's flavors to
            // that dimension.
            dimension = "version"
            applicationIdSuffix = ".demo"
            versionNameSuffix = "-demo"
        }
        create("full") {
            dimension = "version"
            applicationIdSuffix = ".full"
            versionNameSuffix = "-full"
        }
    }
}

классный

android {
    ...
    defaultConfig {...}
    buildTypes {
        debug{...}
        release{...}
    }
    // Specifies one flavor dimension.
    flavorDimensions "version"
    productFlavors {
        demo {
            // Assigns this product flavor to the "version" flavor dimension.
            // If you are using only one dimension, this property is optional,
            // and the plugin automatically assigns all the module's flavors to
            // that dimension.
            dimension "version"
            applicationIdSuffix ".demo"
            versionNameSuffix "-demo"
        }
        full {
            dimension "version"
            applicationIdSuffix ".full"
            versionNameSuffix "-full"
        }
    }
}

Примечание. Если у вас есть устаревшее приложение (созданное до августа 2021 года), которое вы распространяете с помощью APK-файлов в Google Play, чтобы распространять свое приложение с использованием поддержки нескольких APK-файлов в Google Play, присвойте всем вариантам одно и то же значение applicationId и присвойте каждому варианту свой versionCode . Чтобы распространять разные варианты вашего приложения как отдельные приложения в Google Play, вам необходимо присвоить каждому варианту отдельный applicationId .

После создания и настройки вариантов продукта нажмите «Синхронизировать сейчас» на панели уведомлений. После завершения синхронизации Gradle автоматически создает варианты сборки на основе ваших типов сборки и разновидностей продукта и называет их в соответствии с <product-flavor><Build-Type> . Например, если вы создали «демо-версию» и «полную» версию продукта и сохранили типы сборки «отладка» и «релиз» по умолчанию, Gradle создаст следующие варианты сборки:

  • demoDebug
  • demoRelease
  • fullDebug
  • fullRelease

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

Изменение идентификатора приложения для вариантов сборки

Когда вы создаете APK или AAB для своего приложения, инструменты сборки помечают приложение идентификатором приложения, определенным в блоке defaultConfig из файла build.gradle.kts , как показано в следующем примере. Однако если вы хотите создать разные версии вашего приложения, которые будут отображаться в виде отдельных списков в Google Play Store, например «бесплатную» и «профессиональную» версию, вам необходимо создать отдельные варианты сборки , каждый из которых будет иметь свой идентификатор приложения.

В этом случае определите каждый вариант сборки как отдельный вариант продукта . Для каждого варианта внутри блока productFlavors вы можете переопределить свойство applicationId или вместо этого добавить сегмент к идентификатору приложения по умолчанию, используя applicationIdSuffix , как показано здесь:

Котлин 

android {
    defaultConfig {
        applicationId = "com.example.myapp"
    }
    productFlavors {
        create("free") {
            applicationIdSuffix = ".free"
        }
        create("pro") {
            applicationIdSuffix = ".pro"
        }
    }
}

классный

android {
    defaultConfig {
        applicationId "com.example.myapp"
    }
    productFlavors {
        free {
            applicationIdSuffix ".free"
        }
        pro {
            applicationIdSuffix ".pro"
        }
    }
}

Таким образом, идентификатором приложения для «бесплатного» продукта будет «com.example.myapp.free».

Вы также можете использовать applicationIdSuffix для добавления сегмента на основе вашего типа сборки , как показано здесь:

Котлин 

android {
    ...
    buildTypes {
        getByName("debug") {
            applicationIdSuffix = ".debug"
        }
    }
}

классный

android {
    ...
    buildTypes {
        debug {
            applicationIdSuffix ".debug"
        }
    }
}

Поскольку Gradle применяет конфигурацию типа сборки после версии продукта, идентификатор приложения для варианта сборки «бесплатная отладка» — «com.example.myapp.free.debug». Это полезно, если вы хотите, чтобы отладочная и выпускная сборки находились на одном и том же устройстве, поскольку никакие два приложения не могут иметь одинаковый идентификатор приложения.

Если у вас есть устаревшее приложение (созданное до августа 2021 г.), которое вы распространяете с помощью APK-файлов в Google Play, и вы хотите использовать один и тот же список приложений для распространения нескольких APK-файлов, каждый из которых предназначен для разных конфигураций устройств, например уровня API, тогда вам должен использовать один и тот же идентификатор приложения для каждого варианта сборки, но присваивать каждому APK другой versionCode . Для получения дополнительной информации прочитайте о поддержке нескольких APK . На публикацию с использованием AAB это не влияет, поскольку она использует один артефакт, который по умолчанию использует один код версии и идентификатор приложения.

Совет: Если вам нужно указать идентификатор приложения в файле манифеста, вы можете использовать заполнитель ${applicationId} в любом атрибуте манифеста. Во время сборки Gradle заменяет этот тег фактическим идентификатором приложения. Дополнительные сведения см. в разделе Вставка переменных сборки в манифест .

Объедините несколько вкусов продукта с размерами вкуса

В некоторых случаях вам может потребоваться объединить конфигурации из нескольких вариантов продукта. Например, вы можете захотеть создать разные конфигурации для «полной» и «демонстрационной» версии продукта, основанные на уровне API. Для этого плагин Android Gradle позволяет создавать несколько групп вкусов продукта в качестве измерений вкусов.

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

В следующем примере кода свойство flavorDimensions используется для создания измерения аромата «mode» для группировки «полных» и «демонстрационных» вариантов продукта, а также измерения аромата «api» для группировки конфигураций вариантов продукта на основе уровня API:

Котлин 

android {
  ...
  buildTypes {
    getByName("debug") {...}
    getByName("release") {...}
  }

  // Specifies the flavor dimensions you want to use. The order in which you
  // list the dimensions determines their priority, from highest to lowest,
  // when Gradle merges variant sources and configurations. You must assign
  // each product flavor you configure to one of the flavor dimensions.
  flavorDimensions += listOf("api", "mode")

  productFlavors {
    create("demo") {
      // Assigns this product flavor to the "mode" flavor dimension.
      dimension = "mode"
      ...
    }

    create("full") {
      dimension = "mode"
      ...
    }

    // Configurations in the "api" product flavors override those in "mode"
    // flavors and the defaultConfig block. Gradle determines the priority
    // between flavor dimensions based on the order in which they appear next
    // to the flavorDimensions property, with the first dimension having a higher
    // priority than the second, and so on.
    create("minApi24") {
      dimension = "api"
      minSdk = 24
      // To ensure the target device receives the version of the app with
      // the highest compatible API level, assign version codes in increasing
      // value with API level.
      versionCode = 30000 + (android.defaultConfig.versionCode ?: 0)
      versionNameSuffix = "-minApi24"
      ...
    }

    create("minApi23") {
      dimension = "api"
      minSdk = 23
      versionCode = 20000  + (android.defaultConfig.versionCode ?: 0)
      versionNameSuffix = "-minApi23"
      ...
    }

    create("minApi21") {
      dimension = "api"
      minSdk = 21
      versionCode = 10000  + (android.defaultConfig.versionCode ?: 0)
      versionNameSuffix = "-minApi21"
      ...
    }
  }
}
...

классный

android {
  ...
  buildTypes {
    debug {...}
    release {...}
  }

  // Specifies the flavor dimensions you want to use. The order in which you
  // list the dimensions determines their priority, from highest to lowest,
  // when Gradle merges variant sources and configurations. You must assign
  // each product flavor you configure to one of the flavor dimensions.
  flavorDimensions "api", "mode"

  productFlavors {
    demo {
      // Assigns this product flavor to the "mode" flavor dimension.
      dimension "mode"
      ...
    }

    full {
      dimension "mode"
      ...
    }

    // Configurations in the "api" product flavors override those in "mode"
    // flavors and the defaultConfig block. Gradle determines the priority
    // between flavor dimensions based on the order in which they appear next
    // to the flavorDimensions property, with the first dimension having a higher
    // priority than the second, and so on.
    minApi24 {
      dimension "api"
      minSdkVersion 24
      // To ensure the target device receives the version of the app with
      // the highest compatible API level, assign version codes in increasing
      // value with API level.

      versionCode 30000 + android.defaultConfig.versionCode
      versionNameSuffix "-minApi24"
      ...
    }

    minApi23 {
      dimension "api"
      minSdkVersion 23
      versionCode 20000  + android.defaultConfig.versionCode
      versionNameSuffix "-minApi23"
      ...
    }

    minApi21 {
      dimension "api"
      minSdkVersion 21
      versionCode 10000  + android.defaultConfig.versionCode
      versionNameSuffix "-minApi21"
      ...
    }
  }
}
...

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

Используя предыдущую конфигурацию сборки в качестве примера, Gradle создает в общей сложности 12 вариантов сборки со следующей схемой именования:

  • Вариант сборки: [minApi24, minApi23, minApi21][Demo, Full][Debug, Release]
  • Соответствующий APK: app-[minApi24, minApi23, minApi21]-[demo, full]-[debug, release].apk
    • Например,
    Вариант сборки: minApi24DemoDebug
    Соответствующий APK: app-minApi24-demo-debug.apk

В дополнение к каталогам исходного набора, которые можно создать для каждого отдельного варианта продукта и варианта сборки, вы также можете создавать каталоги исходного набора для каждой комбинации вариантов продукта. Например, вы можете создавать и добавлять исходные коды Java в каталог src/demoMinApi24/java/ , и Gradle использует эти источники только при создании варианта, сочетающего в себе эти два варианта продукта.

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

Фильтровать варианты

Gradle создает вариант сборки для каждой возможной комбинации вариантов продукта и типов сборки, которые вы настраиваете. Однако могут существовать определенные варианты сборки, которые вам не нужны или которые не имеют смысла в контексте вашего проекта. Чтобы удалить определенные конфигурации вариантов сборки, создайте фильтр вариантов в файле build.gradle.kts на уровне модуля.

Используя в качестве примера конфигурацию сборки из предыдущего раздела, предположим, что вы планируете поддерживать только уровни API 23 и выше для демо-версии приложения. Вы можете использовать variantFilter , чтобы отфильтровать все конфигурации вариантов сборки, которые сочетают в себе варианты продукта «minApi21» и «демо»:

Котлин 

android {
  ...
  buildTypes {...}

  flavorDimensions += listOf("api", "mode")
  productFlavors {
    create("demo") {...}
    create("full") {...}
    create("minApi24") {...}
    create("minApi23") {...}
    create("minApi21") {...}
  }
}

androidComponents {
    beforeVariants { variantBuilder ->
        // To check for a certain build type, use variantBuilder.buildType == "<buildType>"
        if (variantBuilder.productFlavors.containsAll(listOf("api" to "minApi21", "mode" to "demo"))) {
            // Gradle ignores any variants that satisfy the conditions above.
            variantBuilder.enable = false
        }
    }
}
...

классный

android {
  ...
  buildTypes {...}

  flavorDimensions "api", "mode"
  productFlavors {
    demo {...}
    full {...}
    minApi24 {...}
    minApi23 {...}
    minApi21 {...}
  }

  variantFilter { variant ->
      def names = variant.flavors*.name
      // To check for a certain build type, use variant.buildType.name == "<buildType>"
      if (names.contains("minApi21") && names.contains("demo")) {
          // Gradle ignores any variants that satisfy the conditions above.
          setIgnore(true)
      }
  }
}
...

После того как вы добавите фильтр вариантов в конфигурацию сборки и нажмете «Синхронизировать сейчас» на панели уведомлений, Gradle проигнорирует любые варианты сборки, соответствующие указанным вами условиям. Варианты сборки больше не отображаются в меню, когда вы нажимаете «Сборка» > «Выбрать вариант сборки» в строке меню или «Варианты сборки». в панели окна инструментов.

Создание исходных наборов

По умолчанию Android Studio создает main/ исходный набор и каталоги для всего, что вы хотите использовать во всех вариантах сборки. Однако вы можете создавать новые наборы исходного кода, чтобы точно контролировать, какие файлы Gradle компилирует и упаковывает для определенных типов сборки, вариантов продукта, комбинаций вариантов продукта (при использовании измерений вариантов ) и вариантов сборки.

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

Gradle ожидает, что файлы и каталоги исходного набора будут организованы определенным образом, аналогично набору main/ source. Например, Gradle ожидает, что файлы классов Kotlin или Java, специфичные для вашего «отладочного» типа сборки, будут расположены в каталогах src/debug/kotlin/ или src/debug/java/ .

Плагин Android Gradle предоставляет полезную задачу Gradle, которая показывает, как организовать файлы для каждого типа сборки, разновидности продукта и варианта сборки. Например, следующий пример выходных данных задачи описывает, где Gradle ожидает найти определенные файлы для типа сборки «отладка»:

------------------------------------------------------------
Project :app
------------------------------------------------------------

...

debug
----
Compile configuration: debugCompile
build.gradle name: android.sourceSets.debug
Java sources: [app/src/debug/java]
Kotlin sources: [app/src/debug/kotlin, app/src/debug/java]
Manifest file: app/src/debug/AndroidManifest.xml
Android resources: [app/src/debug/res]
Assets: [app/src/debug/assets]
AIDL sources: [app/src/debug/aidl]
RenderScript sources: [app/src/debug/rs]
JNI sources: [app/src/debug/jni]
JNI libraries: [app/src/debug/jniLibs]
Java-style resources: [app/src/debug/resources]

Чтобы просмотреть этот вывод, выполните следующие действия:

  1. Нажмите Gradle на панели окна инструментов.

  2. Перейдите в MyApplication > Tasks > android и дважды щелкните sourceSets .

    Чтобы увидеть папку «Задачи» , вы должны позволить Gradle создать список задач во время синхронизации. Для этого выполните следующие действия:

    1. Нажмите «Файл» > «Настройки» > «Экспериментальный» ( Android Studio > «Настройки» > «Экспериментальный» в macOS).
    2. Снимите флажок « Не создавать список задач Gradle во время синхронизации Gradle» .
  3. После того, как Gradle выполнит задачу, откроется окно «Выполнить» для отображения результатов.

Примечание. В выходных данных задачи также показано, как организовать наборы исходных текстов для файлов, которые вы хотите использовать для запуска тестов вашего приложения, например наборы исходных кодов test/ и androidTest/ testing .

Когда вы создаете новый вариант сборки, Android Studio не создает для вас каталоги исходного набора, но дает вам несколько вариантов, которые могут вам помочь. Например, чтобы создать только каталог java/ для вашего типа сборки «отладка»:

  1. Откройте панель «Проект» и выберите представление «Проект» в меню вверху панели.
  2. Перейдите в MyProject/app/src/ .
  3. Щелкните правой кнопкой мыши каталог src и выберите «Создать» > «Каталог» .
  4. В меню «Наборы исходного кода Gradle» выберите «full/java» .
  5. Нажмите Enter .

Android Studio создает каталог исходного набора для вашего типа сборки отладки, а затем создает внутри него каталог java/ . Альтернативно, Android Studio может создать для вас каталоги, когда вы добавляете в проект новый файл для определенного варианта сборки.

Например, чтобы создать XML-файл значений для вашего «отладочного» типа сборки:

  1. На панели «Проект» щелкните правой кнопкой мыши каталог src и выберите «Создать» > «XML» > «XML-файл значений» .
  2. Введите имя XML-файла или оставьте имя по умолчанию.
  3. В меню рядом с Target Source Set выберите debug .
  4. Нажмите «Готово» .

Поскольку в качестве целевого исходного набора был указан тип сборки «отладка», Android Studio автоматически создает необходимые каталоги при создании XML-файла. Результирующая структура каталогов выглядит так, как показано на рисунке 1.

Рисунок 1. Новые каталоги исходного набора для типа сборки «отладка».

Активные наборы источников имеют зеленый индикатор на значке, показывающий, что они активны. К набору debug исходного кода добавляется суффикс [main] , чтобы показать, что он будет объединен с main набором исходного кода.

Используя ту же процедуру, вы также можете создать каталоги исходного набора для разновидностей продукта, таких как src/demo/ , и вариантов сборки, таких как src/demoDebug/ . Кроме того, вы можете создавать наборы исходных кодов для тестирования, ориентированные на определенные варианты сборки, например src/androidTestDemoDebug/ . Чтобы узнать больше, прочитайте о тестировании наборов исходных кодов .

Изменение конфигураций исходного набора по умолчанию

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

Блок sourceSets должен находиться в блоке android . Вам не нужно перемещать исходные файлы; вам нужно только предоставить Gradle путь(и) относительно файла build.gradle.kts на уровне модуля, где Gradle может найти файлы для каждого компонента исходного набора. Чтобы узнать, какие компоненты вы можете настроить и можно ли сопоставить их с несколькими файлами или каталогами, см. Справочник по API плагина Android Gradle .

Следующий пример кода сопоставляет источники из каталога app/other/ с определенными компонентами main набора исходного кода и изменяет корневой каталог набора исходного кода androidTest :

Котлин 

android {
  ...
  // Encapsulates configurations for the main source set.
  sourceSets.getByName("main") {
    // Changes the directory for Java sources. The default directory is
    // 'src/main/java'.
    java.setSrcDirs(listOf("other/java"))

    // If you list multiple directories, Gradle uses all of them to collect
    // sources. Because Gradle gives these directories equal priority, if
    // you define the same resource in more than one directory, you receive an
    // error when merging resources. The default directory is 'src/main/res'.
    res.setSrcDirs(listOf("other/res1", "other/res2"))

    // Note: Avoid specifying a directory that is a parent to one
    // or more other directories you specify. For example, avoid the following:
    // res.srcDirs = ['other/res1', 'other/res1/layouts', 'other/res1/strings']
    // Specify either only the root 'other/res1' directory or only the
    // nested 'other/res1/layouts' and 'other/res1/strings' directories.

    // For each source set, you can specify only one Android manifest.
    // By default, Android Studio creates a manifest for your main source
    // set in the src/main/ directory.
    manifest.srcFile("other/AndroidManifest.xml")
    ...
  }

  // Create additional blocks to configure other source sets.
  sourceSets.getByName("androidTest") {
      // If all the files for a source set are located under a single root
      // directory, you can specify that directory using the setRoot property.
      // When gathering sources for the source set, Gradle looks only in locations
      // relative to the root directory you specify. For example, after applying the
      // configuration below for the androidTest source set, Gradle looks for Java
      // sources only in the src/tests/java/ directory.
      setRoot("src/tests")
      ...
  }
}
...

классный

android {
  ...
  sourceSets {
    // Encapsulates configurations for the main source set.
    main {
      // Changes the directory for Java sources. The default directory is
      // 'src/main/java'.
      java.srcDirs = ['other/java']

      // If you list multiple directories, Gradle uses all of them to collect
      // sources. Because Gradle gives these directories equal priority, if
      // you define the same resource in more than one directory, you receive an
      // error when merging resources. The default directory is 'src/main/res'.
      res.srcDirs = ['other/res1', 'other/res2']

      // Note: Avoid specifying a directory that is a parent to one
      // or more other directories you specify. For example, avoid the following:
      // res.srcDirs = ['other/res1', 'other/res1/layouts', 'other/res1/strings']
      // Specify either only the root 'other/res1' directory or only the
      // nested 'other/res1/layouts' and 'other/res1/strings' directories.

      // For each source set, you can specify only one Android manifest.
      // By default, Android Studio creates a manifest for your main source
      // set in the src/main/ directory.
      manifest.srcFile 'other/AndroidManifest.xml'
      ...
    }

    // Create additional blocks to configure other source sets.
    androidTest {

      // If all the files for a source set are located under a single root
      // directory, you can specify that directory using the setRoot property.
      // When gathering sources for the source set, Gradle looks only in locations
      // relative to the root directory you specify. For example, after applying the
      // configuration below for the androidTest source set, Gradle looks for Java
      // sources only in the src/tests/java/ directory.
      setRoot 'src/tests'
      ...
    }
  }
}
...

Обратите внимание, что исходный каталог может принадлежать только одному исходному набору. Например, вы не можете использовать одни и те же источники тестов для наборов исходных текстов test и androidTest . Это связано с тем, что Android Studio создает отдельные модули IntelliJ для каждого исходного набора и не может поддерживать дублирование корней контента в исходных наборах.

Сборка с использованием исходных наборов

Вы можете использовать каталоги исходного набора для хранения кода и ресурсов, которые вы хотите упаковать только с определенными конфигурациями. Например, если вы создаете вариант сборки «demoDebug», который является перекрестным продуктом варианта продукта «демо» и типа сборки «отладка», Gradle просматривает эти каталоги и присваивает им следующий приоритет:

  1. src/demoDebug/ (набор исходного кода варианта сборки)
  2. src/debug/ (исходный набор типа сборки)
  3. src/demo/ (набор исходных кодов продукта)
  4. src/main/ (основной исходный набор)

Исходные наборы, созданные для комбинаций вкусов продукта, должны включать все измерения вкусов. Например, исходный набор вариантов сборки должен представлять собой комбинацию типа сборки и всех дополнительных измерений. Объединение кода и ресурсов с участием папок, охватывающих несколько, но не все измерения, не поддерживается.

Если вы объединяете несколько вкусов продукта , приоритет между вкусами продуктов определяется измерением вкуса, к которому они принадлежат. При перечислении измерений вкуса с помощью свойства android.flavorDimensions варианты продукта, принадлежащие первому указанному вами измерению вкуса, имеют более высокий приоритет, чем те, которые принадлежат второму измерению вкуса, и так далее. Кроме того, наборы источников, которые вы создаете для комбинаций вариантов продукта, имеют более высокий приоритет, чем наборы источников, принадлежащие отдельным вариантам продукта.

Порядок приоритетов определяет, какой набор исходных кодов имеет более высокий приоритет, когда Gradle объединяет код и ресурсы. Поскольку каталог исходного набора demoDebug/ скорее всего, содержит файлы, специфичные для этого варианта сборки, если demoDebug/ включает файл, который также определен в debug/ , Gradle использует файл в исходном наборе demoDebug/ . Аналогичным образом, Gradle присваивает файлам в типе сборки и исходном коде продукта более высокий приоритет, чем те же файлы в main/ . Gradle учитывает этот порядок приоритетов при применении следующих правил сборки:

  • Весь исходный код в каталогах kotlin/ или java/ компилируется вместе для создания единого вывода.

    Примечание. Для данного варианта сборки Gradle выдает ошибку сборки, если обнаруживает два или более каталогов исходного набора, в которых определен один и тот же класс Kotlin или Java. Например, при создании приложения для отладки вы не можете определить одновременно src/debug/Utility.kt и src/main/Utility.kt , поскольку Gradle просматривает оба этих каталога во время процесса сборки и выдает ошибку «дубликат класса». . Если вам нужны разные версии Utility.kt для разных типов сборок, каждый тип сборки должен определять свою собственную версию файла и не включать ее в main/ исходный набор.

  • Манифесты объединяются в один манифест. Приоритет задается в том же порядке, что и список в предыдущем примере. То есть параметры манифеста для типа сборки переопределяют параметры манифеста для разновидности продукта и т. д. Чтобы узнать больше, прочитайте о слиянии манифестов .
  • Файлы в каталогах values/ объединяются вместе. Если два файла имеют одинаковое имя, например два файла strings.xml , приоритет присваивается в том же порядке, что и список в предыдущем примере. То есть значения, определенные в файле в исходном наборе типа сборки, переопределяют значения, определенные в том же файле в версии продукта, и так далее.
  • Ресурсы в каталогах res/ и asset/ упакованы вместе. Если в двух или более исходных наборах определены ресурсы с одинаковым именем, приоритет присваивается в том же порядке, что и список в предыдущем примере.
  • Gradle придает ресурсам и манифестам, включенным в зависимости модулей библиотеки, самый низкий приоритет при создании приложения.

Объявить зависимости

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

Котлин 

dependencies {
    // Adds the local "mylibrary" module as a dependency to the "free" flavor.
    "freeImplementation"(project(":mylibrary"))

    // Adds a remote binary dependency only for local tests.
    testImplementation("junit:junit:4.12")

    // Adds a remote binary dependency only for the instrumented test APK.
    androidTestImplementation("com.android.support.test.espresso:espresso-core:3.6.1")
}

классный

dependencies {
    // Adds the local "mylibrary" module as a dependency to the "free" flavor.
    freeImplementation project(":mylibrary")

    // Adds a remote binary dependency only for local tests.
    testImplementation 'junit:junit:4.12'

    // Adds a remote binary dependency only for the instrumented test APK.
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.6.1'
}

Дополнительные сведения о настройке зависимостей см. в разделе Добавление зависимостей сборки .

Используйте управление зависимостями с учетом вариантов

Плагин Android Gradle 3.0.0 и выше включает новый механизм зависимостей, который автоматически сопоставляет варианты при использовании библиотеки. Это означает, что вариант debug приложения автоматически использует вариант debug библиотеки и так далее. Это также работает при использовании вариантов: вариант freeDebug приложения будет использовать вариант freeDebug библиотеки.

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

Например, предположим, что ваше приложение настраивает тип сборки, называемый «промежуточный», но одна из его зависимостей библиотеки — нет. Когда плагин попытается создать «промежуточную» версию вашего приложения, он не будет знать, какую версию библиотеки использовать, и вы увидите сообщение об ошибке, подобное следующему: 

Error:Failed to resolve: Could not resolve project :mylibrary.
Required by:
    project :app

Устранение ошибок сборки, связанных с сопоставлением вариантов.

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

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

  • Ваше приложение включает тип сборки, которого нет в зависимости от библиотеки.

    Например, ваше приложение включает в себя «промежуточный» тип сборки, но зависимость включает только типы сборки «отладка» и «выпуск».

    Обратите внимание: проблем не возникает, если зависимость библиотеки включает тип сборки, которого нет в вашем приложении. Это потому, что плагин никогда не запрашивает этот тип сборки из зависимости.

    Используйте matchingFallbacks , чтобы указать альтернативные совпадения для данного типа сборки, как показано здесь:

    Котлин 

    // In the app's build.gradle.kts file.
android {
    buildTypes {
        getByName("debug") {}
        getByName("release") {}
        create("staging") {
            // Specifies a sorted list of fallback build types that the
            // plugin can try to use when a dependency does not include a
            // "staging" build type. You may specify as many fallbacks as you
            // like, and the plugin selects the first build type that's
            // available in the dependency.
            matchingFallbacks += listOf("debug", "qa", "release")
        }
    }
}

    классный

    // In the app's build.gradle file.
android {
    buildTypes {
        debug {}
        release {}
        staging {
            // Specifies a sorted list of fallback build types that the
            // plugin can try to use when a dependency does not include a
            // "staging" build type. You may specify as many fallbacks as you
            // like, and the plugin selects the first build type that's
            // available in the dependency.
            matchingFallbacks = ['debug', 'qa', 'release']
        }
    }
}

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

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

    Обратите внимание, что для данного измерения разновидности, которое существует как в приложении, так и в зависимостях его библиотеки, не возникает проблем, если библиотека включает в себя вариант продукта, которого нет в вашем приложении. Это потому, что плагин никогда не запрашивает этот вариант из зависимости.

    Используйте matchingFallbacks , чтобы указать альтернативные совпадения для «бесплатного» продукта приложения, как показано здесь:

    Котлин 

    // In the app's build.gradle.kts file.
android {
    defaultConfig{
    // Don't configure matchingFallbacks in the defaultConfig block.
    // Instead, specify fallbacks for a given product flavor in the
    // productFlavors block, as shown below.
  }
    flavorDimensions += "tier"
    productFlavors {
        create("paid") {
            dimension = "tier"
            // Because the dependency already includes a "paid" flavor in its
            // "tier" dimension, you don't need to provide a list of fallbacks
            // for the "paid" flavor.
        }
        create("free") {
            dimension = "tier"
            // Specifies a sorted list of fallback flavors that the plugin
            // can try to use when a dependency's matching dimension does
            // not include a "free" flavor. Specify as many
            // fallbacks as you like; the plugin selects the first flavor
            // that's available in the dependency's "tier" dimension.
            matchingFallbacks += listOf("demo", "trial")
        }
    }
}

    классный

    // In the app's build.gradle file.
android {
    defaultConfig{
    // Don't configure matchingFallbacks in the defaultConfig block.
    // Instead, specify fallbacks for a given product flavor in the
    // productFlavors block, as shown below.
  }
    flavorDimensions 'tier'
    productFlavors {
        paid {
            dimension 'tier'
            // Because the dependency already includes a "paid" flavor in its
            // "tier" dimension, you don't need to provide a list of fallbacks
            // for the "paid" flavor.
        }
        free {
            dimension 'tier'
            // Specifies a sorted list of fallback flavors that the plugin
            // can try to use when a dependency's matching dimension does
            // not include a "free" flavor. Specify as many
            // fallbacks as you like; the plugin selects the first flavor
            // that's available in the dependency's "tier" dimension.
            matchingFallbacks = ['demo', 'trial']
        }
    }
}

  • Зависимость библиотеки включает в себя измерение вкуса, которого нет в вашем приложении.

    Например, зависимость библиотеки включает варианты для измерения «minApi», но ваше приложение включает варианты только для измерения «уровень». Когда вы хотите создать версию своего приложения «freeDebug», плагин не знает, использовать ли версию зависимости «minApi23Debug» или «minApi18Debug».

    Обратите внимание: если ваше приложение включает в себя измерение вкуса, которого нет в зависимости от библиотеки, проблем не возникает. Это связано с тем, что плагин соответствует вариантам только тех измерений, которые существуют в зависимости. Например, если зависимость не включает измерение для ABI, версия вашего приложения «freeX86Debug» будет использовать версию зависимости «freeDebug».

    Используйте missingDimensionStrategy в блоке defaultConfig , чтобы указать вариант по умолчанию, который плагин будет выбирать из каждого отсутствующего измерения, как показано в следующем примере. Вы также можете переопределить свой выбор в блоке productFlavors , чтобы для каждого варианта можно было указать другую стратегию сопоставления для отсутствующего измерения.

    Котлин 

    // In the app's build.gradle.kts file.
android {
    defaultConfig{
    // Specifies a sorted list of flavors that the plugin can try to use from
    // a given dimension. This tells the plugin to select the "minApi18" flavor
    // when encountering a dependency that includes a "minApi" dimension.
    // You can include additional flavor names to provide a
    // sorted list of fallbacks for the dimension.
    missingDimensionStrategy("minApi", "minApi18", "minApi23")
    // Specify a missingDimensionStrategy property for each
    // dimension that exists in a local dependency but not in your app.
    missingDimensionStrategy("abi", "x86", "arm64")
    }
    flavorDimensions += "tier"
    productFlavors {
        create("free") {
            dimension = "tier"
            // You can override the default selection at the product flavor
            // level by configuring another missingDimensionStrategy property
            // for the "minApi" dimension.
            missingDimensionStrategy("minApi", "minApi23", "minApi18")
        }
        create("paid") {}
    }
}

    классный

    // In the app's build.gradle file.
android {
    defaultConfig{
    // Specifies a sorted list of flavors that the plugin can try to use from
    // a given dimension. This tells the plugin to select the "minApi18" flavor
    // when encountering a dependency that includes a "minApi" dimension.
    // You can include additional flavor names to provide a
    // sorted list of fallbacks for the dimension.
    missingDimensionStrategy 'minApi', 'minApi18', 'minApi23'
    // Specify a missingDimensionStrategy property for each
    // dimension that exists in a local dependency but not in your app.
    missingDimensionStrategy 'abi', 'x86', 'arm64'
    }
    flavorDimensions 'tier'
    productFlavors {
        free {
            dimension 'tier'
            // You can override the default selection at the product flavor
            // level by configuring another missingDimensionStrategy property
            // for the 'minApi' dimension.
            missingDimensionStrategy 'minApi', 'minApi23', 'minApi18'
        }
        paid {}
    }
}

Дополнительные сведения см. в matchingFallbacks и missingDimensionStrategy в справочнике по DSL подключаемого модуля Android Gradle.

Настройка параметров подписи

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

Чтобы вручную настроить конфигурации подписи для вашего типа сборки выпуска с помощью конфигураций сборки Gradle:

  1. Создайте хранилище ключей. Хранилище ключей — это двоичный файл, содержащий набор закрытых ключей. Вы должны хранить хранилище ключей в безопасном и надежном месте.
  2. Создайте закрытый ключ. Закрытый ключ используется для подписи вашего приложения для распространения и никогда не включается в приложение и не передается неавторизованным третьим лицам.

  3. Добавьте конфигурацию подписи в файл build.gradle.kts на уровне модуля:

    Котлин 

    ...
android {
    ...
    defaultConfig {...}
    signingConfigs {
        create("release") {
            storeFile = file("myreleasekey.keystore")
            storePassword = "password"
            keyAlias = "MyReleaseKey"
            keyPassword = "password"
        }
    }
    buildTypes {
        getByName("release") {
            ...
            signingConfig = signingConfigs.getByName("release")
        }
    }
}

    классный 

    ...
android {
    ...
    defaultConfig {...}
    signingConfigs {
        release {
            storeFile file("myreleasekey.keystore")
            storePassword "password"
            keyAlias "MyReleaseKey"
            keyPassword "password"
        }
    }
    buildTypes {
        release {
            ...
            signingConfig signingConfigs.release
        }
    }
}

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

Чтобы получить эти пароли из переменных среды:

Котлин 

storePassword = System.getenv("KSTOREPWD")
keyPassword = System.getenv("KEYPWD")

классный

storePassword System.getenv("KSTOREPWD")
keyPassword System.getenv("KEYPWD")

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

После завершения этого процесса вы сможете распространять свое приложение и публиковать его в Google Play.

Предупреждение. Храните хранилище ключей и закрытый ключ в безопасном и надежном месте и убедитесь, что у вас есть их надежные резервные копии. Если вы используете подписывание приложений Play и потеряли ключ загрузки, вы можете запросить сброс с помощью Play Console. Если вы публикуете приложение без подписи приложения Play (для приложений, созданных до августа 2021 г.) и теряете ключ подписи приложения, вы не сможете публиковать какие-либо обновления своего приложения, поскольку вы всегда должны подписывать все версии своего приложения с помощью тот же ключ.

Подписание приложений Wear OS

При публикации приложений Wear OS APK-файл часов и дополнительный APK-файл телефона должны быть подписаны одним и тем же ключом. Дополнительные сведения об упаковке и подписании приложений Wear OS см. в разделе Упаковка и распространение приложений Wear .