Gradle

Задаёт версии для библиотек, чтобы их можно было ссылаться по имени.

[versions]
agp = "8.7.2"
kotlin = "2.0.21"
androidx-activity = "1.9.3"
androidx-collection = "1.4.5"

Создаёт алиасы для зависимостей с указанием версии из [versions] или напрямую.

[libraries]
kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
androidx-activity-compose = { module = "androidx.activity:activity-compose", version.ref = "androidx-activity" }
androidx-collection = { module = "androidx.collection:collection", version.ref = "androidx-collection" }

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

[bundles]
androidx = ["androidx-activity-compose", "androidx-collection"]

Определяет плагины с их ID и версией, чтобы подключать их централизованно.

[plugins]
android-application = { id = "com.android.application", version.ref = "agp" }
android-library = { id = "com.android.library", version.ref = "agp" }
kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }

Подключаются плагины необходимые для проекта.

• apply false означает, что плагины не будут автоматически применены ко всему проекту, но они будут доступны для применения в каждом модуле. Это помогает избежать конфликта версий плагинов и позволяет лучше контролировать, где именно используются плагины.

plugins {
    alias(libs.plugins.android.application) apply false
    alias(libs.plugins.android.library) apply false
    alias(libs.plugins.kotlin.android) apply false
    alias(libs.plugins.kotlin.serialization) apply false
    alias(libs.plugins.kotlin.parcelize) apply false
    alias(libs.plugins.kotlin.compose) apply false
}

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

allprojects {
    ...
}

Позволяет задать настройки, которые применяются ко всем модулям.

subprojects {
    ...
}

Подключает необходимые плагины.

plugins {
    alias(libs.plugins.android.library)
    alias(libs.plugins.google.ksp)
    alias(libs.plugins.kotlin.serialization)
    alias(libs.plugins.kotlin.parcelize)
    alias(libs.plugins.kotlin.android)
    alias(libs.plugins.kotlin.compose)
}

Используется для настройки параметров компилятора Kotlin на уровне модуля.

kotlin {
    ...
}

kotlin {
    jvmToolchain(17)
}

Содержит конфигурации, специфичные для Android.

android {
    namespace = "org.michaelbel.app"
    compileSdk = 35

    defaultConfig {}

    buildFeatures {}
    
    kotlinOptions {}
    
    compileOptions {}
    
    buildTypes {}
    
    signingConfigs {}
}

android {
    namespace = "org.michaelbel.app"
}

android {
    compileSdk = 35
}

android {
    defaultConfig {
        applicationId = "org.michaelbel.app"
        minSdk = 21
        targetSdk = 35
        versionCode = 1
        versionName = "1.0.0"
        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
    }
}

android {
    buildFeatures {
        resValues = true
        shaders = false
        aidl = false
        renderScript = false
        buildConfig = true
        compose = true
    }
}

android {
    kotlinOptions {
        jvmTarget = "1.8"
        freeCompilerArgs = freeCompilerArgs + listOf(
		        "-Xopt-in=kotlin.RequiresOptIn",
            "-Xjvm-default=all",
		        "-opt-in=androidx.compose.material3.ExperimentalMaterial3Api"
		    )
        allWarningsAsErrors = true
        apiVersion = "1.5"
        languageVersion = "1.5"
    }
}

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_11
        targetCompatibility = JavaVersion.VERSION_11
        encoding = "UTF-8"
    }
}

android {
    buildTypes {
        debug {
            applicationIdSuffix = ".debug"
            versionNameSuffix = ".debug"
            isMinifyEnabled = false
            isShrinkResources = false
            isDebuggable = true
        }
        release {
            isMinifyEnabled = true
            isShrinkResources = true
            isDebuggable = false
            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
            signingConfig = signingConfigs.getByName("release")
        }
        create("qa") {
            initWith(buildTypes.getByName("release"))
        }
    }
}

android {
    signingConfigs {
        create("release") {
            storeFile = file("path/to/your/keystore.jks")
            storePassword = "storePassword"
            keyAlias = "yourKeyAlias"
            keyPassword = "keyPassword"
        }
    }
}

Определяет зависимости, необходимые для работы модуля.

• implementation зависимость доступна только в текущем модуле.

• api зависимость передаётся в модули, которые зависят от текущего.

