Android xml id naming

Android resource naming convention

As a developer, there is a good probability that you have used libraries to make code cleaner and easier to use. You have followed certain naming convention like camelCase for Java.

Have you ever done same for values like dimensions, strings? Probably, no. We end up creating lots of items in files & hard to find one, difficult to manage. Resources file names are written in lowercase_underscore. I’ll discuss few naming convention for android resources.

Layout

Layout files should match the name of the Android components that they are intended for but moving the top level component name to the beginning. For example, if we are creating a layout for the SignInActivity, the name of the layout file should be activity_sign_in . xml.

A slightly different case is when we are creating a layout that is going to be inflated by an Adapter, e.g to populate a ListView or Recyclerview. In this case, the name of the layout should start with item_.

Strings

String names start with a prefix that identifies the section they belong to. We use _ for strings naming. to indicate reason of the string will be used & description give any extra information.

• string name=»label_home»>Home string> : how = label & home is description of the string.
• Enter Your Name : how = hint & user_name is the description of string.

Drawables

We use _ for strings naming. is Button,Dialog,Divider,Icon, etc & description give any extra information.

Dimensions

Apps should only define a limited set of dimensions, which are constantly reused.

• : It can be width(in dp), height (in dp), size (if width == height), margin(in dp), padding(in dp), elevation(in dp). text_size(in sp).
• : It can be any specific item or remove this section if used throughout the application.
• : It can be dp or sp.

That’s all! Even though this convention doesn’t cover all resource types, it does provide an easy to use solution for the most used ones. Feel free to add more conventions & give suggestion so that I can learn more from your experience.

Thanks for reading! Be sure to click claps below to recommend this article if you liked it.

Источник

A successful XML naming convention

Do you remember the last time you had to dig into strings.xml to find the right String to use? Or that you manually had to go over all drawables to find the one you needed?

Whenever we start a new project, we take a lot of care in setting up our architecture, CI, build flavors,… But do you also have a strategy to name your resources?

You should! Because the lack of XML namespaces, makes managing Android resources tedious. And causes things to grow out of control easily, especially in large projects.

So let’s introduce a simple scheme that will solve your pains.

• easy lookup of any resource (autocomplete)
• logical, predictable names
• clean ordering of resources
• strongly typed resources

This blogpost will explain the mechanism, its advantages, limitations and provide an easy to use cheat sheet.

Basic principle

All resource names follow a simple convention.

Let’s first describe every element briefly. After the advantages, we’ll see how this applies to each resource type.

Indicate what the resource actually represents, often a standard Android view class. Limited options per resource type.
(e.g. MainActivity -> activity )

Describe where it logically belongs in the app. Resources used in multiple screens use all , all others use the custom part of the Android view subclass they are in.
(e.g. MainActivity -> main , ArticleDetailFragment -> articledetail )

Differentiate multiple elements in one screen.
(e.g. title )

(optional)

Either a precise size or size bucket. Optionally used for drawables and dimensions.
(e.g. 24dp , small ))

Download and print the cheat sheet for easy reference.

Advantages

1. Ordering of resources by screen
   The WHERE part describes what screen a resource belongs to. Hence it is easy to get all IDs, drawables, dimensions,… for a particular screen.
2. Strongly typed resource IDs
   For resource IDs, the WHAT describes the class name of the xml element it belongs to. This makes is easy to what to cast your findViewById() calls to.
3. Better resource organizing
   File browsers/project navigator usually sort files alphabetically. This means layouts and drawables are grouped by their WHAT (activity, fragment. ) and WHERE prefix respectively. A simple Android Studio plugin/feature can now display these resources as if they were in their own folder.
4. More efficient autocomplete
   Because resource names are far more predictable, using the IDE’s autocomplete becomes even easier. Usually entering the WHAT or WHERE is sufficient to narrow autocomplete down to a limited set of options.
5. No more name conflicts
   Similar resources in different screens are either all or have a different WHERE . A fixed naming scheme avoids all naming collisions.
6. Cleaner resource names
   Overall all resources will be named more logical, causing a cleaner Android project.
7. Tools support
   This naming scheme could be easily supported by the Android Studio offering features such as: lint rules to enforce these names, refactoring support when you change a WHAT or WHERE , better resource visualisation in project view,…

Layouts

Layouts are relatively simple, as there usually are only a few layouts per screen. Therefore the rule can be simplified to:

Where is one of the following:

Prefix	Usage
activity	contentview for activity
fragment	view for a fragment
view	inflated by a custom view
item	layout used in list/recycler/gridview
layout	layout reused using the include tag

• activity_main: content view of the MainActivity
• fragment_articledetail: view for the ArticleDetailFragment
• view_menu: layout inflated by custom view class MenuView
• item_article: list item in ArticleRecyclerView
• layout_actionbar_backbutton: layout for an actionbar with a backbutton (too simple to be a customview)

Strings

The part for Strings is irrelevant. So either we use to indicate where the string will be used:

or all if the string is reused throughout the app:

• articledetail_title: title of ArticleDetailFragment
• feedback_explanation: feedback explanation in FeedbackFragment
• feedback_namehint: hint of name field in FeedbackFragment
• all_done: generic “done” string

