Статический анализ кода в редакторе Java IDE NetBeans

В редакторе Java IDE NetBeans реализована новая функция статического анализа кода, которая является инструментом для поиска возможных ошибок и обнаружения несогласованностей в исходном коде.

В данном учебном курсе описано выполнение статического анализа кода Java с помощью FindBugs и подсказок Java NetBeans без непосредственного запуска приложений.

Требования

Для работы с этим учебным курсом требуются программное обеспечение и ресурсы, перечисленные ниже.

Версия 7 и более поздние версии

Запрос спецификации Java предназначен для улучшения эффективности инструментов статического анализа

Примечание. Файл jsr305-2.0.0.jar включен в архив library.zip только для выполнения заданий данного практического руководства.

При работе с другими проектами NetBeans файл jsr305-2.0.0.jar необходимо загрузить отдельно и добавить в папку 'Библиотеки' проекта в IDE следующим образом:

Щелкните правой кнопкой мыши папку 'Библиотеки' и выберите 'Добавить файл JAR/папку' во всплывающем меню.

В диалоговом окне 'Добавить файл JAR/папку' укажите путь к загруженному файлу jsr305-2.0.0.jar и щелкните 'Открыть'.

Установка среды учебного курса

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

Файл library.zip необходимо разархивировать в папку проекта NetBeans и открыт в IDE NetBeans.

Подключаемый модуль FindBugs необходимо загрузить и установить в IDE NetBeans следующим образом:

Выберите 'Источник' > 'Проверка' в главном меню IDE.

В диалоговом окне "Проверка" щелкните "Установить".

В диалоговом окне 'Программа установки' щелкните 'Далее', чтобы продолжить установку.

Прочтите лицензионное соглашение, выберите положение лицензионного соглашения и щелкните 'Установить'.

По завершении установки нажмите кнопку "Готово".

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

При проверке кода в IDE NetBeans можно использовать заранее определенные конфигурации:

Конфигурация Все средства анализа развертывает все инструменты статического анализа кода, доступные в IDE.

Для запуска конфигурации Все анализаторы выполните следующие шаги:

Выберите 'Источник' > 'Проверка' на главной панели инструментов IDE.

В раскрывающемся списке 'Область' диалогового окна 'Проверка' выберите Текущий проект (библиотека) .

В раскрывающемся списке 'Конфигурация' выберите конфигурацию Все средства анализа .

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

Нажмите кнопку "Проверить". Результаты анализа отображаются в окне 'Инспектор' в представлении дерева слева.

Описание текущего выбранного результата в представлении дерева отображается справа.

Примечание. Если вы хотите оставить некоторую часть кода, которая описана в отчете как содержащая ошибки без изменений, IDE позволяет подавить предупреждения для этого кода, чтобы оставить его без изменений. Можно дважды щелкнуть предупреждение в представлении дереве в окне 'Инспектор', чтобы перейти в редактор исходного кода. Нажмите Alt-Enter, нажмите на черную стрелку, указывающую вправо в конце отображаемой подсказки и выберите SuppressWarning - (имя предупреждения) .

Конфигурация Подсказки Java NetBeans , доступная в IDE, позволяет проверить, удовлетворены ли заранее определенные правила стандартов написания кода рассматриваемым исходным кодом. Другими словами, он применяет набор подсказок Java NetBeans (также называется проверками кода) к исходным файлам Java.

Для запуска конфигурации Подсказки Java NetBeans выполните следующие шаги:

Выберите 'Источник' > 'Проверка' на главной панели инструментов IDE.

В раскрывающемся списке 'Область' диалогового окна 'Проверка' выберите Открыть проект (если имеется только одна библиотека проект будет открыт в среде IDE) or Текущий проект (библиотека) .

Примечание. Можно определить область (файлы. пакеты или проекты) для конфигурации Подсказки Java NetBeans .

Выберите переключатель 'Конфигурация' и выберите Подсказки Java NetBeans в раскрывающемся списке.

Нажмите кнопку "Проверить". В среде IDE отображается представление дерева с результатами анализа с конфигурацией Подсказки Java NetBeans в окне 'Инспектор'.

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

В следующей таблице перечислены команды, доступные в окне 'Инспектор'.

Обновить

Отображается обновленный список результатов статического анализа.

Предыдущая проблема

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

Следующая проблема

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

Категоризировать

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

Конфигурация FindBugs , доступная в IDE, позволяет найти широкий диапазон возможных проблем в коде. Он вызывает популярный инструмент FindBugs для работы с открытым исходным кодом для анализа кода Java. Создается отчет об ошибках, и он отображается в окне реорганизации в IDE NetBeans, в котором разделяются по категориям все обнаруженные проблемы, и обеспечивается возможность навигации напрямую от ошибок в отчете к подозрительному коду. Также можно прочитать описание ошибок в смежном окне или просмотреть его на странице Описание ошибок FindBugs спомощью указателя в верхней части левого фрейма.

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

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

Откройте проект library в IDE NetBeans и выберите 'Исходный код' > 'Проверка' в главном меню.

В раскрывающемся списке 'Область' диалогового окна 'Проверка' выберите Текущий проект (библиотека) .

Примечание. Можно проверить файлы, пакеты или проекты с помощью конфигурации FindBugs .

В диалоговом окне 'Проверка' выберите конфигурацию FindBugs .

Щелкните кнопку 'Инспектор' для запуска статического анализа кода. Результат статического анализа кода отображается в окне 'Инспектор' ниже редактора исходного кода. Описание выбранной проблемы отображается в фрейме справа.

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

