Варианты издания позволяют создавать более персонализированный контент для пользователей. Настройка вариантов публикации позволяет публиковать разные варианты сборки, каждый из которых имеет свои атрибуты.
Публикация нескольких вариантов сборки библиотеки позволяет пользователям выбирать функции, которые им нужны. Например, вы можете опубликовать разные объекты для отладочной и конечной сборок. В отладочной версии может быть дополнительный код для ведения журнала и другие зависимости, необходимые для этого.
Прежде чем продолжить, подготовьте библиотеку к выпуску.
Использовать метаданные модуля Gradle
Чтобы опубликовать варианты библиотеки, используйте метаданные модуля Gradle (GMM). GMM описывает вашу публикацию и поддерживает управление зависимостями с учетом вариантов. По умолчанию GMM публикуется вместе с библиотекой.
Преимущества использования GMM:
- Если вы используете GMM с Gradle 6.0 или более поздней версии, вы можете публиковать несколько вариантов публикации или несколько артефактов, каждый со своими атрибутами и зависимостями. Если вы используете файл POM Maven вместо GMM, то можете опубликовать только один артефакт. Если вы используете файл POM, то можете публиковать дополнительные артефакты с помощью классификаторов, но у этих артефактов не может быть собственных зависимостей.
- Gradle автоматически создает один вариант для компиляции и один для среды выполнения, каждый со своими зависимостями. Вы можете опубликовать один вариант для компиляции и один для среды выполнения, чтобы потребитель мог выбрать его в зависимости от того, когда он использует вашу библиотеку. GMM позволяет пользователям видеть разные зависимости для компиляции и выполнения в зависимости от того, как опубликованная библиотека использует
api,implementationилиcompileOnly/runtimeOnly. Полный список зависимостей приведен в разделе Конфигурации зависимостей. Это возможно, даже если вы публикуете только один вариант. - При использовании тестовых фикстур вы можете опубликовать дополнительный вариант со специальными метаданными или возможностями, которые позволят потребителю выбрать его. Это доступно, даже если вы публикуете один вариант.
Что такое варианты издания
Чтобы понять, как работают варианты публикации, полезно ознакомиться с основными этапами публикации Gradle. Вот некоторые ключевые понятия, связанные с публикацией:
- Вариант сборки. Конфигурация, которую Gradle использует для сборки библиотеки. Представляет собой декартово произведение типа сборки и версии продукта. Подробнее о сборках Android…
- Артефакт. Файл или каталог, созданный в результате сборки. В контексте публикации библиотек артефакт – это обычно файл JAR или AAR.
- Вариант публикации. Артефакт со связанными атрибутами, функциями и зависимостями. Обратите внимание, что в Gradle варианты публикации называются вариантами. Однако в этой документации они называются вариантами публикации, чтобы их можно было отличить от вариантов сборки.
- Атрибут. Gradle использует атрибуты, чтобы идентифицировать и выбирать варианты публикации, если их несколько. Например, атрибуты "цвет"
org.gradle.usage=java-apiи "размер"org.gradle.jvm.version=11. - Компонент ПО. Объект Gradle, который может содержать один или несколько вариантов публикации и публикуется в одном наборе координат Maven (
groupId:artifactId:version). Он представлен в DSL Gradle черезProject.getComponents(). - Публикация – то, что публикуется в хранилище и используется потребителями. Публикации состоят из одного программного компонента и его метаданных, например идентификатора (
groupId:artifactId:version).
В плагине Android Gradle (AGP) 7.1 появился предметно-ориентированный язык (DSL), позволяющий управлять тем, какие варианты сборки используются при публикации, а какие игнорируются. DSL позволяет создавать экземпляры SoftwareComponent, которые содержат:
- Один вариант публикации из одного варианта сборки
- Несколько вариантов публикации из нескольких вариантов сборки
При создании программного компонента с несколькими вариантами публикации AGP настраивает атрибуты для каждого варианта, которые позволяют потребителю выбрать подходящий вариант, который ему нужен. Эти атрибуты берутся непосредственно из типа сборки и разновидностей, используемых для создания варианта сборки. Если у компонента только один вариант публикации, атрибуты не нужны, так как нет необходимости различать варианты.
Создание компонента программного обеспечения с одним вариантом публикации
В следующем фрагменте кода настраивается компонент ПО с одним вариантом публикации, созданным на основе варианта сборки release, и добавляется исходный JAR-файл в качестве дополнительного артефакта:
Kotlin
android { publishing { singleVariant("release") { withSourcesJar() } } }
Яркий
android { publishing { singleVariant('release') { withSourcesJar() } } }
Вы можете создать несколько компонентов, каждый из которых будет содержать один вариант публикации, и распространять их по разным координатам Maven. В этом случае атрибуты не задаются для варианта публикации. По метаданным публикации нельзя определить, что этот вариант публикации относится к варианту сборки release. Поскольку в этом случае используется только один вариант публикации, нет необходимости в устранении неоднозначности.
Создание компонента программного обеспечения с несколькими вариантами публикации
Вы можете выбрать все или некоторые варианты сборки, чтобы поместить их в один программный компонент. AGP автоматически использует названия типов сборки, версий продукта и групп вариантов для создания атрибутов, чтобы проект-потребитель мог их различать.
Чтобы опубликовать все варианты сборки в одном компоненте, укажите allVariants() в блоке multipleVariants{} в файле build.gradle на уровне модуля:
Kotlin
android { publishing { multipleVariants { allVariants() withJavadocJar() } } }
Яркий
android { publishing { multipleVariants { allVariants() withJavadocJar() } } }
Будет создан один компонент с названием default. Чтобы задать другое название, используйте multipleVariants({name}).
В этом случае все типы сборки и группы вариантов используются как атрибуты.
Вы также можете выбрать, какие варианты будут опубликованы, с помощью includeBuildTypeValues() и includeFlavorDimensionAndValues():
Kotlin
android { publishing { multipleVariants("custom") { includeBuildTypeValues("debug", "release") includeFlavorDimensionAndValues( dimension = "color", values = arrayOf("blue", "pink") ) includeFlavorDimensionAndValues( dimension = "shape", values = arrayOf("square") ) } } }
Яркий
android { publishing { multipleVariants('custom') { includeBuildTypeValues('debug', 'release') includeFlavorDimensionAndValues( /*dimension =*/ 'color', /*values =*/ 'blue', 'pink' ) includeFlavorDimensionAndValues( /*dimension =*/ 'shape', /*values =*/ 'square' ) } } }
В этом примере специальный компонент содержит все комбинации (debug, release) для типа сборки, (blue, pink) для параметра color и (square) для параметра shape .
Необходимо указать все группы вариантов, даже если вы публикуете только одно значение из группы. Это нужно, чтобы AGP знал, какое значение использовать для каждой группы.
В таблице ниже перечислены варианты публикации и связанные с ними атрибуты.
| Вариант | Атрибуты |
|---|---|
blueSquareDebug | com.android.build.api.attributes.BuildTypeAttr="debug"
com.android.build.api.attributes.ProductFlavorAttr:color="blue" |
blueSquareRelease |
com.android.build.api.attributes.BuildTypeAttr="release"
|
pinkSquareDebug |
com.android.build.api.attributes.BuildTypeAttr="debug"
|
pinkSquareRelease |
com.android.build.api.attributes.BuildTypeAttr="release"
|
На практике публикуется больше вариантов. Например, каждый из предыдущих вариантов публикуется дважды: один раз для компиляции и один раз для выполнения, с разными зависимостями (в зависимости от того, используют ли объявленные зависимости implementation или api) и с разным значением атрибута org.gradle.Usage. Однако артефакты (файл AAR) для этих двух вариантов одинаковы.
Подробную информацию вы найдете в документации по API publishing.
Проблема совместимости при публикации библиотек с несколькими вариантами
Проект, в котором используется AGP 7.0 или более ранней версии, не может использовать библиотеки с несколькими вариантами, опубликованные с помощью AGP 7.1 или более поздней версии. Это известная проблема, вызванная изменением названия атрибута для группы вариантов продукта с dimensionName на com.android.build.api.attributes.ProductFlavor:dimensionName в AGP 7.1.
В зависимости от настроек проекта вы можете использовать missingDimensionStrategy в более ранней версии API, чтобы обойти эту проблему.
Например, предположим, что в вашем проекте приложения есть только группа вариантов версии продукта:
Kotlin
android {
applicationVariants.forEach { variant ->
val flavor = variant.productFlavors[0].name
val attributePrefix = "com.android.build.api.attributes.ProductFlavor"
val dimensionName = "version"
variant.missingDimensionStrategy("$attributePrefix:$dimensionName", flavor)
}
}
Яркий
android {
applicationVariants.forEach { variant ->
def flavor = variant.getProductFlavors()[0].name
def attributePrefix = "com.android.build.api.attributes.ProductFlavor"
def dimensionName = "version"
variant.missingDimensionStrategy("$attributePrefix:$dimensionName", flavor)
}
}