• compileOnly зависимость доступна при компиляции, но не включается в APK.

• runtimeOnly зависимость добавляется только в рантайм, без компиляции.

• kapt используется для Java-аннотаций.

• ksp генерирует код напрямую, не создавая Java-байткод.

dependencies {
    implementation(project(":core"))
    api(libs.androidx.appcompat)
}

dependencies {
    implementation("com.example:library:1.0") {
        exclude(group = "com.unwanted", module = "unnecessary-lib") // Исключает модуль
        exclude(group = "com.unwanted") // Исключает всю группу
    }
}

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

base {
    archivesName.set("Mobile-Template-v${android.defaultConfig.versionName}(${android.defaultConfig.versionCode})")
}

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

pluginManagement {
    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
    }
}

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

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}

Позволяет указать, какие модули включены в сборку.

include(":app", ":library", ":feature_module")

Определяет имя корневого проекта.

rootProject.name = "MyApp"

Параметры JVM для процесса Gradle.

• Xmx8192m задаёт максимальный размер кучи памяти JVM, которую может использовать Gradle, равный 8192 МБ (8 ГБ).

• Dfile.encoding=UTF-8 устанавливает кодировку файлов, используемую JVM, в UTF-8.

org.gradle.jvmargs=-Xmx8192m -Dfile.encoding=UTF-8

Позволяет использовать Gradle Daemon, который ускоряет повторные сборки за счёт использования демона в фоне.

org.gradle.daemon=true

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

org.gradle.parallel=true

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

org.gradle.configureondemand=true

Включает кэширование задач Gradle для более быстрой сборки.

org.gradle.caching=true

Выводит все предупреждения Gradle, что полезно для отладки проблем.

org.gradle.warning.mode=all

Задаёт уровень логирования для вывода в консоль.

org.gradle.logging.level=info

Переводит проект на AndroidX, чтобы использовать новые библиотеки поддержки.

android.useAndroidX=true

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

android.enableJetifier=true

Включает использование R8 для обфускации и минимизации кода. R8 — это замена ProGuard, которая является более производительной.

android.enableR8=true

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

android.enableBuildCache=true

Управляют включением и отключением различных функций сборки в Android Gradle Plugin.

• resValues отключает генерацию значений ресурсов.

android.defaults.buildFeatures.resValues=false

• shaders отключает обработку шейдеров GLSL в проекте.

android.defaults.buildFeatures.shaders=false

• aidl отключает поддержку AIDL.

android.defaults.buildFeatures.aidl=false

• renderscript отключает поддержку RenderScript, который используется для вычислений и обработки изображений.

android.defaults.buildFeatures.renderscript=false

• viewBinding включает ViewBinding, который генерирует привязки для каждого layout-файла.

android.defaults.buildFeatures.viewBinding=true

• dataBinding отключает DataBinding, который позволяет связывать данные в XML-файлах с логикой в Kotlin или Java.

android.defaults.buildFeatures.dataBinding=false

Используется как индикатор того, что проект собирается на CI/CD. Может влиять на логику сборки.

CI=true

Определяет основное местоположение, где будет храниться загруженный дистрибутив Gradle (файл .zip), необходимый для работы Gradle Wrapper.

distributionBase=GRADLE_USER_HOME

Определяет URL для загрузки конкретной версии Gradle. Здесь можно указать стабильную версию, nightly-сборку или версию из канала предварительных релизов.

distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip

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

distributionPath=wrapper/dists

Определяет путь, где сохраняются файлы Gradle после загрузки.

zipStorePath=wrapper/dists

Определяет местоположение, где будет храниться уже распакованный архив с дистрибутивом Gradle.

zipStoreBase=GRADLE_USER_HOME

Указывает путь к Android SDK на локальной машине. Gradle использует это значение для поиска и работы с SDK, поэтому этот параметр обязателен для сборки Android-проектов.

sdk.dir=/Users/michaelbel/Library/Android/sdk

Указывает путь к Android NDK, если проект использует нативный код на C/C++. Это позволяет Gradle находить NDK и использовать его для сборки нативных библиотек.

ndk.dir=/Users/username/Library/Android/ndk

Задаёт путь к CMake, если проект использует сборку нативного кода с помощью CMake. Указание пути к CMake позволяет Gradle использовать правильную версию.