obviously is the same for all resources in the same view.

Drawables

The part for Drawables is irrelevant. So either we use to indicate where the drawable will be used:

or all if the drawable is reused throughout the app:

Optionally you can add a argument, which can be an actual size “24dp” or a size qualifier “small”.

• articledetail_placeholder: placeholder in ArticleDetailFragment
• all_infoicon: generic info icon
• all_infoicon_large: large version of generic info icon
• all_infoicon_24dp: 24dp version of generic info icon

For IDs, is the class name of the xml element it belongs to. Next is the screen the ID is in, followed by an optional description to distinguish similar elements in one screen.

• tablayout_main -> TabLayout in MainActivity
• imageview_menu_profile -> profile image in custom MenuView
• textview_articledetail_title -> title TextView in ArticleDetailFragment

Dimensions

Apps should only define a limited set of dimensions, which are constantly reused. This makes most dimensions all by default.

Therefore you should mostly use:

and optionally use the screen specific variant:

Where is one of the following:

Prefix	Usage
width	width in dp
height	height in dp
size	if width == height
margin	margin in dp
padding	padding in dp
elevation	elevation in dp
keyline	absolute keyline measured from view edge in dp
textsize	size of text in sp

Note that this list only contains the most used s. Other dimensions qualifiers like: rotation, scale,… are usually only used in drawables and as such less reused.

• height_toolbar: height of all toolbars
• keyline_listtext: listitem text is aligned at this keyline
• textsize_medium: medium size of all text
• size_menu_icon: size of icons in menu
• height_menu_profileimage: height of profile image in menu

Known limitations

Screens need to have unique names
To avoid collisions in the argument, View (like) classes must have unique names. Therefore you cannot have a “MainActivity” and a “MainFragment”, because the “Main” prefix would no longer uniquely identify one .

Refactoring not supported
Changing class names does not change along resource names when refactoring. So if you rename “MainActivity” to “ContentActivity”, the layout “activity_main” won’t be renamed to “activity_content”. Hopefully Android Studio will one day add support for this.

Not all resource types supported
The proposed scheme currently does not yet support all resource types. For some resources this is because they are less frequently used and tend to be very varied (e.g. raw and assets). For other resources this is because they are a lot harder to generalize (e.g. themes/styles/colors/animations).

Your apps colors palette likely wants to reuse the terminology of your design philosophy. Animations can range from modest (fade) to very exotic. Themes and styles already have a naming scheme that allows you to implicitly inherit properties.

Wrap-up

That’s it! A clean simple and easy to use resource naming scheme. Don’t forget to download the cheat sheet for easy reference!

Even though this scheme doesn’t (yet) cover all resource types, it does provide an easy to use solution for where most naming pain currently is. In a future blogpost I’ll also make a suggestion for the other ones.

If you’ve made it this far, you should probably follow me on Twitter . Feel free leave a comment below!

Источник

Ресурсы

Основы

На схеме представлена только часть ресурсов. Система постоянно обновляется и добавляются новые типы.

Ресурсы — один из основных компонентов, с которыми вам придется работать очень часто. В Android принято держать некоторые объекты — изображения, строковые константы, цвета, анимацию, стили и т.п. за пределами исходного кода. Система поддерживает хранение ресурсов в отдельных файлах. Ресурсы легче поддерживать, обновлять, редактировать.

Каждое приложение на Android содержит каталог для ресурсов res и каталог для активов assets. Реальное различие между ресурсами и активами заключается в следующем:

• информация в каталоге ресурсов будет доступна в приложении через класс R, который автоматически генерируется средой разработки. То есть хранение файлов и данных в ресурсах (в каталоге res) делает их легкодоступными для использования в коде программы;
• для чтения информации, помещенной в каталог активов assets (необработанный формат файла), необходимо использовать AssetManager для чтения файла как потока байтов.

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

Ресурсы в Android являются декларативными. В основном ресурсы хранятся в виде XML-файлов в каталоге res с подкаталогами values, drawable-ldpi, drawable-mdpi, drawable-hdpi, layout, но также бывают и другие типы ресурсов.

Для удобства система создает идентификаторы ресурсов и использует их в файле R.java (класс R, который содержит ссылки на все ресурсы проекта), что позволяет ссылаться на ресурсы внутри кода программы. Статический класс R генерируется на основе ваших заданных ресурсов и создается во время компиляции проекта. При создании класс содержит статические подклассы для всех типов ресурсов, для которых был описан хотя бы один экземпляр. Подробнее о классе R рассказано ниже.

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

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

Самыми распространёнными ресурсами являются, пожалуй, строки (string), цвета (color) и графические рисунки (bitmap). В приложении не рекомендуется применять жёстко написанные строки кода — вместо них следует использовать соответствующие идентификаторы, что позволяет изменять текст строкового ресурса, не изменяя исходного кода.

