Ресурсы — это дополнительные файлы и статическое содержимое, которые использует ваш код, такие как растровые изображения, определения макетов, строки пользовательского интерфейса, инструкции по анимации и многое другое.
Всегда выносите ресурсы приложения, такие как изображения и строки, за пределы кода, чтобы вы могли управлять ими независимо. Также предоставляйте альтернативные ресурсы для конкретных конфигураций устройств, группируя их в специально названные каталоги ресурсов. Во время выполнения Android использует соответствующий ресурс в зависимости от текущей конфигурации. Например, вы можете захотеть предоставить разный макет пользовательского интерфейса в зависимости от размера экрана или разные строки в зависимости от языковых настроек.
После того как вы вынесете ресурсы своего приложения во внешний каталог, вы сможете получить к ним доступ, используя идентификаторы ресурсов, сгенерированные в R классе вашего проекта. В этом документе показано, как сгруппировать ресурсы в вашем проекте Android. Также показано, как предоставить альтернативные ресурсы для конкретных конфигураций устройства и затем получить к ним доступ из кода вашего приложения или других XML-файлов.
Типы групповых ресурсов
Размещайте каждый тип ресурсов в отдельной подпапке каталога res/ вашего проекта. Например, вот иерархия файлов для простого проекта:
MyProject/
src/
MyActivity.java
res/
drawable/
graphic.png
layout/
main.xml
info.xml
mipmap/
icon.png
values/
strings.xml
В каталоге res/ находятся все ресурсы из его подкаталогов: ресурс изображения, два ресурса макета, каталог mipmap/ для значков запуска и файл строковых ресурсов. Названия каталогов ресурсов важны и описаны в таблице 1.
Примечание: Дополнительную информацию об использовании папок mipmap см. в разделе «Размещение значков приложений в каталогах mipmap» .
Таблица 1. Поддерживаемые каталоги ресурсов внутри каталога res/ проекта.
| Каталог | Тип ресурса |
|---|---|
animator/ | XML-файлы, определяющие анимацию свойств . |
anim/ | XML-файлы, определяющие анимацию Tween . Анимацию свойств также можно сохранять в этом каталоге, но для анимации свойств предпочтительнее использовать каталог animator/ чтобы различать два типа анимаций. |
color/ | XML-файлы, определяющие список состояний цветов. Для получения дополнительной информации см. ресурс «Список состояний цветов» . |
drawable/ | Растровые файлы (PNG,
Для получения более подробной информации см. ресурсы Drawable . |
mipmap/ | Файлы Drawable для различной плотности значков запуска. Для получения дополнительной информации об управлении значками запуска с помощью папок mipmap/ см. раздел «Размещение значков приложений в каталогах mipmap» . |
layout/ | XML-файлы, определяющие макет пользовательского интерфейса. Дополнительную информацию см. в разделе «Ресурс макета» . |
menu/ | XML-файлы, определяющие меню приложения, такие как меню параметров, контекстное меню или подменю. Для получения дополнительной информации см. раздел «Ресурс меню» . |
raw/ | Произвольные файлы для сохранения в исходном виде. Чтобы открыть эти ресурсы с помощью необработанного Однако, если вам необходим доступ к исходным именам файлов и иерархии файлов, рассмотрите возможность сохранения ресурсов в каталоге |
values/ | XML-файлы, содержащие простые значения, такие как строки, целые числа и цвета. В то время как XML-файлы ресурсов в других подкаталогах Поскольку каждый ресурс определяется собственным XML-элементом, вы можете назвать файл как угодно и разместить в одном файле ресурсы разных типов. Однако для большей ясности может потребоваться размещать уникальные типы ресурсов в разных файлах. Например, вот несколько вариантов именования файлов ресурсов, которые вы можете создать в этом каталоге:
Для получения дополнительной информации см. разделы «Строковые ресурсы» , «Ресурсы стиля» и «Дополнительные типы ресурсов» . |
xml/ | Произвольные XML-файлы, которые можно прочитать во время выполнения, вызвав метод Resources.getXML() . Здесь необходимо сохранить различные XML-файлы конфигурации, например, конфигурацию поиска . |
font/ | Файлы шрифтов с расширениями, такими как TTF, OTF или TTC, или XML-файлы, содержащие элемент <font-family> . Для получения дополнительной информации о шрифтах как ресурсах см. раздел «Добавление шрифта в качестве XML-ресурса» . |
Внимание: Никогда не сохраняйте файлы ресурсов непосредственно в каталог res/ . Это приведет к ошибке компиляции.
Для получения более подробной информации об отдельных типах ресурсов см. раздел « Обзор типов ресурсов» .
Ресурсы, которые вы сохраняете в подкаталогах, определенных в таблице 1, являются вашими ресурсами по умолчанию. То есть, эти ресурсы определяют дизайн и содержимое вашего приложения по умолчанию. Однако для разных типов устройств на базе Android могут потребоваться ресурсы разных типов.
Например, вы можете предоставить различные ресурсы макета для устройств с экранами большего размера, чтобы использовать дополнительное пространство экрана. Вы также можете предоставить различные строковые ресурсы, которые переводят текст в пользовательском интерфейсе в зависимости от языковых настроек устройства. Чтобы предоставить эти различные ресурсы для разных конфигураций устройств, вам необходимо предоставить альтернативные ресурсы в дополнение к ресурсам по умолчанию.
Предоставьте альтернативные ресурсы
Большинство приложений предоставляют альтернативные ресурсы для поддержки конкретных конфигураций устройств. Например, включают альтернативные ресурсы изображений для разных плотностей экрана и альтернативные строковые ресурсы для разных языков. Во время выполнения Android определяет текущую конфигурацию устройства и загружает соответствующие ресурсы для вашего приложения.

Рисунок 1. Два устройства, использующие разные ресурсы компоновки в зависимости от размера экрана.
Чтобы указать специфичные для конфигурации альтернативы для набора ресурсов, выполните следующие действия:
- Создайте новую директорию в каталоге
res/с именем в формате<resources_name> - <qualifier>.-
<resources_name>— это имя каталога соответствующих ресурсов по умолчанию (определенных в таблице 1). -
<qualifier>— это имя, указывающее на конкретную конфигурацию, для которой должны использоваться эти ресурсы (определено в таблице 2).
Вы можете добавить более одного
<qualifier>. Разделяйте каждый из них дефисом.Внимание: При добавлении нескольких квалификаторов необходимо располагать их в том же порядке, в котором они указаны в таблице 2. Если порядок квалификаторов будет неправильным, ресурсы будут проигнорированы.
-
- Сохраните соответствующие альтернативные ресурсы в этой новой директории. Файлы ресурсов должны быть названы точно так же, как и файлы ресурсов по умолчанию.
Например, вот некоторые ресурсы по умолчанию и альтернативные варианты:
res/
drawable/
icon.png
background.png
drawable-hdpi/
icon.png
background.png
Квалификатор hdpi указывает, что ресурсы в этом каталоге предназначены для устройств с экраном высокой плотности. Изображения в этих каталогах drawable имеют размеры, соответствующие определенной плотности экрана, но имена файлов остаются неизменными. Таким образом, идентификатор ресурса, используемый для ссылки на изображение icon.png или background.png , всегда один и тот же. Android выбирает версию каждого ресурса, которая наилучшим образом соответствует текущему устройству, сравнивая информацию о конфигурации устройства с квалификаторами в имени каталога ресурсов.
Внимание: При определении альтернативного ресурса убедитесь, что вы также определяете этот ресурс в конфигурации по умолчанию. В противном случае ваше приложение может столкнуться с исключениями во время выполнения при изменении конфигурации устройства. Например, если вы добавите строку только к values-en , а не values , ваше приложение может столкнуться с исключением Resource Not Found когда пользователь изменит системный язык по умолчанию.
В таблице 2 перечислены допустимые квалификаторы конфигурации в порядке приоритета. Вы можете добавить несколько квалификаторов к одному имени каталога, разделяя каждый квалификатор дефисом. Если вы используете несколько квалификаторов для каталога ресурсов, вы должны добавить их к имени каталога в том порядке, в котором они перечислены в таблице.
Таблица 2. Названия квалификаторов конфигурации.
| Конфигурация | Значения квалификатора | Описание |
|---|---|---|
| MCC и MNC | Примеры:mcc310mcc208-mnc00 | Код страны мобильной связи (MCC), за которым, при желании, следует код мобильной сети (MNC) с SIM-карты в устройстве. Например, Если устройство использует радиосвязь (то есть, это GSM-телефон), значения MCC и MNC берутся с SIM-карты. Вы также можете использовать только MCC, например, для включения в приложение юридических ресурсов, специфичных для конкретной страны. Если вам необходимо указать только язык, используйте вместо этого квалификаторы language, script (необязательно) и region (необязательно) . Если вы используете квалификаторы MCC и MNC, делайте это с осторожностью и проверьте, работает ли все должным образом. Также обратите внимание на поля конфигурации |
| Язык, письменность (необязательно) и регион (необязательно) | Примеры:enfren-rUSfr-rFRfr-rCAb+enb+en+USb+es+419b+zh+Hantb+sr+Latn+RS | Язык определяется двухбуквенным кодом языка ISO 639-1 , за которым, при необходимости, следует двухбуквенный код региона ISO 3166-1-alpha-2 (перед которым стоит строчная буква Коды не чувствительны к регистру. Префикс В Android 7.0 (уровень API 24) появилась поддержка языковых тегов BCP 47 , которые можно использовать для определения языковых и региональных ресурсов. Языковой тег состоит из последовательности одного или нескольких подтегов, каждый из которых уточняет или сужает диапазон языков, определяемых общим тегом. Дополнительную информацию о языковых тегах см. в разделе «Теги для определения языков» . Для использования языкового тега BCP 47 объедините Языковой тег может изменяться в процессе работы вашего приложения, если пользователи меняют язык в системных настройках. Информацию о том, как это может повлиять на работу приложения во время выполнения, см. в разделе «Обработка изменений конфигурации» . Полное руководство по локализации вашего приложения на другие языки см. в разделе «Локализация вашего приложения» . Также обратите внимание на метод |
| Направление компоновки | ldrtlldltr | Направление компоновки вашего приложения. Это может относиться к любому ресурсу, например, к макетам, изображениям или значениям. Например, если вы хотите задать определенную раскладку для арабского языка и общую раскладку для любого другого языка с письмом справа налево, такого как персидский или иврит, то вы можете использовать каталоги, подобные следующим: Примечание: Чтобы включить функцию компоновки справа налево для вашего приложения, необходимо установить Добавлено в API уровня 17. |
| Наименьшая ширина | sw<N>dpПримеры: sw320dpsw600dpsw720dpи т. д. | Наименьшая доступная для приложения ширина области экрана. В частности, Например, если для вашей компоновки требуется, чтобы наименьший размер области экрана всегда составлял не менее 600 dp, то вы можете использовать этот квалификатор для создания ресурсов компоновки в каталоге Использование минимальной ширины для определения общего размера экрана полезно, поскольку ширина часто является определяющим фактором при проектировании макета. Пользовательский интерфейс часто прокручивается вертикально, но имеет довольно жесткие ограничения на минимальное пространство, необходимое по горизонтали. Доступная ширина также является ключевым фактором при определении того, следует ли использовать однопанельную компоновку для мобильных устройств или многопанельную для планшетов. Таким образом, вас, вероятно, больше всего интересует минимально возможная ширина для каждого устройства. Минимальная ширина устройства учитывает элементы оформления экрана и пользовательский интерфейс системы. Например, если устройство имеет постоянно отображаемые на экране элементы интерфейса, занимающие пространство вдоль оси минимальной ширины, система объявляет минимальную ширину меньше фактического размера экрана, поскольку эти пиксели экрана недоступны для вашего пользовательского интерфейса. Здесь можно использовать некоторые значения для распространенных размеров экрана:
Если ваше приложение предоставляет несколько каталогов ресурсов с разными значениями для параметра Добавлено в API уровня 13. Также обратите внимание на атрибут Для получения дополнительной информации о разработке дизайна для разных экранов с использованием этого квалификатора см. раздел «Адаптивный дизайн с использованием представлений» . |
| Доступные ширина и высота | w<N>dph<N>dpПримеры: w720dpw1024dph720dph1024dpи т. д. | Указывает минимальную доступную ширину или высоту экрана (в единицах Доступные значения ширины и высоты часто помогают определить, следует ли использовать многопанельную компоновку, поскольку даже на планшете часто требуется разный формат многопанельной компоновки для портретной и альбомной ориентации. Таким образом, вы можете использовать эти параметры для указания минимальной ширины и/или высоты, необходимых для компоновки, вместо того, чтобы использовать одновременно размер экрана и ориентацию. Если ваше приложение предоставляет несколько каталогов ресурсов с различными значениями для этих конфигураций, система использует тот, который наиболее близок к текущей ширине экрана устройства (не превышая её). Наиболее близкий определяется путем сложения разницы между фактической шириной экрана и указанной шириной с разницей между фактической высотой экрана и указанной высотой, при этом неуказанные значения высоты и ширины равны 0. Значения не включают область, занимаемую отступами окна , поэтому, если устройство имеет постоянно отображаемые элементы пользовательского интерфейса по краям дисплея, значения ширины и высоты будут меньше реальных размеров экрана, даже если приложение отображается от края до края с помощью Некоторые вертикальные элементы оформления экрана, которые не закреплены неподвижно (например, строка состояния телефона, которую можно скрыть в полноэкранном режиме), здесь не учитываются, как и элементы оформления окон, такие как заголовок или панель действий, поэтому приложениям следует быть готовыми к работе в несколько меньшем пространстве, чем указано в их спецификации. Примечание: Система выбирает ресурс, соответствующий обоим параметрам — ширине и высоте. Поэтому ресурс, указывающий оба параметра, имеет явное преимущество перед ресурсом, указывающим только один из них. Например, если фактическая ширина экрана составляет 720 dp, а высота — 1280 dp, и один ресурс обозначен как w720dp, а другой — как w700dp-h1200dp, то будет выбран последний, даже если первый точно соответствует указанным параметрам. Добавлено в API уровня 13. Также обратите внимание на поля конфигурации Для получения дополнительной информации о разработке дизайна для разных экранов с использованием этого квалификатора см. раздел «Адаптивный дизайн с использованием представлений» . |
| Размер экрана | smallnormallargexlarge |
Примечание: Использование квалификатора размера не означает, что ресурсы предназначены только для экранов этого размера. Если вы не предоставите альтернативные ресурсы с квалификаторами, которые лучше соответствуют текущей конфигурации устройства, система сможет использовать те ресурсы, которые лучше всего подходят . Внимание: если все ваши ресурсы используют квалификатор размера, превышающий текущий размер экрана, система их не использует, и ваше приложение аварийно завершит работу во время выполнения. Это происходит, например, если все ресурсы макета помечены квалификатором Добавлено в API уровня 4. Также обратите внимание на поле конфигурации Для получения более подробной информации см. Обзор совместимости экранов . |
| Аспект экрана | longnotlong |
Добавлено в API уровня 4. Это основано исключительно на соотношении сторон экрана ( Также обратите внимание на поле конфигурации |
| Круглый экран | roundnotround |
Добавлено в API уровня 23. Также обратите внимание на метод конфигурации |
| Широкий цветовой охват | widecgnowidecg |
Добавлено в API уровня 26. Также обратите внимание на метод конфигурации |
| Расширенный динамический диапазон (HDR) | highdrlowdr |
Добавлено в API уровня 26. Также обратите внимание на метод конфигурации |
| Ориентация экрана | portland |
Это может измениться в процессе работы вашего приложения, если пользователь повернет экран. Информацию о том, как это влияет на ваше приложение во время выполнения, см. в разделе «Обработка изменений конфигурации» . Также обратите внимание на поле настройки |
| режим пользовательского интерфейса | cardesktelevisionappliancewatchvrheadset |
Добавлено в API уровня 8; телевидение добавлено в API 13; часы добавлены в API 20. Для получения информации о том, как ваше приложение должно реагировать на подключение или отключение устройства от док-станции, ознакомьтесь с разделом «Определение и мониторинг состояния и типа док-станции» . Это может измениться в процессе работы вашего приложения, если пользователь поместит устройство в док-станцию. Вы можете включить или отключить некоторые из этих режимов с помощью |
| Ночной режим | nightnotnight |
Добавлено в API уровня 8. Это может измениться в процессе работы вашего приложения, если ночной режим оставлен в автоматическом режиме (по умолчанию), в этом случае режим изменяется в зависимости от времени суток. Вы можете включить или отключить этот режим с помощью |
| Плотность пикселей экрана (dpi) | ldpimdpihdpixhdpixxhdpixxxhdpinodpitvdpianydpinnn dpi |
Между шестью основными плотностями существует соотношение масштабирования 3:4:6:8:12:16 (без учета плотности tvdpi). Таким образом, растровое изображение 9x9 в ldpi соответствует 12x12 в mdpi, 18x18 в hdpi, 24x24 в xhdpi и так далее. Примечание: Использование квалификатора плотности не означает, что ресурсы предназначены только для экранов с такой плотностью. Если вы не предоставите альтернативные ресурсы с квалификаторами, которые лучше соответствуют текущей конфигурации устройства, система будет использовать те ресурсы, которые лучше всего подходят . Для получения дополнительной информации о том, как обрабатывать различные плотности экрана и как Android может масштабировать ваши растровые изображения в соответствии с текущей плотностью, см. Обзор совместимости экранов . |
| Тип сенсорного экрана | notouchfinger |
Также обратите внимание на поле «Конфигурация |
| Наличие клавиатуры | keysexposedkeyshiddenkeyssoft |
Если вы предоставляете ресурсы Это может измениться в процессе работы вашего приложения, если пользователь откроет аппаратную клавиатуру. Информацию о том, как это влияет на ваше приложение во время выполнения, см. в разделе «Обработка изменений конфигурации» . Также обратите внимание на поля конфигурации |
| Основной метод ввода текста | nokeysqwerty12key |
Также обратите внимание на поле «Настройка |
| Доступность навигационных клавиш | navexposednavhidden |
Это может измениться в процессе работы вашего приложения, если пользователь откроет клавиши навигации. Информацию о том, как это влияет на ваше приложение во время выполнения, см. в разделе «Обработка изменений конфигурации» . Также обратите внимание на поле конфигурации |
| Основной метод навигации без использования сенсорного экрана. | nonavdpadtrackballwheel |
Также обратите внимание на поле «Конфигурация |
| Версия платформы (уровень API) | Примеры:v3v4v7и т. д. | Уровень API, поддерживаемый устройством. Например, |
Примечание: Не все версии Android поддерживают все квалификаторы. Использование нового квалификатора неявно добавляет квалификатор версии платформы, чтобы старые устройства могли его игнорировать. Например, использование квалификатора w600dp автоматически включает квалификатор v13 , поскольку квалификатор available-width появился в API уровня 13. Во избежание проблем всегда включайте набор ресурсов по умолчанию (набор ресурсов без квалификаторов ). Для получения дополнительной информации см. раздел « Обеспечение наилучшей совместимости устройств с ресурсами» .
правила присвоения имен квалификаторам
Вот несколько правил использования имен квалификаторов конфигурации:
- Для одного набора ресурсов можно указать несколько квалификаторов, разделённых дефисами. Например,
drawable-en-rUS-landприменяется к устройствам с американским английским языком в альбомной ориентации. - Квалификационные критерии должны быть указаны в порядке, приведенном в таблице 2 .
- Неверно:
drawable-hdpi-port/ - Правильно:
drawable-port-hdpi/
- Неверно:
- Альтернативные каталоги ресурсов не могут быть вложенными. Например, нельзя использовать
res/drawable/drawable-en/. - Значения нечувствительны к регистру. Компилятор ресурсов преобразует имена каталогов в нижний регистр перед обработкой, чтобы избежать проблем в файловых системах, нечувствительных к регистру. Любое использование регистра в именах предназначено только для улучшения читаемости.
- Поддерживается только одно значение для каждого типа квалификатора. Например, если вы хотите использовать одни и те же файлы drawable для Испании и Франции, вы не можете создать каталог с именем
drawable-es-fr/. Вместо этого вам понадобятся два каталога ресурсов, напримерdrawable-es/иdrawable-fr/, которые будут содержать соответствующие файлы. Однако вам не обязательно фактически дублировать файлы в обоих местах. Вместо этого вы можете создать псевдоним для ресурса, как описано в разделе «Создание псевдонимов ресурсов» .
После сохранения альтернативных ресурсов в каталоги, названные с указанными квалификаторами, Android автоматически применяет эти ресурсы в вашем приложении в соответствии с текущей конфигурацией устройства. Каждый раз, когда запрашивается ресурс, Android проверяет наличие альтернативных каталогов ресурсов, содержащих запрошенный файл ресурса, а затем находит наиболее подходящий ресурс .
Если нет альтернативных ресурсов, соответствующих конкретной конфигурации устройства, Android использует соответствующие ресурсы по умолчанию — набор ресурсов определенного типа, не содержащий квалификатора конфигурации.
Создание псевдонимов ресурсов
Если у вас есть ресурс, который вы хотите использовать для настройки нескольких устройств, но не хотите предоставлять его в качестве ресурса по умолчанию, вам не нужно размещать один и тот же ресурс в нескольких альтернативных каталогах ресурсов. Вместо этого вы можете создать альтернативный ресурс, который будет действовать как псевдоним для ресурса, сохраненного в вашем каталоге ресурсов по умолчанию.
Примечание: Не все ресурсы предоставляют механизм для создания псевдонима для другого ресурса. В частности, ресурсы animation, menu, raw и другие неуказанные ресурсы в каталоге xml/ не предоставляют этой функции.
Например, представьте, что у вас есть иконка приложения, icon.png , и вам нужна её уникальная версия для разных языковых версий. Однако две языковые версии, англо-канадская и франко-канадская, должны использовать одну и ту же версию. Вам не нужно копировать одно и то же изображение в каталог ресурсов для обеих языковых версий. Вместо этого вы можете сохранить изображение, используемое для обеих версий, под любым именем , кроме icon.png , например, icon_ca.png , и поместить его в каталог res/drawable/ по умолчанию. Затем создайте файл icon.xml в res/drawable-en-rCA/ и res/drawable-fr-rCA/ который будет ссылаться на ресурс icon_ca.png с помощью элемента <bitmap> . Это позволит вам хранить только одну версию файла PNG и два небольших XML-файла, указывающих на него. Подробности см. в примерах в следующих разделах.
Рисуемый
Чтобы создать псевдоним для существующего изображения, используйте элемент <drawable> :
<?xml version="1.0" encoding="utf-8"?> <resources> <drawable name="icon">@drawable/icon_ca</drawable> </resources>
Если вы сохраните этот файл как icon.xml в другом каталоге ресурсов, например, res/values-en-rCA/ , он будет скомпилирован в ресурс, на который вы можете ссылаться как R.drawable.icon , но на самом деле это будет псевдоним для ресурса R.drawable.icon_ca , который сохранен в res/drawable/ .
Макет
Для создания псевдонима для существующего макета используйте элемент <include> , заключенный в <merge> :
<?xml version="1.0" encoding="utf-8"?> <merge> <include layout="@layout/main_ltr"/> </merge>
Если вы сохраните этот файл как main.xml , он будет скомпилирован в ресурс, на который можно ссылаться как R.layout.main , но на самом деле это будет псевдоним для ресурса R.layout.main_ltr .
Строки и другие простые значения
Чтобы создать псевдоним для существующей строки, используйте идентификатор ресурса нужной строки в качестве значения для новой строки:
<?xml version="1.0" encoding="utf-8"?> <resources> <string name="hello">Hello</string> <string name="hi">@string/hello</string> </resources>
Ресурс R.string.hi теперь является псевдонимом для ресурса R.string.hello .
Аналогичным образом работают и другие простые значения , например, цвета:
<?xml version="1.0" encoding="utf-8"?> <resources> <color name="red">#f00</color> <color name="highlight">@color/red</color> </resources>
Получите доступ к ресурсам вашего приложения.
После того как вы укажете ресурс в своем приложении, вы сможете применить его, сославшись на его идентификатор ресурса. Все идентификаторы ресурсов определены в классе R вашего проекта, который инструмент aapt генерирует автоматически.
При компиляции вашего приложения aapt генерирует класс R , содержащий идентификаторы ресурсов для всех ресурсов в вашем каталоге res/ . Для каждого типа ресурса существует подкласс R , например, R.drawable для всех ресурсов drawable. И для каждого ресурса этого типа существует статическое целое число, например, R.drawable.icon . Это целое число является идентификатором ресурса, который вы можете использовать для получения вашего ресурса.
Although the R class is where resource IDs are specified, you don't need to look there to discover a resource ID. A resource ID is always composed of the following:
- The resource type : each resource is grouped into a "type," such as
string,drawable, andlayout. For more information about the different types, see Resource types overview . - The resource name , which is either the filename excluding the extension or the value in the XML
android:nameattribute, if the resource is a simple value, such as a string.
There are two ways you can access a resource:
- In code: using a static integer from a subclass of your
Rclass, such as:R.string.hello
stringis the resource type andhellois the resource name. There are many Android APIs that can access your resources when you provide a resource ID in this format. For more information, see the Access resources in code section. - In XML: using a special XML syntax that corresponds to the resource ID defined in your
Rclass, such as:@string/hello
stringis the resource type andhellois the resource name. You can use this syntax in an XML resource any place where a value is expected that you provide in a resource. For more information, see the Access resources from XML section.
Access resources in code
You can use a resource in code by passing the resource ID as a method parameter. For example, you can set an ImageView to use the res/drawable/myimage.png resource using setImageResource() :
Котлин
val imageView = findViewById(R.id.myimageview) as ImageView imageView.setImageResource(R.drawable.myimage)
Java
ImageView imageView = (ImageView) findViewById(R.id.myimageview); imageView.setImageResource(R.drawable.myimage);
You can also retrieve individual resources using methods in Resources , which you can get an instance of with getResources() .
Синтаксис
Here's the syntax to reference a resource in code:
[<package_name>.]R.<resource_type>.<resource_name>
<package_name>is the name of the package in which the resource is located (not required when referencing resources from your own package).-
<resource_type>is theRsubclass for the resource type. -
<resource_name>is either the resource filename without the extension or theandroid:nameattribute value in the XML element, for simple values.
For more information about each resource type and how to reference them, see Resource types overview .
Варианты использования
There are many methods that accept a resource ID parameter, and you can retrieve resources using methods in Resources . You can get an instance of Resources using Context.getResources() .
Here are some examples of accessing resources in code:
Котлин
// Load a background for the current screen from a drawable resource. window.setBackgroundDrawableResource(R.drawable.my_background_image) // Set the Activity title by getting a string from the Resources object, because // this method requires a CharSequence rather than a resource ID. window.setTitle(resources.getText(R.string.main_title)) // Load a custom layout for the current screen. setContentView(R.layout.main_screen) // Set a slide in animation by getting an Animation from the Resources object. flipper.setInAnimation(AnimationUtils.loadAnimation(this, R.anim.hyperspace_in)) // Set the text on a TextView object using a resource ID. val msgTextView = findViewById(R.id.msg) as TextView msgTextView.setText(R.string.hello_message)
Java
// Load a background for the current screen from a drawable resource. getWindow().setBackgroundDrawableResource(R.drawable.my_background_image) ; // Set the Activity title by getting a string from the Resources object, because // this method requires a CharSequence rather than a resource ID. getWindow().setTitle(getResources().getText(R.string.main_title)); // Load a custom layout for the current screen. setContentView(R.layout.main_screen); // Set a slide in animation by getting an Animation from the Resources object. flipper.setInAnimation(AnimationUtils.loadAnimation(this, R.anim.hyperspace_in)); // Set the text on a TextView object using a resource ID. TextView msgTextView = (TextView) findViewById(R.id.msg); msgTextView.setText(R.string.hello_message);
Caution: Don't modify the R.java file by hand. It is generated by the aapt tool when your project is compiled. Any changes are overridden next time you compile.
Access resources from XML
You can define values for some XML attributes and elements using a reference to an existing resource. You often do this when creating layout files, to supply strings and images for your widgets.
For example, if you add a Button to your layout, use a string resource for the button text:
<Button android:layout_width="fill_parent" android:layout_height="wrap_content" android:text="@string/submit" />
Синтаксис
Here is the syntax to reference a resource in an XML resource:
@[<package_name>:]<resource_type>/<resource_name>
<package_name>is the name of the package in which the resource is located (not required when referencing resources from the same package).-
<resource_type>is theRsubclass for the resource type. -
<resource_name>is either the resource filename without the extension or theandroid:nameattribute value in the XML element, for simple values.
For more information about each resource type and how to reference them, see Resource types overview .
Варианты использования
In some cases, you must use a resource for a value in XML, such as to apply a drawable image to a widget, but you can also use a resource in XML any place that accepts a simple value. For example, if you have the following resource file that includes a color resource and a string resource :
<?xml version="1.0" encoding="utf-8"?> <resources> <color name="opaque_red">#f00</color> <string name="hello">Hello!</string> </resources>
You can use these resources in the following layout file to set the text color and text string:
<?xml version="1.0" encoding="utf-8"?> <EditText xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="fill_parent" android:layout_height="fill_parent" android:textColor="@color/opaque_red" android:text="@string/hello" />
In this case, you don't need to specify the package name in the resource reference, because the resources are from your own package. To reference a system resource, you need to include the package name, as shown in the following example:
<?xml version="1.0" encoding="utf-8"?> <EditText xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="fill_parent" android:layout_height="fill_parent" android:textColor="@android:color/secondary_text_dark" android:text="@string/hello" />
Note: Always use string resources, so that your application can be localized for other languages. For information about creating alternative resources (such as localized strings), see Provide alternative resources . For a complete guide to localizing your application for other languages, see Localize your app .
You can even use resources in XML to create aliases. For example, you can create a drawable resource that is an alias for another drawable resource:
<?xml version="1.0" encoding="utf-8"?> <bitmap xmlns:android="http://schemas.android.com/apk/res/android" android:src="@drawable/other_drawable" />
This sounds redundant, but can be very useful when using alternative resource. For more information, see the section about creating alias resources .
Reference style attributes
A style attribute resource lets you reference the value of an attribute in the currently applied theme. Referencing a style attribute lets you customize the look of UI elements by styling them to match standard variations supplied by the current theme, instead of supplying a hardcoded value. Referencing a style attribute essentially says, "Use the style that is defined by this attribute in the current theme."
To reference a style attribute, the name syntax is almost identical to the normal resource format, but instead of the "at" symbol ( @ ), use a question mark ( ? ). The resource type portion is optional. So the reference syntax is as follows:
?[<package_name>:][<resource_type>/]<resource_name>
For example, here's how you can reference an attribute to set the text color to match the secondary text color of the system theme:
<EditText id="text" android:layout_width="fill_parent" android:layout_height="wrap_content" android:textColor="?android:textColorSecondary" android:text="@string/hello_world" />
Here, the android:textColor attribute specifies the name of a style attribute in the current theme. Android now uses the value applied to the android:textColorSecondary style attribute as the value for android:textColor in this widget. Because the system resource tool knows that an attribute resource is expected in this context, you do not need to explicitly state the type, which is ?android:attr/textColorSecondary . You can exclude the attr type.
Access original files
While uncommon, you might need access your original files and directories. If you do, then saving your files in res/ won't work for you, because the only way to read a resource from res/ is with the resource ID. Instead, you can save your resources in the assets/ directory.
Files saved in the assets/ directory are not given a resource ID, so you can't reference them through the R class or from XML resources. Instead, you can query files in the assets/ directory like a normal file system and read raw data using AssetManager .
However, if all you require is the ability to read raw data (such as a video or audio file), then save the file in the res/raw/ directory and read a stream of bytes using openRawResource() .
Access platform resources
Android contains a number of standard resources, such as styles, themes, and layouts. To access these resources, qualify your resource reference with the android package name. For example, Android provides a layout resource you can use for list items in a ListAdapter :
Котлин
listAdapter = ArrayAdapter(this, android.R.layout.simple_list_item_1, myarray)
Java
setListAdapter(new ArrayAdapter<String>(this, android.R.layout.simple_list_item_1, myarray));
In this example, simple_list_item_1 is a layout resource defined by the platform for items in a ListView . You can use this instead of creating your own layout for list items.
Provide the best device compatibility with resources
For your app to support multiple device configurations, it's very important that you always provide default resources for each type of resource that your app uses.
For example, if your app supports several languages, always include a values/ directory (in which your strings are saved) without a language and region qualifier . If you instead put all your string files in directories that have a language and region qualifier, then your app crashes when run on a device set to a language that your strings don't support.
As long as you provide default values/ resources, then your app runs properly, even if the user doesn't understand the language it presents. It's better than crashing.
Likewise, if you provide different layout resources based on the screen orientation, pick one orientation as your default. For example, instead of providing layout resources in layout-land/ for landscape and layout-port/ for portrait, leave one as the default, such as layout/ for landscape and layout-port/ for portrait.
Providing default resources is important not only because your app might run on a configuration you hadn't anticipated, but also because new versions of Android sometimes add configuration qualifiers that older versions don't support. If you use a new resource qualifier, but maintain code compatibility with older versions of Android, then when an older version of Android runs your app, it crashes if you don't provide default resources, because it can't use the resources named with the new qualifier.
For example, if your minSdkVersion is set to 4, and you qualify all of your drawable resources using night mode ( night or notnight , which were added in API level 8), then an API level 4 device can't access your drawable resources and crashes. In this case, you probably want notnight to be your default resources, so exclude that qualifier and put your drawable resources in either drawable/ or drawable-night/ .
In short, to provide the best device compatibility, always provide default resources for the resources your app needs to perform properly. Then create alternative resources for specific device configurations using configuration qualifiers.
There is one exception to this rule: If your app's minSdkVersion is 4 or greater, you don't need default drawable resources when you provide alternative drawable resources with the screen density qualifier. Even without default drawable resources, Android can find the best match among the alternative screen densities and scale the bitmaps as necessary. However, for the best experience on all types of devices, provide alternative drawables for all three types of density.
How Android finds the best-matching resource
When you request a resource for which you provide alternatives, Android selects which alternative resource to use at runtime, depending on the current device configuration. To demonstrate how Android selects an alternative resource, assume the following drawable directories each contain different versions of the same images:
drawable/ drawable-en/ drawable-fr-rCA/ drawable-en-port/ drawable-en-notouch-12key/ drawable-port-ldpi/ drawable-port-notouch-12key/
And assume the following is the device configuration:
Locale = en-GB
Screen orientation = port
Screen pixel density = hdpi
Touchscreen type = notouch
Primary text input method = 12key
By comparing the device configuration to the available alternative resources, Android selects drawables from drawable-en-port .
The system arrives at its decision for which resources to use with the following logic:

Figure 2. Flowchart of how Android finds the best-matching resource.
- Eliminate resource files that contradict the device configuration.
The
drawable-fr-rCA/directory is eliminated, because it contradicts theen-GBlocale.drawable/ drawable-en/
drawable-fr-rCA/drawable-en-port/ drawable-en-notouch-12key/ drawable-port-ldpi/ drawable-port-notouch-12key/Exception: Screen pixel density is the one qualifier that is not eliminated due to a contradiction. Even though the screen density of the device is hdpi,
drawable-port-ldpi/isn't eliminated because every screen density is considered to be a match at this point. For information, see Screen compatibility overview . - Find the next-highest-precedence qualifier in the list ( table 2 ). (Start with MCC.)
- Do any of the resource directories include this qualifier?
- If no, return to step two and look at the next qualifier. In this example, the answer is "no" until the language qualifier is reached.
- If yes, continue to step four.
- Eliminate resource directories that don't include this qualifier. In this example, the system next eliminates all the directories that don't include a language qualifier:
drawable/drawable-en/ drawable-en-port/ drawable-en-notouch-12key/drawable-port-ldpi/drawable-port-notouch-12key/Exception: If the qualifier in question is screen pixel density, Android selects the option that most closely matches the device screen density. In general, Android prefers scaling down a larger original image to scaling up a smaller original image. For more information, see Screen compatibility overview .
- Repeat steps two, three, and four until only one directory remains. In this example, screen orientation is the next qualifier for which there are any matches. So, resources that don't specify a screen orientation are eliminated:
drawable-en/drawable-en-port/drawable-en-notouch-12key/The remaining directory is
drawable-en-port.
Though this procedure is executed for each resource requested, the system optimizes some aspects of it. One such optimization is that once the device configuration is known, it might eliminate alternative resources that can never match. For example, if the configuration language is English, then any resource directory that has a language qualifier set to something other than English is never included in the pool of resources checked (though a resource directory without the language qualifier is still included).
When selecting resources based on the screen size qualifiers, the system uses resources designed for a screen smaller than the current screen if there are no resources that better match. For example, a large-size screen uses normal-size screen resources if necessary.
However, if the only available resources are larger than the current screen, the system doesn't use them and your app crashes if no other resources match the device configuration. This happens, for example, if all layout resources are tagged with the xlarge qualifier, but the device is a normal-size screen.
Note: The precedence of the qualifier (in table 2 ) is more important than the number of qualifiers that exactly match the device. In the preceding example, at step four the last choice on the list includes three qualifiers that exactly match the device (orientation, touchscreen type, and input method), while drawable-en has only one parameter that matches (language). However, language has a higher precedence than these other qualifiers, so drawable-port-notouch-12key is eliminated.