cmake.dir=/Users/username/Library/Android/cmake

Строка, показывающая тип сборки, например, debug или release.

val buildType = BuildConfig.BUILD_TYPE

Логическое значение, которое указывает, выполняется ли приложение в режиме отладки (для сборок debug это true, для release — false).

val isDebug = BuildConfig.DEBUG

Целочисленное значение, представляющее версию сборки.

val versionCode = BuildConfig.VERSION_CODE

Строковое значение, представляющее версию приложения (например, «1.0»).

val versionName = BuildConfig.VERSION_NAME

Уникальный идентификатор пакета приложения, определённый в файле build.gradle. Используется для идентификации приложения в системе Android.

val appId = BuildConfig.APPLICATION_ID

• В модуль build.gradle.kts добавить:

android {
    defaultConfig {
        buildConfigField("String", "API_URL", "\"https://api.example.com\"")
    }
    
    buildFeatures {
        buildConfig = true
    }
}

• Использовать в коде:

val apiUrl = BuildConfig.API_URL

• Пример использования параметров из local.properties или из GitHub Secrets variables (для CI):

# Переменная в файле local.properties
API_KEY=8j9f-3c3d-490eh-f9j3-kfk9

import com.android.build.gradle.internal.cxx.configure.gradleLocalProperties

private val apiKey: String by lazy {
    gradleLocalProperties(rootDir, providers).getProperty("API_KEY").orEmpty().ifEmpty { System.getenv("API_KEY").orEmpty() }
}

android {
    defaultConfig {
        buildConfigField("String", "API_KEY", "\"$apiKey\"")
    }

    buildFeatures {
        buildConfig = true
    }
}

./gradlew build --warning-mode=all

Выводит список всех зависимостей проекта, их версии и зависимости внутри модулей, а также разрешённые и транзитивные зависимости. Это помогает увидеть полную структуру иерархии зависимостей проекта и выявить возможные конфликты версий.

./gradlew dependencies

Генерирует отчет о ключах подписи приложения, включая отпечатки (SHA-1 и SHA-256) для всех buildType и flavor. Эти отпечатки часто требуются для интеграции с сервисами, такими как Firebase или Google API, чтобы обеспечить аутентификацию приложений.

./gradlew signinReport

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

./gradlew tasks

Запускает анализ кода (Lint) в Android-проекте. Lint проверяет код на наличие потенциальных ошибок, проблем с производительностью, нарушений стиля, возможных утечек памяти и других проблем. Результаты анализа выводятся в виде отчёта, что помогает улучшить качество кода и следовать лучшим практикам.

./gradlew lint

Cобирает APK для debug-сборки приложения. Эта сборка предназначена для тестирования и отладки, поэтому она включает отладочную информацию и не подписана релизным ключом. Сгенерированный APK находится в папке build/outputs/apk/debug и может быть установлен на устройство для тестирования.

./gradlew assembleDebug

Cобирает release-сборку APK. Эта сборка оптимизирована для выпуска: она может быть обфусцирована, сжата и подписана релизным ключом (если настроено). Release-версия APK находится в папке build/outputs/apk/release и готова для распространения, например, через Google Play или другие магазины приложений.

./gradlew assembleRelease

Cобирает и устанавливает debug-сборку APK на подключённое устройство или эмулятор. Эта версия приложения включает отладочную информацию и позволяет быстро тестировать последние изменения. APK автоматически устанавливается и запускается на устройстве, если это предусмотрено настройками.

./gradlew installDebug

Cобирает и устанавливает release-сборку APK на подключённое устройство или эмулятор. Эта версия оптимизирована для выпуска, без отладочной информации. Поскольку это release-сборка, её установка возможна только при наличии подходящего ключа подписи или если устройство позволяет установку неподписанных APK для тестирования.

./gradlew installRelease

Отображает текущую версию установленной Java.

java -version

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

printenv

Устанавливает переменную окружения JAVA_HOME для текущей сессии терминала.

• Переменная среды хранится в /usr/libexec/java_home. Там указана последняя версия Java.

• Чтобы последней была 17 нужно удалить новые версии в Library/Java/JavaVirtualMachines.

export JAVA_HOME="/Users/mihailbelyj/Library/Java/JavaVirtualMachines/corretto-17.0.10/Contents/Home"