Начинающие программисты не всегда до конца правильно понимают процесс создания ресурсов. В Android используются два подхода — первый подход заключается в том, что ресурсы задаются в файле, при этом имя файла значения не имеет. Второй подход — ресурс задаётся в виде самого файла, и тогда имя файла уже имеет значение (при этом нужно учитывать определённые нюансы).

Общая структура каталогов, содержащих ресурсы выглядит следующим образом:

Только в assets может располагаться любой набор подкаталогов разной вложенности. Файлы, находящиеся в любом другом каталоге, размещаются именно на уровне этого каталога и не глубже.

Перечисление основных ресурсов Android

Тип ресурса	Размещение	Описание
Цвета	res/values/имя_файла	Идентификатор цвета, указывающий на цветовой код. ID таких ресурсов выражаются в R.java как R.color.*. XML-узел: /resources/color
Строки	res/values/имя_файла	Строковые ресурсы. В их число также входят строки в формате java и html. ID таких ресурсов выражаются в R.java как R.string.*. XML-узел: resources/string. Можно использовать дополнительное форматирование при помощи стандартных html-тегов , и . Методы, которые будут обрабатывать строковые ресурсы с HTML-форматированием, должны уметь обрабатывать эти теги.
Меню	/res/menu/имя_файла	Меню в приложении можно задать как XML-ресурсы.
Параметры	/res/values/имя_файла	Представляет собой параметры или размеры различных элементов. Поддерживает пиксели, дюймы, миллиметры, не зависящие от плотности экрана пиксели (dip) и пиксели, не зависящие от масштаба. ID таких ресурсов выражаются в R.java как R.dimen.*. XML-узел: resources/dimen
Изображения	/res/drawable/ваши_файлы	Ресурсы-изображения. Поддерживает форматы JPG, GIF, PNG (самый предпочтительный) и др. Каждое изображение является отдельным файлом и получает собственный идентификатор, который формируется по имени файла без расширения. Такие ID ресурсов представлены в файле R.java как R.drawable.*. Система также поддерживает так называемые растягиваемые изображения (stretchable image), в которых можно менять масштаб отдельных элементов, а другие элементы оставлять без изменений.
Отрисовываемые цвета	/res/values/ваш_файл или /res/drawable/ваши_файлы	Представляет цветные прямоугольники, которые используются в качестве фона основных отрисовываемых объектов, например точечных рисунков. Поддержка такой функции обеспечивается тегом значения drawable, находящимся в подкаталоге значений. Такие id ресурсов выражаются в файле R.java как R.drawable.*. ХМL-узел для такого файла: /resources/drawable. В Android при помощи специальных ХМL-файлов, расположенных в /res/drawable, также подерживаются скругленные и градиентные прямоугольники. Корневым ХМL-тегом для drawable является . Идентификаторы таких ресурсов выражаются в файле R.java как R.drawable.*. В таком случае, каждое имя файла преобразуется в уникальный id отрисовываемого объекта
Анимация	/res/anim/ваш_файл	Android может выполнить простую анимацию на графике или на серии графических изображений. Анимация включает вращения, постепенное изменение, перемещение и протяжение.
Произвольные XML-файлы	/res/xml/*.xml	В Android в качестве ресурсов могут использоваться произвольные XML-файлы. Они компилируются в aapt. Идентификаторы таких ресурсов также выражаются в файле R.java как R.xml.*
Произвольные необработанные ресурсы	/res/raw/*.*	Любые нескомпилированные двоичные или текстовые файлы, например, видео. Каждый файл получает уникальный id ресурса. Идентификаторы таких ресурсов выражаются в файле R.java как R.raw.*
Произвольные необработанные активы	/assets/*.*/*.*	Можно использовать произвольные файлы в произвольно названных каталогах, которые находятся в подкаталоге /assets. Это не ресурсы, а просто необработанные файлы. В этом каталоге, в отличие от /res, подкаталоги могут располагаться на любой глубине. Для таких файлов не создаются идентификаторы ресурсов. При работе с ними нужно использовать относительное имя пути, начиная с /assets, но не указываея этого каталгоа в имени пути

Идентификаторы

Этот тип ресурсов формируется, как правило, автоматически, и программисты даже не обращают на него внимания. Когда вы размещаете новый элемент на форме, с которым будете взаимодействовать в программе, то ему нужно присвоить идентификатор. Как правило, это происходит в виде @+id/editText (часто это происходит автоматически). Знак плюса обозначает, что если идентификатора не существует, то его нужно создать в классе R. В программе вы можете обращаться к элементу R.id.editText.

Но можно заранее создать ресурс типа item для задания id, не связанного ни с каким конкретным ресурсом:

Здесь type описывает тип ресурса, в данном случае id. Когда id будет установлен, будет работать и следующее определение View:

Обычно идентификаторы размещают в отдельном файле res/values/ids.xml.

Строковые ресурсы

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

При разработке первого приложения вы видели, что система создала файл strings.xml, в котором хранились строки для заголовка приложения и выводимого сообщения. Вы можете редактировать данный файл, добавляя новые строковые ресурсы. А также вы можете создать новые файлы, которые будут содержать строковые ресурсы, например, strings2.xml, catnames.xml и т.д. Все эти файлы должны находиться в подкаталоге /res/values. Запомните, имена файлов и их число не важно. Но в большинстве случаев программисты используют для строковых ресурсов стандартное имя strings.xml. Типичный файл выглядит следующим образом.