Примечания

Если дважды щелкнуть проблему в развернутом списке, в IDE отображается указанная в отчете проблема в редакторе исходного кода. Нажмите Alt-Enter для просмотра описания проблемы в исходном коде.

Возможные проблемы выделены в коде значком восклицательного знака ( ) на левой границе редактора исходного кода.

Для включения FindBugs в редакторе Java выполните следующие шаги:

Выберите 'Сервис' > 'Параметры' на главной панели инструментов IDE.

Перейдите на вкладку 'Редактор' и выберите 'Подсказки'.

Выберите FindBugs в раскрывающемся списке 'Язык'.

Выберите 'Выполнить FindBugs' в параметре 'Редактор'.

Нажмите кнопку "ОК". Если сейчас нажать Alt-Enter в исходном коде, где сообщается о проблеме, и щелкнуть черную стрелку в конце отображаемой подсказки, в IDE показываются некоторые варианты исправления возможных проблем.

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

Для персонализации заранее настроенной конфигурации По умолчанию в соответствии с требованиями, выполните следующие шаги:

Выберите 'Источник' > 'Проверка' на главной панели инструментов IDE.

В диалоговом окне 'Проверка' выберите переключатель 'Конфигурация' и выберите конфигурация по умолчанию .

Нажмите Управлять. IDE отображает диалоговое окно 'Конфигурации'.

Убедитесь, что в раскрывающемся списке 'Конфигурация' выбрано По умолчанию .

В раскрывающемся списке 'Средство анализа' выберите средство анализа Соответствие профилей JRE 8 , Подсказки Netbeans Java или FindBugs .

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

Нажмите ОК, чтобы сохранить конфигурацию По умолчанию .

Создание и удаление конфигурации

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

Для создания конфигурации выполните следующие шаги:

Выберите 'Источник' > 'Проверка' на главной панели инструментов IDE.

В диалоговом окне 'Проверка' выберите переключатель 'Конфигурация' и выберите конфигурация по умолчанию .

В диалоговом окне 'Конфигурация' щелкните черную стрелку в конце раскрывающегося списка 'Конфигурация' и выберите 'Создать'.

Создается конфигурация newConfig и добавляется в раскрывающийся список 'Конфигурации'.

В раскрывающемся списке 'Средство анализа' выберите Соответствие профилей JRE 8 , Подсказки Netbeans Java или FindBugs .

Укажите профиль, проверки или ошибки для включения в вашу конфигурацию.

Нажмите ОК, чтобы сохранить правки и закрыть диалоговое окно 'Конфигурацию'. Созданная конфигурация newConfig доступна в раскрывающемся списке 'Конфигурация' в диалоговом окне 'Инспектор'.

Примечание. Чтобы переименовать конфигурацию, выберите конфигурацию newConfig в раскрывающемся списке 'Конфигурация', щелкните черную стрелку в конце раскрывающегося списка 'Конфигурация' и выберите 'Переименовать'. Введите новое имя (например, renamedConfig ) и нажмите клавишу Enter, чтобы сохранить правки.

Для удаления конфигурации выполните следующие шаги:

Выберите 'Источник' > 'Проверка' на главной панели инструментов IDE.

В диалоговом окне 'Проверка' нажмите переключатель 'Конфигурация' и выберите конфигурацию для удаления (в этом примере renamedConfig ).

В диалоговом окне 'Конфигурации' щелкните черную стрелку в конце раскрывающегося списка 'Конфигурация' и выберите 'Удалить'.

В диалоговом окне 'Удалить конфигурацию' щелкните 'Да', чтобы подствердить удаление конфигурации.

Конфигурация renamedConfig удалена из списка 'Конфигурации'.

Примечание. Lля получения информации о том, как создать модуль NetBeans, который предоставляет одну или несколько подсказок Java NetBeans см. Учебный курс по модулю подсказок Java NetBeans.

Выполнение отдельных проверок

Исходный код можно проверить на наличие определенной проблемы в с помощью функции статического анализа в IDE NetBeans.

Для выявления конкретного несоответствия или проблемы в исходном коде Java при выполнении одной проверки, выполните следующие шаги:

Выберите 'Источник' > 'Проверка' в главном меню IDE.

В раскрывающемся списке 'Область' диалогового окна 'Проверка' укажите файл, пакет или проект(-ы), которые требуется проверить.

Выберите 'Отдельная проверка' и выполните одно из следующих действий:

В раскрывающемся списке 'Отдельная проверка' с помощью прокрутки перейдите и выделите одну подсказку Java NetBeans или проблему FindBugs, которые будут использоваться при анализе исходного кода.

Щелкните 'Обзор', чтобы открыть диалоговое окно 'Конфигурации', и в раскрывающемся списке 'Средство анализа' укажите средство анализа, выберите профиль (для средства анализа Соответствие профиля JRE 8), одну проверку (для средства анализа NetBeans Java Hints) и одну ошибку (для средства анализа NetBeans Java Hints), которая будет использоваться в анализе исходного кода. Нажмите кнопку 'ОК', чтобы закрыть диалоговое окно 'Конфигурации'.

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

Заключение

В этом учебном курсе описываются наиболее распространенные варианты использования функции статического анализа кода в IDE NetBeans. Обратите внимание, что с помощью функции статического анализа кода можно также выполнять пользовательскую реорганизацию в контексте проекта или применять специальные настройки реорганизации к нескольким проектам, открытым в IDE, и т. п.