Помимо создания тестов, которые позволяют убедиться, что приложение соответствует функциональным требованиям, важно также проверить код с помощью инструмента lint, чтобы убедиться, что в нем нет структурных проблем. Инструмент lint помогает находить плохо структурированный код, который может повлиять на надежность и эффективность приложений Android и усложнить поддержку кода. Настоятельно рекомендуем исправить все ошибки, обнаруженные lint, перед публикацией приложения.
Например, если в XML-файлах ресурсов есть неиспользуемые пространства имен, они занимают место и требуют ненужной обработки. Другие структурные проблемы, такие как использование устаревших элементов или вызовов API, которые не поддерживаются целевыми версиями API, могут привести к неправильному выполнению кода. Lint может помочь вам устранить эти проблемы.
Чтобы повысить эффективность линтинга, вы также можете добавить аннотации в код.
Android CLI
Скачать Android CLIПопробуйте Android CLI для анализа файла
Например, используйте команду
android studio analyze-file, чтобы проверить файл на наличие ошибок, предупреждений и проблем с линтингом.android studio analyze-file <path>Обзор
В Android Studio есть инструмент для сканирования кода под названием lint. Он помогает выявлять и устранять проблемы со структурой кода без необходимости запускать приложение или писать отчеты о тестировании. Для каждой проблемы, обнаруженной инструментом, приводится описание и уровень серьезности, чтобы вы могли определить приоритетность необходимых улучшений. Вы также можете понизить уровень серьезности проблемы, чтобы игнорировать не относящиеся к вашему проекту проблемы, или повысить уровень серьезности, чтобы выделить определенные проблемы.
Инструмент lint проверяет исходные файлы проекта для Android на наличие потенциальных ошибок и возможностей оптимизации, чтобы обеспечить правильность, безопасность, производительность, удобство использования, доступность и интернационализацию. В Android Studio настроенные проверки lint и IDE выполняются при сборке приложения. Однако вы можете запустить проверки вручную или запустить lint из командной строки, как описано на этой странице.
Встроенный инструмент lint проверяет код, пока вы работаете в Android Studio. Посмотреть предупреждения и ошибки можно двумя способами:
- В виде всплывающего текста в окне редактора. Если инструмент находит проблему, он выделяет проблемный код желтым цветом. Для более серьезных проблем код подчеркивается красным.
- В окне Inspection Results (Результаты проверки), которое открывается при нажатии Code (Код) > Inspect Code (Проверить код).
Примечание. При компиляции кода в Android Studio выполняются дополнительные проверки кода IntelliJ, которые упрощают проверку кода. Регулярно обновляйте Android Studio, чтобы у вас всегда были доступны последние правила и проверки.
На рисунке 1 показано, как инструмент lint обрабатывает исходные файлы приложения.
- Исходные файлы приложения
- Исходные файлы – это файлы, из которых состоит ваш проект для Android, в том числе файлы Kotlin и XML, значки и файлы конфигурации ProGuard.
- Файл
lint.xml - Файл конфигурации, в котором можно указать, какие проверки lint нужно исключить, и настроить уровни серьезности проблем.
- Инструмент lint
- Инструмент для статического анализа кода, который можно запустить в проекте для Android из командной строки или в Android Studio. Инструмент lint проверяет структурные проблемы в коде, которые могут повлиять на качество и производительность приложения для Android.
- Результаты проверки
- Результаты проверки можно посмотреть в консоли или в окне Inspection Results (Результаты проверки) в Android Studio. Если вы запускаете
lintиз командной строки, результаты записываются в папкуbuild/. Подробнее о том, как запустить проверку вручную…
Как запустить lint из командной строки
Если вы используете Android Studio или Gradle, вызовите задачу lint для проекта с помощью оболочки Gradle, введя одну из следующих команд в корневом каталоге проекта:
Примечание. Чтобы использовать последние правила lint, обновляйте плагин Android Gradle.
- В Windows
gradlew lint
- На устройстве Linux или macOS:
./gradlew lint
Вы должны получить примерно такой результат:
> Task :app:lintDebug Wrote HTML report to file:<path-to-project>/app/build/reports/lint-results-debug.html
После завершения проверки инструмент lint предоставляет пути к XML- и HTML-версиям отчета. Затем вы можете перейти к отчету в формате HTML и открыть его в браузере, как показано на рисунке 2.
Если в проекте есть варианты сборки, lint проверяет только вариант по умолчанию. Если вы хотите запустить lint для другого варианта, напишите его название заглавными буквами и добавьте префикс lint.
./gradlew lintRelease
Примечание. Lint не запускается автоматически в рамках сборки. Мы настоятельно рекомендуем запускать lint в рамках непрерывной интеграции, чтобы при сборке существующего исходного кода вы видели последние проверки lint.
Подробнее о том, как запускать задачи Gradle из командной строки…
Как запустить lint с помощью отдельного инструмента
Если вы не используете Android Studio или Gradle, установите инструменты командной строки Android SDK, чтобы использовать автономный инструмент lint. Найдите инструмент lint в папке android_sdk/cmdline-tools/version/bin/lint.
Примечание. Если вы попытаетесь запустить автономный инструмент в проекте Gradle, появится сообщение об ошибке. Для запуска lint в проекте Gradle всегда используйте gradle lint (в Windows) или ./gradlew
lint (в macOS или Linux).
Чтобы запустить lint для списка файлов в каталоге проекта, используйте следующую команду:
lint [flags] <project directory>
Например, вы можете выполнить следующую команду для сканирования файлов в каталоге myproject и его подкаталогах. Идентификатор проблемы MissingPrefix указывает lint, что нужно искать только атрибуты XML, у которых отсутствует префикс пространства имен Android.
lint --check MissingPrefix myproject
Чтобы посмотреть полный список флагов и аргументов командной строки, поддерживаемых инструментом, используйте следующую команду:
lint --help
Ниже показан вывод консоли после запуска команды lint для проекта Earthquake.
$ lint Earthquake Scanning Earthquake: ............................................................................................................................... Scanning Earthquake (Phase 2): ....... AndroidManifest.xml:23: Warning: <uses-sdk> tag appears after <application> tag [ManifestOrder] <uses-sdk android:minSdkVersion="7" /> ^ AndroidManifest.xml:23: Warning: <uses-sdk> tag should specify a target API level (the highest verified version; when running on later versions, compatibility behaviors may be enabled) with android:targetSdkVersion="?" [UsesMinSdkAttributes] <uses-sdk android:minSdkVersion="7" /> ^ res: Warning: Missing density variation folders in res: drawable-xhdpi [IconMissingDensityFolder] 0 errors, 4 warnings
В примере выходных данных показаны три предупреждения и ни одной ошибки.
Два предупреждения относятся к файлу AndroidManifest.xml проекта:
ManifestOrderUsesMinSdkAttributes
Одно предупреждение относится к каталогу res:
IconMissingDensityFolder.
Как настроить lint, чтобы отключить предупреждения
По умолчанию при сканировании lint проверяет все поддерживаемые проблемы. Вы также можете ограничить проблемы, которые проверяет lint, и назначить уровни серьезности для проблем. Например, вы можете отключить проверку на наличие определенных проблем, которые не имеют отношения к вашему проекту, и настроить lint так, чтобы некритические проблемы помечались как менее серьезные.
Возможные уровни серьезности:
enabledisableилиignoreinformationalwarningerrorfatal
Вы можете настроить проверку lint для разных уровней:
- Глобально (весь проект)
- Модуль "Проекты"
- Модуль производства
- Тестовый модуль
- Открыть файлы
- Иерархия классов
- Области действия системы управления версиями (VCS)
Настройте файл lint
Вы можете указать настройки проверки lint в файле lint.xml. Если вы создаете этот файл вручную, поместите его в корневой каталог проекта Android.
Файл lint.xml состоит из родительского тега <lint>, который содержит один или несколько дочерних элементов <issue>. Lint определяет уникальное значение атрибута id для каждого элемента <issue>:
<?xml version="1.0" encoding="UTF-8"?> <lint> <!-- list of issues to configure --> </lint>
Чтобы изменить уровень серьезности проблемы или отключить проверку lint для нее, задайте атрибут severity в теге <issue>.
Совет. Чтобы получить полный список проблем, поддерживаемых lint, и их идентификаторов, выполните команду lint --list. Параметр --list необходимо запускать из автономного инструмента lint.
Пример файла lint.xml
Ниже показано содержимое файла lint.xml.
<?xml version="1.0" encoding="UTF-8"?> <lint> <!-- Disable the ComposableNaming check in this project --> <issue id="ComposableNaming" severity="ignore" /> <!-- Ignore the ComposeUnrememberedState issue in the specified files --> <issue id="ComposeUnrememberedState"> <ignore path="src/main/java/com/example/myapp/MainActivity.kt" /> <ignore path="src/main/java/com/example/myapp/ui/components/SpecialButton.kt" /> </issue> <!-- Ignore the ComposeModifierMissing issue in the specified file --> <issue id="ComposeModifierMissing"> <ignore path="src/main/java/com/example/myapp/ui/screens/HomeScreen.kt" /> </issue> <!-- Change the severity of hardcoded strings to "error" --> <issue id="HardcodedText" severity="error" /> </lint>
В этом примере показано, как настраиваются разные типы проблем. Проверка ComposableNaming полностью отключена, а проверка ComposeUnrememberedState отключена только в файлах, указанных в декларациях <ignore ... />.
Как настроить проверку lint для исходных файлов Kotlin и XML
Вы можете отключить проверку lint для исходных файлов Kotlin и XML в диалоговом окне Preferences (Настройки).
- Выберите File (Файл) > Settings (Настройки) (в Windows) или Android Studio > Preferences (Настройки) (в macOS или Linux).
- Выберите Editor (Редактор) > Inspections (Проверки).
- Чтобы отключить, отмените выбор нужного исходного файла.
Вы можете задать их для всей интегрированной среды разработки или для отдельных проектов, выбрав нужный профиль.
Как настроить проверку кода в Kotlin
Чтобы отключить проверку lint для определенного класса или функции в проекте для Android, добавьте в код аннотацию @SuppressLint.
В примере ниже показано, как отключить проверку lint для проблемы NewApi в определенной функции. Инструмент lint продолжит проверять наличие проблемы NewApi в других функциях этого класса.
@SuppressLint("NewApi") fun logNotificationChannelInfo() { // Uses NotificationChannel (requires API 26+) // ... }
То же самое можно сделать с любой composable-функцией. В следующем фрагменте кода показано, как отключить проверки NewApi для любой composable-функции.
@SuppressLint("NewApi") @Composable fun MyComposable() { // ... }
В следующем примере показано, как отключить проверку lint для проблемы ParserError в классе FeedProvider:
@SuppressLint("ParserError") class FeedProvider : ContentProvider() {
Чтобы отключить проверку всех проблем в файле, используйте ключевое слово all:
@SuppressLint("all")
Вы можете использовать ту же аннотацию, чтобы подавить проверки lint для любой Composable-функции.
Как настроить проверку lint в XML
Используйте атрибут tools:ignore, чтобы отключить проверку lint для определенных разделов XML-файлов. Чтобы инструмент lint распознал атрибут, добавьте в файл lint.xml следующее значение пространства имен:
namespace xmlns:tools="http://schemas.android.com/tools"В следующем примере показано, как отключить проверку lint для проблемы UnusedResources в элементе <resources> файла strings.xml. Атрибут ignore наследуется дочерними элементами родительского элемента, в котором он объявлен. В этом примере проверка также отключена для всех вложенных элементов <string>:
<resources xmlns:tools="http://schemas.android.com/tools" tools:ignore="UnusedResources" > <string name="app_name">My App</string> <string name="unused_string">Unused String</string> </resources>
Чтобы отключить несколько проблем, перечислите проблемы, которые нужно отключить, в строке, разделенной запятыми. Пример:
tools:ignore="NewApi,StringFormatInvalid"
Чтобы отключить проверку всех проблем в элементе XML, используйте ключевое слово all:
tools:ignore="all"
Как настроить параметры lint с помощью Gradle
Плагин Android Gradle позволяет настраивать определенные параметры lint, например какие проверки выполнять, а какие игнорировать, с помощью блока lint{} в файле build.gradle на уровне модуля.
В приведенном ниже фрагменте кода показаны некоторые свойства, которые можно настроить.
Kotlin
android { ... lint { // Turns off checks for the issue IDs you specify. disable += "TypographyFractions" + "TypographyQuotes" // Turns on checks for the issue IDs you specify. These checks are in // addition to the default lint checks. enable += "RtlHardcoded" + "RtlCompat" + "RtlEnabled" // To enable checks for only a subset of issue IDs and ignore all others, // list the issue IDs with the 'check' property instead. This property overrides // any issue IDs you enable or disable using the properties above. checkOnly += "NewApi" + "InlinedApi" // If set to true, turns off analysis progress reporting by lint. quiet = true // If set to true (default), stops the build if errors are found. abortOnError = false // If set to true, lint only reports errors. ignoreWarnings = true // If set to true, lint also checks all dependencies as part of its analysis. // Recommended for projects consisting of an app with library dependencies. checkDependencies = true } } ...
Яркий
android { ... lint { // Turns off checks for the issue IDs you specify. disable 'TypographyFractions','TypographyQuotes' // Turns on checks for the issue IDs you specify. These checks are in // addition to the default lint checks. enable 'RtlHardcoded','RtlCompat', 'RtlEnabled' // To enable checks for only a subset of issue IDs and ignore all others, // list the issue IDs with the 'check' property instead. This property overrides // any issue IDs you enable or disable using the properties above. checkOnly 'NewApi', 'InlinedApi' // If set to true, turns off analysis progress reporting by lint. quiet true // If set to true (default), stops the build if errors are found. abortOnError false // If set to true, lint only reports errors. ignoreWarnings true // If set to true, lint also checks all dependencies as part of its analysis. // Recommended for projects consisting of an app with library dependencies. checkDependencies true } } ...
Все методы lint, которые переопределяют заданный уровень серьезности проблемы, учитывают порядок конфигурации. Например, если вы пометили проблему как критическую в finalizeDsl(), то она будет проверяться, даже если вы отключили ее в основном DSL.
Создайте базовый уровень предупреждений
Вы можете сделать снимок текущего набора предупреждений проекта, а затем использовать его в качестве базового для будущих проверок, чтобы сообщалось только о новых проблемах. С помощью базового снимка вы можете начать использовать lint для прерывания сборки, не исправляя все существующие проблемы.
Чтобы создать базовый снимок, измените файл build.gradle проекта следующим образом:
Kotlin
android { lint { baseline = file("lint-baseline.xml") } }
Яркий
android { lintOptions { baseline file("lint-baseline.xml") } }
При первом добавлении этой строки создается файл lint-baseline.xml, который устанавливает базовый уровень. После этого инструменты только считывают файл, чтобы определить базовый уровень. Если вы хотите создать новый базовый файл, удалите старый вручную и запустите lint снова.
Затем запустите lint из IDE, выбрав Code (Код) > Inspect Code (Проверить код), или из командной строки, как показано ниже. В выходных данных будет указано местоположение файла lint-baseline.xml. Расположение файла в вашей системе может отличаться от указанного ниже.
$ ./gradlew lintDebug -Dlint.baselines.continue=true ... Wrote XML report to file:///app/lint-baseline.xml Created baseline file /app/lint-baseline.xml
При запуске lint все текущие проблемы записываются в файл lint-baseline.xml. Набор текущих проблем называется базовым. Если вы хотите поделиться файлом lint-baseline.xml с другими пользователями, добавьте его в систему управления версиями.
Настройте базовые показатели
Если вы хотите добавить в базовый план только определенные типы проблем, укажите их в файле build.gradle проекта:
Kotlin
android { lint { checkOnly += "NewApi" + "HandlerLeak" baseline = file("lint-baseline.xml") } }
Яркий
android { lintOptions { checkOnly 'NewApi', 'HandlerLeak' baseline file("lint-baseline.xml") } }
Если вы добавите в базу кода новые предупреждения после создания базового плана, lint будет показывать только новые ошибки.
Предупреждение о контрольном значении
Когда контрольная точка действует, вы получаете информационное предупреждение о том, что одна или несколько проблем были отфильтрованы, поскольку они перечислены в контрольной точке. Это предупреждение напоминает о том, что вы настроили базовый уровень и вам нужно исправить все проблемы.
Это информационное предупреждение также отслеживает проблемы, о которых больше не сообщается. Эта информация позволяет узнать, действительно ли вы устранили проблемы, чтобы при необходимости повторно создать базовый план и предотвратить повторное появление ошибки.
Примечание. Базовые показатели включаются при запуске проверок в пакетном режиме в IDE, но игнорируются при проверках в редакторе, которые выполняются в фоновом режиме при редактировании файла. Это связано с тем, что базовые показатели предназначены для случая, когда база кода содержит большое количество существующих предупреждений, но вы хотите исправить проблемы локально, пока работаете с кодом.
Как запустить проверку вручную
Чтобы вручную запустить настроенные проверки Lint и другие проверки IDE, выберите Code (Код) > Inspect Code (Проверить код). Результаты проверки появятся в окне Inspection Results (Результаты проверки).
Как задать область проверки и профиль
Выберите файлы, которые нужно проанализировать (область проверки), и проверки, которые нужно выполнить (профиль проверки), следующим образом:
- В представлении Android откройте проект и выберите проект, папку или файл, который нужно проанализировать.
- В строке меню выберите Code (Код) > Inspect Code (Проверить код).
В диалоговом окне Specify Inspection Scope (Указать область проверки) проверьте настройки.
Рисунок 3. Проверьте настройки области проверки. В диалоговом окне Specify Inspection Scope (Указать область проверки) будут доступны разные варианты в зависимости от того, что вы выбрали: проект, папку или файл.
- Если вы выберете один проект, файл или каталог, в диалоговом окне Specify Inspection Scope (Указать область проверки) будет показан путь к выбранному объекту.
- Если вы выберете несколько проектов, файлов или каталогов, в диалоговом окне Specify Inspection Scope (Указать область проверки) будет выбран переключатель Selected files (Выбранные файлы).
Чтобы изменить объект проверки, выберите другой переключатель. Описание всех возможных полей в диалоговом окне Specify Inspection Scope (Укажите область проверки) приведено в разделе Диалоговое окно Specify Inspection Scope (Укажите область проверки).
- В разделе Профиль проверки выберите нужный профиль.
Нажмите ОК, чтобы запустить проверку.
На рисунке 4 показаны результаты проверки кода с помощью Lint и других инструментов IDE.
Рисунок 4. Результаты проверки. Выберите проблему, чтобы узнать, как ее решить. -
На панели Inspection Results (Результаты проверки) разверните и выберите категории, типы или проблемы, чтобы посмотреть результаты проверки.
На панели Отчет о проверке отображается отчет о проверке для категории, типа или проблемы, выбранной на панели Результаты проверки, а также название и местоположение ошибки. В отчете о проверке также может быть представлена другая информация, например краткое описание проблемы, которая поможет вам ее устранить.
В дереве аккаунта на панели Результаты проверки нажмите правой кнопкой мыши на категорию, тип или проблему, чтобы открыть контекстное меню.
В зависимости от контекста вы можете:
- Перейти к источнику.
- Исключить и включить выбранные объекты.
- Скрыть проблемы.
- Измените настройки.
- Управление оповещениями о проверках.
- Повторно запустите проверку.
Описание кнопок на панели инструментов, пунктов контекстного меню и полей отчета о проверке можно найти в разделе Окно инструмента Inspection Results.
Как использовать специальную область действия
Используйте одну из специальных областей, доступных в Android Studio:
- В диалоговом окне Specify Inspection Scope (Указать область проверки) выберите Custom scope (Пользовательская область).
Нажмите на список Специальная область действия, чтобы посмотреть доступные варианты.
Рисунок 5. Выберите нужную область действия. - Все места. Все файлы.
- Файлы проекта. Все файлы в текущем проекте.
- Исходные файлы проекта. Только исходные файлы в текущем проекте.
- Файлы проекта. Только рабочие файлы в текущем проекте.
- Тестовые файлы проекта. Только тестовые файлы в текущем проекте.
- Scratches and Consoles (Временные файлы и консоли). Только временные файлы и консоли, открытые в текущем проекте.
- Недавно просмотренные файлы. Только недавно просмотренные файлы в текущем проекте.
- Текущий файл. Только текущий файл в текущем проекте. Появляется, когда выбран файл или папка.
- Выбранный каталог. Только текущая папка в текущем проекте. Появляется, когда выбрана папка.
- Иерархия классов. Если вы выберете этот вариант и нажмете ОК, появится диалоговое окно со всеми классами в текущем проекте. В диалоговом окне используйте поле Поиск по названию, чтобы отфильтровать и выбрать классы для проверки. Если вы не отфильтруете список классов, проверка кода будет выполнена для всех классов.
- Нажмите ОК.
Если для проекта настроена система контроля версий, вы также можете ограничить поиск только измененными файлами.
Как создать специальную область действия
Если вы хотите проверить набор файлов и каталогов, который не охвачен ни одной из доступных пользовательских областей, вы можете создать пользовательскую область:
- В диалоговом окне Specify Inspection Scope (Указать область проверки) выберите Custom scope (Пользовательская область).
Нажмите на значок с тремя точками рядом со списком Специальная область действия.
Рисунок 6. Specify Inspection Scope (Указать область проверки). Откроется диалоговое окно Scopes (Области действия).
Рисунок 7. Создайте специальную область действия. - Нажмите кнопку
в левом верхнем углу диалогового окна, чтобы задать новую область действия. - В появившемся списке Добавить область действия выберите Локальная.
Обе области действия используются в проекте для функции Inspect Code (Проверить код). Область действия Общая также может использоваться с другими функциями проекта, у которых есть поле области действия. Например, если вы нажмете Edit Settings (Изменить настройки)
, чтобы изменить настройки для Find Usages (Найти использования), в открывшемся диалоговом окне будет поле Scope (Область), в котором можно выбрать общую область.
Рисунок 8. Выберите общую область действия в диалоговом окне Find Usages (Найти варианты использования). - Укажите название области действия и нажмите ОК.
В правой части диалогового окна Области действия появятся параметры, позволяющие задать пользовательскую область действия.
- В списке выберите Проект.
Появится список доступных проектов.
Примечание. Вы можете создать собственную область действия для проектов или пакетов. Инструкции будут такими же.
Разверните папки проекта, выберите, что вы хотите добавить в специальную область действия, и укажите, нужно ли включить или исключить выбранное.
Рисунок 9. Задайте собственную область действия. - Включить. Включить эту папку и ее файлы, но не включать ее подпапки.
- Включить рекурсивно. Включить эту папку и ее файлы, а также ее подпапки и их файлы.
- Исключить. Исключить эту папку и ее файлы, но не исключать ее подпапки.
- Исключить рекурсивно. Исключить эту папку и ее файлы, а также ее подпапки и их файлы.
На рисунке 10 показано, что папка main включена, а папки java и res включены рекурсивно. Синим цветом выделены папки, включенные частично, а зеленым – папки и файлы, включенные рекурсивно.
Рисунок 10. Пример шаблона для специальной области действия. - Если вы выберете папку java и нажмете Exclude Recursively (Исключить рекурсивно), зеленая подсветка исчезнет с папки java и всех папок и файлов в ней.
- Если вы выберете выделенный зеленым файл MainActivity.kt и нажмете Exclude (Исключить), он перестанет быть выделенным, но все остальные файлы в папке java останутся зелеными.
- Нажмите ОК. Специальная область действия появится внизу списка.
Как посмотреть и изменить профили проверки
В Android Studio есть набор профилей для проверки кода, которые обновляются вместе с Android. Вы можете использовать эти профили в исходном виде или изменить их названия, описания, уровни серьезности и области действия. Вы также можете активировать и деактивировать целые группы профилей или отдельные профили в группе.
Чтобы открыть настройки проверок, сделайте следующее:
- Выберите File (Файл) > Settings (Настройки). (в Windows) или Android Studio > Preferences (Android Studio > Настройки) (в macOS или Linux).
- Выберите Editor (Редактор) > Inspections (Проверки).
-
На панели Inspections (Проверки) показан список поддерживаемых проверок и их описания.
Рисунок 11. Поддерживаемые проверки и их описания. В списке Profile (Профиль) выберите Default (По умолчанию) (Android Studio) или Project Default (По умолчанию для проекта) (активный проект).
Дополнительную информацию можно найти на странице Manage profiles (Управление профилями) в документации IntelliJ.
В списке Inspections (Проверки) на панели слева выберите категорию профиля верхнего уровня или разверните группу и выберите определенный профиль.
Выбрав категорию профиля, вы можете изменить все проверки в этой категории как одну проверку.
- Нажмите на значок Показать действия со схемой
, чтобы скопировать, переименовать, экспортировать или импортировать проверку, а также добавить к ней описание. - Нажмите ОК.