При создании или обновлении файла со строковыми ресурсами среда разработки автоматически создаёт или обновляет класс R.java, сообщая уникальные ID для определённых в файле строковых ресурсов (Независимо от количества файлов ресурсов, в проекте содержится только один файл R.java). Если открыть данный файл, то можно найти там наши ресурсы в следующем виде:

В принципе достаточно запомнить, что R.java создаёт внутренний статический класс как пространство имён, в котором содержатся ID строковых ресурсов. Два static final int, которые используются в переменных hello и app_name, являются идентификаторами ресурсов и соответствуют соответствующим строковым ресурсам. Вы можете использовать данные идентификаторы в своем исходном коде, используя следующий формат — R.string.hello.

Обратите внимание, что сгенерированные ID указывают на int, а не на String. Android при необходимости самостоятельно подставляет вместо int нужные строки.

Обычно принято хранить строковые ресурсы в файле strings.xml, но вы можете использовать несколько файлов. Главное, чтобы XML-файл имел необходимую структуру и находился в подкаталоге res/values.

Структура файла для строковых ресурсов довольно проста. Имеется корневой узел , за которым следуют один или несколько дочерних элементов . Каждый элемент в свою очередь имеет свойство name, которое в файле R.java представляет собой атрибут id.

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

Запомните, что пробелы в начале и в конце строк обрезаются. Если вам так нужны пробелы, то разместите строку в кавычках и строка будет выводиться как есть. Также можно попробовать использовать код \u0020 вместо пробела.

Такая же проблема и с несколькими пробелами внутри строки — будет выводиться только один пробел (напоминает поведение в html-документе).

Продвинутые приёмы работы со строковыми ресурсами

Кроме стандартного использования строковых ресурсов, можно использовать более сложные приёмы. Посмотрим, как определять и использовать строки, написанные на HTML, а также узнаем, как происходит подстановка переменных в строковых ресурсах.

Начнём с того, как определять в ХМL-файлах ресурсов следующие виды строк:

• обычные строки
• строки в кавычках
• НТМL-строки
• заменяемые строки

Этот ХМL-файл строковых ресурсов должен находиться в подкаталоге res/values. Имя файла выбирается произвольно.

Обратите внимание — строки, находящиеся в кавычках, необходимо либо пропускать, либо помещать в дополнительные кавычки. При определении строк также можно использовать стандартные последовательности Jаvа, предназначенные для форматирования строк.

Нельзя использовать символы ‘&amp’, ‘ вы определяете элемент bool с нужным значением. У элемента есть атрибут name — строка, определяющая имя булевого ресурса.

Получить значение через код:

В макете для булевых атрибутов

Числовые ресурсы

В ресурсах можно хранить числа типа Integer. Хранить можно в произвольном имени XML-файла в папке res/values/ в корневом элементе

У элемента есть атрибут name, определяющий имя числового значения.

Для работы в коде:

Таким образом, для работы с типами boolean и int следует применять код (в общем виде):

Нет необходимости писать избыточный код (хотя он и будет работать) типа такого:

Ресурсы меню

Не создавайте меню в коде приложения, а используйте отдельные ресурсы для меню в формате XML. Можно использовать как для описания обычного и контекстного меню. Меню, описанное в формате XML, загружается в виде программного объекта с помощью метода inflate, принадлежащего сервису MenuInflater. Как правило, это происходит внутри обработчика onCreateOptionsMenu (смотри урок Меню).

Описание меню хранится в отдельном файле в каталоге res/menu. Имена файлов без расширения автоматически становятся идентификаторами ресурсов.

В ХМL-файле меню есть три элемента:

• — корневой элемент файла меню;
• — контейнерный элемент, определяющий группу меню;
• — элемент, определяющий пункт меню

Элементы и могут быть дочерними элементами .

Элемент item может иметь несколько атрибутов:

id Идентификатор пункта меню, по которому приложение может распознать при выделении пункта меню пользователем title Текст, который будет выводиться в меню icon Значок для пункта меню. Можно использовать графический ресурс

Ресурсы разметки

Еще один из важных видов ресурсов — ресурсы разметки, которые отвечают за внешний вид приложения. Данные ресурсы представлены в формате XML. Ресурс разметки формы (layout resource) — это ключевой тип ресурсов, применяемый при программировании пользовательских интерфейсов в Android. Каждый ресурс, описывающий разметку, хранится в отдельном файле каталога res/layout. Имя файла без расширения выступает как идентификатор ресурса.

Ниже представлен фрагмент исходного кода для разметки:

Строка setContentView(R.layout.main); указывает на то, что у нас имеется статический класс, называемый R.layout, в котором есть константа main (некое число), указывающая на View, определяемый в ХМL-файле ресурса разметки формы. ХМL-файл будет иметь имя main.xml, и он должен быть размещен в подкаталоге ресурсов res/layout и содержать необходимое определение разметки формы.

