Атрибуты tools

Хотя Jetpack Compose обрабатывает инструменты проектирования пользовательского интерфейса непосредственно в Kotlin, пространство имен tools: по-прежнему необходимо для конфигураций на уровне проекта. В стандартных XML-файлах Android, таких как AndroidManifest.xml и res/raw/keep.xml, используются атрибуты tools: для управления предупреждениями Lint и настройки сокращения ресурсов.

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

Чтобы использовать эти атрибуты, добавьте пространство имен tools в корневой элемент каждого XML-файла, в котором вы хотите их использовать, как показано ниже:

<RootTag xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools" >

Атрибуты для обработки ошибок

Следующие атрибуты помогают подавлять предупреждения lint:

tools:ignore

Для каких элементов подходит: для любых.

Используется в Lint.

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

Например, вы можете указать, что нужно игнорировать ошибку MissingTranslation:

<string name="show_all_apps" tools:ignore="MissingTranslation">All</string>

tools:targetApi

Для каких элементов подходит: для любых.

Используется в Lint.

Этот атрибут работает так же, как аннотация @TargetApi в коде Java или аннотация @RequiresApi в коде Kotlin. Он позволяет указать уровень API (в виде целого числа или кодового названия), который поддерживает этот элемент.

Это сообщает инструментам lint, что вы считаете, что этот элемент и любые дочерние элементы используются только на указанном уровне API или выше. В этом случае инструмент Lint не будет предупреждать вас, если элемент или его атрибуты недоступны на уровне API, указанном в качестве minSdkVersion.

Например, вы можете использовать этот атрибут, если объявляете в файле AndroidManifest.xml элемент <service>, который использует тип активной службы, доступный только на уровне API 34 и выше, но в вашем проекте используется более низкий уровень minSdkVersion:

<service
    android:name=".playback.MediaPlaybackService"
    android:foregroundServiceType="mediaPlayback"
    xmlns:tools="http://schemas.android.com/tools"
    tools:targetApi="34" />

tools:locale

Для кого: <resources>

Используется: Lint, редактор Android Studio.

Это позволяет инструментам определить язык или региональные настройки по умолчанию для ресурсов в указанном элементе <resources> и избежать предупреждений от средства проверки правописания. В противном случае инструмент будет считать, что язык – английский.

Значение должно быть действительным модификатором региональных настроек.

Например, вы можете добавить этот атрибут в файл values/strings.xml, чтобы указать, что по умолчанию используется испанский язык, а не английский:

<resources xmlns:tools="http://schemas.android.com/tools"
    tools:locale="es">

Атрибуты удаления неиспользуемых ресурсов

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

Чтобы включить удаление неиспользуемых ресурсов, задайте для свойства shrinkResources значение true в файле build.gradle, а также для свойства minifyEnabled – значение для сокращения кода.

Пример:

Яркий

android {
    ...
    buildTypes {
        release {
            shrinkResources true
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'),
                    'proguard-rules.pro'
        }
    }
}

Kotlin

android {
    ...
    buildTypes {
        getByName("release") {
            isShrinkResources = true
            isMinifyEnabled = true
            proguardFiles(
                getDefaultProguardFile("proguard-android.txt"),
                "proguard-rules.pro"
            )
        }
    }
}

tools:shrinkMode

Для кого: <resources>

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

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

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

По умолчанию используется безопасный режим (shrinkMode="safe"). Чтобы включить строгий режим, добавьте shrinkMode="strict" в тег <resources>, как показано ниже:

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:shrinkMode="strict" />

Если вы включите строгий режим, вам может потребоваться использовать tools:keep, чтобы сохранить удаленные ресурсы, которые вам нужны, и tools:discard, чтобы явно удалить ещё больше ресурсов.

Подробнее об уменьшении ресурсов…

tools:keep

Для кого: <resources>

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

При удалении неиспользуемых ресурсов этот атрибут позволяет указать ресурсы, которые нужно сохранить. Обычно это ресурсы, на которые есть косвенные ссылки во время выполнения, например при передаче динамически созданного имени ресурса в Resources.getIdentifier.

Чтобы использовать этот инструмент, создайте XML-файл в каталоге ресурсов (например, res/raw/keep.xml) с тегом <resources> и укажите каждый ресурс, который нужно сохранить, в атрибуте tools:keep в виде списка, разделенного запятыми. В качестве подстановочного знака можно использовать звездочку.

Пример:

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@layout/used_1,@layout/used_2,@layout/*_3" />

Подробнее о сокращении ресурсов…

tools:discard

Для кого: <resources>

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

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

Чтобы использовать эту функцию, создайте XML-файл в каталоге ресурсов (например, res/raw/keep.xml) с тегом <resources> и укажите каждый ресурс, который нужно удалить, в атрибуте tools:discard в виде списка, разделенного запятыми. В качестве подстановочного знака можно использовать звездочку.

Пример:

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:discard="@layout/unused_1" />

Подробнее об уменьшении ресурсов…

Дополнительные ресурсы

Просмотр контента