Проекты Android содержат множество файлов, связанных со сборкой, и структур каталогов для организации исходного кода и ресурсов приложения. Прежде чем перейти к деталям, давайте рассмотрим общую структуру и основные элементы каждой части.
В таблице ниже перечислены типичные файлы в проекте Android. Описания каждого файла или каталога включают примечания о том, какой тип контента там находится. Рекомендации со временем меняются, и эти описания могут не соответствовать проекту, который вы унаследовали или скачали из интернета.
При написании файлов сборки используйте декларативный подход. Логика сборки и определения задач должны появляться только в плагинах. Если ограничить логику сборки плагинами, файлы сборки станут объявлениями данных, которые проще понимать и редактировать. В будущих версиях может появиться альтернативная спецификация, например Declarative Gradle, которая не позволит использовать логику сборки в файлах.
Папка/файл |
Использовать |
|---|---|
.gradle/ |
Каталог кеша проекта Gradle Управляется Gradle и содержит скачанный дистрибутив Gradle, кеш проекта и файлы конфигурации. Не изменяйте файлы в этом каталоге. |
.idea/ |
Метаданные проекта Android Studio Не изменяйте файлы в этом каталоге. |
build.gradle(.kts) |
Должен содержать только объявления плагинов, чтобы настроить общий путь к классам плагинов в подпроектах. Другой код должен находиться в файлах сборки на уровне настроек или вложенного проекта. |
gradle.properties |
Конфигурация выполнения Gradle Содержит свойства Gradle, управляющие аспектами среды сборки Gradle, такими как размер кучи, кэширование и параллельное выполнение. Здесь определены некоторые временные свойства Android, чтобы уменьшить изменения в AGP DSL по мере их добавления и последующего удаления. |
gradlew (Linux, Mac) gradlew.bat (Windows) |
Файл Gradle wrapper Запускает сборку, скачивая дистрибутив Gradle и перенаправляя ему команды. Это позволяет запускать сборки без предварительной установки Gradle. |
local.properties |
Конфигурация локального компьютера Содержит свойства, связанные с локальным компьютером, например местоположение Android SDK. Исключите этот файл из системы управления версиями. |
settings.gradle(.kts) |
Содержит глобальную информацию о сборке для инициализации Gradle и конфигурации проекта, например
|
gradle/ |
|
↳ libs.versions.toml |
Определяет переменные для зависимостей и плагинов, используемых в сборке. Здесь вы указываете, какие версии хотите использовать, обеспечивая согласованность во всех подпроектах вашего проекта. |
↳ wrapper/ |
|
↳ gradle‑wrapper.jar |
Исполняемый файл Gradle bootstrapping Скачивает указанный дистрибутив Gradle (если он не существует) и запускает его, передавая аргументы. |
↳ gradle‑wrapper.properties |
Настройка Gradle Wrapper Указывает, откуда скачивать дистрибутив Gradle (включая версию). |
app/ |
Подпроекты (в Android Studio они называются модулями) могут создавать приложения или библиотеки и зависеть от других подпроектов или внешних зависимостей.
|
↳ build.gradle(.kts) |
Файл сборки на уровне подпроекта Определяет, как создать этот подпроект. Для каждого подпроекта требуется отдельный файл сборки, который должен содержать
Не включайте в файлы сборки логику сборки (например, определения функций Kotlin или условия) или объявления задач. Логика и задачи сборки должны содержаться только в плагинах. |
↳ src/ |
Исходные файлы подпроектов Группирует исходные файлы (код приложения и ресурсы) в наборы исходных файлов. Набор исходных файлов |
↳ main/ |
Основной набор исходных файлов Исходный код и ресурсы, общие для всех вариантов сборки. Этот набор является базовым для всех сборок, а другие, более специфические наборы исходных файлов дополняют или переопределяют его. |
↳ java/ ↳ kotlin/ |
Исходный код Kotlin и Java Каталог |
↳ res/ |
Содержит ресурсы приложения, например XML-файлы и изображения. Все приложения используют некоторые базовые ресурсы, такие как значки приложения, но многие из этих ресурсов, такие как макеты и меню, используются только в приложениях на основе представлений. Приложения Compose используют ресурсы String, определенные в этом каталоге. |
↳ AndroidManifest.xml |
Метаданные приложения для Android Считывается менеджером пакетов Android, чтобы сообщить системе,
|
↳ androidTest/ |
Набор исходных файлов для тестирования на устройстве Содержит исходный код тестов, которые будут выполняться на устройстве или эмуляторе Android. Они имеют доступ к реальной среде Android, но выполняются медленнее, чем тесты хоста. |
↳ test/ |
Набор исходных файлов Host test Содержит исходный код для тестов, которые выполняются локально в JVM, а не на устройстве. Такие тесты выполняются гораздо быстрее, чем тесты на устройствах. Однако все системные вызовы (включая жизненные циклы, в которых выполняется приложение) должны быть смоделированы, сымитированы или заменены заглушками. Все исходные файлы в наборе |
↳ proguard-rules.pro |
Определяет правила, управляющие сжатием, оптимизацией и обфускацией приложения. R8 удаляет ненужный код и ресурсы, оптимизирует производительность во время выполнения и дополнительно минимизирует код, переименовывая идентификаторы. |