Содержимое самого файла main.xml может быть таким:

В данном файле разметки формы имеется корневой узел
, в котором содержится дочерний элемент

Для каждого варианта разметки требуется специальный файл. Если вы рисуете два экрана, вам понадобится два файла разметки, например, res/layout/screenl_layout.xml и res/layout/screen2_layout.xml. Каждый файл в подкаталоге res/layout генерирует уникальную константу на основе имени файла (без расширения). При работе с ресурсами разметки здесь важно количество файлов, а при работе со строковыми ресурсами важно количество отдельных строковых ресурсов внутри файлов. Например, если в подкаталоге res/layout у нас есть два файла filel.xml и filе2.xml, то в файле R.java будут содержаться следующие записи:

Элементы управления, которые используются в данных файла компоновки, например, TextView, будут доступны в коде через ID, генерируемым в R.java:

В данном примере мы находим класс TextView при помощи метода findViewByid() класса Activity. Константа R.id.textView соответствует ID, заданному в TextView. Идентификатор для TextView в файле разметки выглядит следующим образом:

Значение атрибута id указывает, что константа textView будет использоваться для идентификации этого вида среди других, используемых данным окном. Знак + в @+id/textView означает, что будет создан ID с именем textView, если он еще не существует.

Синтаксис ссылок на ресурсы

Все ресурсы Android идентифицируются по их id, содержащемуся в исходном коде Jаvа. Синтаксис, используемый при связывания id с ресурсом в файле XML, называется синтаксис ссылок на ресурс (resource-reference syntax). Синтаксис атрибута id в предыдущем примере @+id/textl имеет следующую структуру:

Параметр tуре соответствует одному из пространств имен:

Параметр name — это имя ресурса. Оно также представлено в виде константы int в файле R.java.

Если не указывать пакет (package), то разрешение пары type/name будет производиться на основе локальных ресурсов и локального пакета R.java. Если указать android:type/name, то связывание ID ссылки будет производиться с применением пакета Android, в частности с использованием файла android.R.java. Вы можете использовать имя любого java-пакета вместо подстановочного слова package, чтобы использовать файл R.java, подходящий для связывания ссылки.

Рассмотрим несколько примеров

TextView android:id=»text» — Ошибка компиляции, так как id не принимает необработанные текстовые строки.

TextView android:id=»@text» — Неправильный синтаксис. Не хватает названия типа. Вы получите сообщение об ошибке «No Resource type specified»

TextView android:id=»@id/text — Ошибка: не найдено ни одного ресурса, соответствующего id «text». Возможно, вы не задали «text» как один из видов ID

TextView android:id=»@android:id/text» — Ошибка: Ресурс не является общедоступным». Означает, что такой id отсутствует в android.R.id. Чтобы такая запись была действительной, необходимо в файле Android.R.java задать id с таким именем

TextView android:id==»@+id/text — Успешно: создает id с названием «text» в файле R.java локального пакета.

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

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

в предыдущем фрагменте кода указывает, что id с названием text, будет использоваться в том случае, если этот id уже создан. Если id еще не существует, нужно создать новый идентификатор. В связи с этим возникает вопрос: может ли id, например, text уже существовать в файле R.java, чтобы такой идентификатор можно было использовать многократно?

Можно предположить, что такую задачу могла бы выполнять константа, например R.id.text, находящаяся в файле R.java, но R.java не поддается редактированию. Даже, если бы было возможно внести такие изменения, файл приходилось бы заново генерировать после добавления, изменения или удаления любой информации из подкаталога res/*.

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

Здесь type описывает тип ресурса, в данном случае id. Когда id будет установлен, будет работать и следующее определение View:

Цветовые ресурсы

Для работы со цветом используется тег , а цвет указывается в специальных значениях.

Также существуют предопределенные названия цветов. Такие ID доступны в пространстве имен android.R.соlor. Посмотреть цветовые значения цветов можно в документации http://developer.android.com/reference/android/R.color.html.

Например, там есть оранжевый цвет holo_orange_dark, а также оранжевый-светлый, синий-темный, синий-светлый и т.д.

Обычно для цветовых ресурсов используют файл colors.xml в подкаталоге res/values. Но можно использовать любое произвольное имя файла, или даже вставить их в файл вместе со строковыми ресурсами strings.xml. Android прочтет все файлы, а затем обработает их, присвоив им нужные ID.

Для программного использования цветовых ресурсов можно использовать следующий код:

Более длинный вариант без склейки методов.

При использовании в xml-файлах (например, файл разметки) используется следующий формат:

Обратите внимание на использование префикса @ для того, чтобы ввести ссылку ресурса — текст после этого префикса — имя ресурса. В этом случае мы не должны были указывать пакет, потому что мы ссылаемся на ресурс в нашем собственном пакете. Для ссылки на системный ресурс мы должны записать: android:textColor=»@android:color/black» (чёрный цвет).

Ресурсы размеров

В Android используются следующие единицы измерения: пиксели, дюймы, точки. Все они могут входит в состав ХМL-шаблонов и кода Jаvа. Данные единицы измерения также можно использовать в качестве ресурсов при помощи тега (обычно используют файл dimens.xml):

Список разрешённых единиц измерения можно прочитать в отдельной статье Единицы измерения

Вы должны иметь доступ к каждому экземпляру объекта Resources, чтобы найти значения его параметров. Это можно сделать, применив метод getResources() к объекту Activity. Когда у вас будет объект Resources, его можно запросить по id, чтобы узнать значение этого параметра.

В XML-файлах используется следующий синтаксис

Ресурсы визуальных стилей и тем

Ресурсы со стилями позволяют поддерживать единство внешнего вида приложения. Чаше всего визуальные стили и темы используются для хранения цветовых значений и шрифтов. Обычно используют файл styles.xml.

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

Чтобы создать стиль, используйте тег

Тег поддерживает наследование с помощью атрибута parent, поэтому вы можете свободно варьировать стили.

Чтобы задать ссылку на ресурс, который нужно применить, вместо символа @ укажите префикс ?. Например, укажем цвет, используя стиль темы:

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

Вы могли встречать подобный синтаксис при работе с текстовыми метками или индикаторами прогресса.

res/drawable

В папке res/drawable могут содержаться ресурсы изображений, фигур, градиентов.

Ресурсы отрисовываемых цветов

Кроме обычных изображений в Android поддерживается и другой тип отрисовываемых ресурсов, которые называются отрисовываемыми цветами (color-drawable). По сути, это просто цветные прямоугольники.

Чтобы задать цветной прямоугольник, нужно указать тег в имени узла XML-файла, находящегося в подкаталоге res/values/.

В XML-шаблонах ресурсы используются следующим образом

Mipmap

С появлением Nexus 6 и Nexus 9, Гугл добавила в Android новые типы ресурсов — Mipmap. По сути, это замена ресурсам Drawable для значков приложения. Нужно подготовить значки и расположить их в папках mipmap-mdpi, mipmap-hdpi и т.д. Основная идея заключается в том, что при компиляции неиспользуемые drawable-ресурсы могут быть удалены в целях оптимизации. Перенос значков приложения в новые папки с разными разрешениями позволяет избежать потенциальной проблемы с удалением нужных файлов.

Ресурсы анимации

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

При использовании анимации промежуточных кадров каждый экземпляр анимации хранится в отдельном XML-файле внутри каталога res/anim. Имена файлов без расширения являются идентификаторами для ресурсов.

Анимацию можно задать в виде изменений параметров alpha (затемнение), scale (масштабирование), translate (перемещение) или rotate (вращение).

Вы можете комбинировать различные экземпляры анимации, используя тег set с атрибутами:

• duration — продолжительность анимации в секундах
• startOffset — миллисекундная задержка перед началом анимации
• fillBefore — при значении true преобразование происходит перед началом анимации
• fillAfter — при значении true преобразование происходит после завершения анимации
• interpolator — описывает изменения в скорости эффекта

Если не использовать атрибут startOffset, все анимационные эффекты внутри набора происходят одновременно.

Пошаговая анимация подразумевает создание последовательности объектов Drawable, каждый из которых будет отображаться в качестве фона на протяжении указанного промежутка времени. Пошаговая анимация хранится в виде ресурсов Drawable в каталоге res/drawable (см. выше). Имена файлов без расширения используются в качестве идентификаторов.

Ресурсы массивов

Существует еще один тип ресурсов для хранения значений массивов. Принято хранить данные ресурсы в файле arrays.xml папки res/values. Вот как может выглядеть файл:

Как видите, есть типы ресурсов array, string-array, integer-array.

Программно получить доступ к ресурсам массива можно так:

Ещё один вариант, который может вам встретиться. Цвета заданы в массиве и доступ к ним через особый объект TypedArray

Скомпилированные и нескомпилированные ресурсы Android

Большинство ресурсов компилируются в двоичные файлы, но некоторые используются без дополнительной обработки. В Android поддержка ресурсов осуществляется преимущественно при помощи файлов двух типов — XML и RAW-файлов (к последним относятся изображения, аудио и видео). При работе с ХМL-файлами мы видели, что в большинстве случаев ресурсы определяются как значения внутри файла XML (это касается, например, строк), а иногда весь ХМL-файл является ресурсом (например, файл ресурса разметки).

Файлы, созданные в XML, также подразделяются на два типа: первые компилируются в двоичный формат, а вторые копируются на устройство без изменений. Например, XML-файлы строковых ресурсов и ресурсов разметки компилируются в двоичный формат. Эти ХМL-файлы имеют заданный формат, в котором узлы XML преобразуются в ID.

XML-документы

Вы также можете специально выбрать некоторые ХМL-файлы и задать для них структуру формата, отличающуюся от принятой по умолчанию, — чтобы эти файлы не интерпретировались и для них не генерировались идентификаторы ресурсов. Однако в данном случае нам как раз нужно, чтобы они компилировались в двоичный формат и чтобы их было удобно локализовывать. Для достижения этой цели файлы XML можно поместить в подкаталог /res/xml — тогда они будут скомпилированы в двоичный формат. В таком случае вы можете воспользоваться поставляемыми вместе с Android инструментами для считывания XML, которые могут считывать ХМL-узлы.

Ниже приведен пример ХМL-файла в подкаталоге res/xml/test.xml:

Как и при работе с другими ХМL-файлами ресурсов, ААРТ компилирует такой ХМL-файл, перед тем как поместить его в пакет прикладных программ. Для синтаксического разбора подобных файлов используйте экземпляр XmlPullParser:

Возвращённый XmlResourceParser является экземпляром XmlPullParser, а также реализует java.util.AttributeSet.

Пример работы с XML-документами описан в статье Работаем с XML-документами

Использование необработанных ресурсов RAW

Если разместить файлы, в том числе написанные на XML, в каталоге res/raw, они не будут скомпилированы в двоичном формате, а попадают в пакет прикладных программ как есть. Для считывания таких фалов нужно использовать явные API с поддержкой потоков. К категории raw относятся аудио- и видеофайлы.

Каждый такой файл, помещённый в папку res/raw, имеет свой идентификатор, генерируемый в R.java. Чтобы получить доступ к ресурсам, предназначенным только для чтения, вызовите метод openRawResource(), принадлежащий объекту Resource приложения. Таким образом, вы получите объект InputStream, основанный на указанном файле. В качестве имени переменной, принадлежащей R.raw, задайте имя файла (без расширения). Если бы вы поместили текстовый файл в res/raw/test.txt, то его можно было бы прочитать при помощи следующего кода, используя идентификатор test:

Мы уже рассматривали структуру папок в каталоге res. Компилятор ресурсов, входящий в состав инструмента Android Asset Packaging Tool (ААРТ), собирает все ресурсы, кроме raw, и помещает все их в итоговый файл АРК. Этот файл, содержащий код и ресурсы приложения Android, аналогичен файлу JAR, который применяется в Java (АРК означает Android package — пакет Android). Именно файл АРК устанавливается на устройство.

Использование ресурсов в коде программы

Подведём воедино информацию об использовании ресурсов в коде программы.

Во время компиляции генерируется статический класс R на основе ваших ресурсов и содержит идентификаторы всех ресурсов в программе. Класс R имеет несколько вложенных классов, один для каждого типа ресурса, поддерживаемого системой Android, и для которого в проекте существует файл ресурса. Класс R может содержать следующие вложенные классы:

• R.anim — идентификаторы для файлов из каталога res/anim/ (анимация);
• R.array — идентификаторы для файлов из каталога res/values/ (массивы);
• R.bool — идентификаторы для битовых массивов в файлах arrays.xml из каталога res/values/;
• R.integer — идентификаторы для целочисленных массивов в файлах arrays.xml из каталога res/values/;
• R.color — идентификаторы для файлов colors.xml из каталога res/values/ (цвета);
• R.dimen — идентификаторы для файлов dimens.xml из каталога res/values/ (размеры);
• R.drawable — идентификаторы для файлов из каталога res/drawable/ (изображения);
• R.id — идентификаторы представлений и групп представлений для файлов ХМL-разметки из каталога res/layout/;
• R.layout — идентификаторы для файлов разметки из каталога res/layout/;
• R.raw — идентификаторы для файлов из каталога res/raw/;
• R.string — идентификаторы для файлов strings.xml из каталога res/values/ (строки);
• R.style — идентификаторы для файлов styles.xml из каталога res/values/ (стили);
• R.xml — идентификаторы для файлов из каталога res/xml/.

Синтаксис для обращения к ресурсу:

При использовании системных ресурсов используется класс android.R.

Если в коде вам понадобится идентификатор ресурса для конструктора или метода, то можете использовать данные свойства:

Если вам нужен не идентификатор, а сам экземпляр ресурса, то используйте метод getResources для доступа к экземпляру класса Resources:

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

Итак, к графическим ресурсам можно обратиться через R.drawable.cat (файл cat.png), а к музыкальным трекам через R.raw.meow (файл meow.mp3) и по аналогии с другими типами ресурсов.

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

Второй способ с использованием идентификатора (не особо нужен):

Допустим, у вас файлы имеют схожие имена meow1.mp3, meow2.mp3, meow3.mp3. По приведённой выше схеме не составит труда создать переменную типа String fileName = «meow» + n. Такой подход может пригодиться в циклах, когда счётчик можно сопоставить с именем файла.

Можете заменить имя пакета на программное извлечение с помощью метода Context.getPackageName().

Получить идентификатор ресурса по его имени

Ещё один полезный способ, который может пригодиться. Получить идентификатор по имени файла (без расширения) при помощи метода getIdentifier():

Пример для графического ресурса.

Пример для строкового ресурса в виде функции на Kotlin. Сам идентификатор в виде числа может и не очень нужен, но он поможет узнать имя ресурса.

Иногда нужно получить не сам идентификатор, а его имя (не значение), чтобы сохранить его, скажем, в базе данных. Воспользуйтесь следующим приёмом, используя метод getResourceEntryName():

Пример для строкового ресурса на Kotlin

Вложенные ресурсы

Можно использовать ссылки на ресурсы в качестве значений для атрибутов внутри других ресурсов (разметка, стили), что позволяет создавать специальные варианты визуальных тем, локализованных строк и графических объектов. Чтобы сослаться на один ресурс внутри другого, используйте символ @ в следующем виде:

Полное имя packagename нужно указывать только при использовании сторонних пакетов, при использовании собственных ресурсов данный параметр можно опустить, так как Android предполагает, что вы используете ресурсы пакета со своим приложением.

Использование системных ресурсов

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

Получение доступа к системным ресурсам внутри кода программы ничем не отличается от приведенных выше примеров. Единственно, в чем состоит отличие, это использование не вашего класса R, а системного класса android.R. Например, для получения строки, которая хранит сообщение об ошибке, используется следующий код:

Чтобы получить доступ к системным ресурсам внутри XML-файла, используйте значение android следующим образом:

Создание ресурсов для локализации и аппаратных конфигураций

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

Вы можете указывать альтернативные значения, создавая собственные структуры каталогов внутри каталога res при помощи дефиса (-). Например, мы хотим создать дополнительные строковые ресурсы для французского языка, франкоканадского региона и для русского языка. Тогда структура каталогов в проекте будет выглядять следующим образом:

Как видите, мы создали несколько файлов strings.xml, которые содержат текст на французском и русском языках и раскидали их по нужным каталогам. Далее приводится список возможных идентификаторов, которые можно использовать для создания альтернативных значений в ресурсах.

Регионы и язык можно указывать без всякой связи друг с другом. Так в папке values-ru-rJP будут храниться русские тексты для жителей Японии.

• Мобильный код страны и код мобильного оператора (MCC/MNC) — содержит информацию о стране и опционально о мобильной сети, которая привязана к SIM-карте. MCC (Mobile Country Code) состоит из символов mcc, за которыми следует трехзначный код страны. Также можно добавить MNC (Mobile Network Code), используя символы mnc и двухзначный код мобильной сети, например, mcc250-mnc99 (Россия-Билайн). Список кодов MCC/MNC можно посмотреть в Википедии.
• Язык и регион — указывает на язык при помощи языкового кода в формате ISO 639-1. Состоит из двух символов в нижнем регистре. В случае необходимости можно добавить обозначение региона в виде символа r и двухсимвольного кода в формате ISO 3166-1-alpha-2, записанного в верхнем регистре, например, en-rUS, en-rGB, fr-rCA.
• Размер экрана — может иметь одно из следующих значений:
  • small — меньше, чем HVGA, 3.2 дюйма
  • medium — HVGA или меньше, чем HVGA, типичный размер
  • large — VGA или больше, планшет или нетбук
• Высота и ширина экрана — можно использовать значения
  • long — для экранов, которые в альбомном режиме значительно шире, чем на стандартных смартфонах (таких как G1);
  • notlong — для экранов с обычным соотношением сторон
• Ориентация экрана — возможны значения port (Портретный), land (Альбомный), square (Квадратные экраны).
• Плотность пикселов на экране — возможны значения:
  • ldpi — предназначен для хранения ресурсов, рассчитанных на экраны с низкой плотностью пикселей (100–140 dpi);
  • mdpi — для экранов со средней плотностью пикселей (140–180 dpi);
  • hdpi — для экранов с высокой плотностью пикселей (190–250 dpi);
  • xdpi — новый тип для очень высокой плотности для планшетов
  • nodpi — Вы можете использовать значение nodpi для растровых ресурсов, которые не должны масштабироваться. В этом случае система не требует точного совпадения.

  Подбирая подходящий каталог, Android выберет тот спецификатор, который наиболее точно описывает плотность пикселей экрана устройства и откорректирует масштаб объекта Drawable. По умолчанию, в новом проекте создаются папки drawable-ldpi, drawable-mdpi, drawable-hdpi, drawable-xhdpi, в которых содержатся значки для приложения.

• Тип сенсорного экрана — возможны варианты: notouch, stylus, finger.
• Наличие клавиатуры — возможны варианты: keysexposed, keyshidden, keysoft.
• Тип ввода — возможны варианты: nokeys, qwerty, 12key.
• Способ навигации — возможны варианты: nonav, dpad, trackball, wheel.

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

Корректные варианты

Некорректные варианты

Пример с локализацией программы можно посмотреть в статье Локализация приложений.

Псевдонимы (alias)

Чтобы избежать дублирования ресурсов, можно использовать псевдонимы, которые будут ссылаться на один и тот же ресурс. Предположим вы создали два файла res/layout-land/activity_main.xml и res/layout-large/activity_main.xml с одинаковым содержанием для разметки с альбомной ориентацией для смартфонов и планшетов. Создайте теперь ещё один файл с таким же содержанием, например под именем res/layout/activity_main_horizontal.xml. Теперь два одинаковых файла можете удалить. Вместо них создайте два файла res/values-land/refs.xml и res/values-large/refs.xml.

Такой приём часто применяется при использовании фрагментов.

Получение идентификаторов ресурсов приложения

Врядли вам пригодится этот код в жизни. Для общего развития.

Источник