Поддержка обработчиков аннотаций в IDE NetBeans

Образец предоставлен Джесси Глик (Jesse Glick).

Содержание

Содержимое на этой странице применимо к IDE NetBeans 7.2, 7.3, 7.4 и 8.0

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

В первой части учебного курса описвается использование обработчика аноотаций от сторонних производителей, проекта Lombok в IDE NetBeans.

Во второй части учебного курса приводятся способы добавления собственного обработчика аннотаций в проект. Составитель образца кода для этой части учебного курса - Джесси Глик.

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

Программное обеспечение или материал	Требуемая версия
IDE NetBeans	7.2, 7.3, 7.4, 8.0
Комплект для разработчика на языке Java (JDK)	версия 7 или 8

Введение

Аннотации - это механизм языка программирования Java, используемый для указания метаданных об элементах приложения. Аннотации содержат метаинформацию о способах обработки аннотированных элементов компилятором во время развертывания или выполнения. Иными словами, аннотации – это комментарии к коду, которые могут обрабатываться другими программами и средствами.

Пользовательские аннотации можно использовать для выполнения различных задач: добавления пометок к частям приложения (напр., сведениям об авторских правах, методам тестирования и т. п.), автоматического создания кода, анализа параметров командной строки, разработки веб-служб и т. п. Информация о методах обработки пользовательских аннотаций передается компилятору Java при помощи пользовательских обработчиков аннотаций. JSR 269, реализованный в пакете JDK 6, содержит официальный интерфейс API для создания обработчиков аннотаций. Разработчик может создать собственные пользовательские обработчики аннотаций или использовать внешние решения.

Начальная информация об аннотациях в пакете JDK 6 приведена в следующих ресурсах:

Документация Java SE - Аннотации
Учебный курс Java SE - Аннотации

На практике аннотации наиболее широко используются в сочетании с интерфейсом API сохранения состояния Java (JPA), частью спецификации Java EE и другими технологиями, например JAXB (архитектура Java для XML Binding). При помощи JPA можно аннотировать классы Java как сущности, которые впоследствии сохраняются в памяти. Для разработки приложений на основе JPA целесообразно использовать платформы, например, платформу EclipseLink, входящую в состав среды IDE. В качестве начальной точки для получения дополнительных сведений о записи приложений на основе JPA в IDE NetBeans см. раздел Начало работы с приложениями Java EE.

Сопоставление параметров javac и команд среды IDE для обработки аннотации

Как уже упоминалось выше, обработка аннотации входит в программу javac из Java SE 6 в качестве неотъемлемой функции компилятора Java. При помощи компилятора по умолчанию выполняется автоматический поиск обработчиков аннотаций по пользовательскому пути поиска классов (если обработка аннотаций не отключена явным образом). Кроме того, можно указать путь поиска или путь к определенным обработчикам аннотаций при помощи параметров Javac. В приведенной ниже таблице приведено сопоставление параметров Javac, связанных с обработкой аннотации, и соответствующих команд в среде IDE. Дополнительные сведения о параметрах Javac в пакете JDK 6 можно найти на странице Javac - компилятор языка программирования Java.

Примечание. В IDE параметры обработки аннотаций для всех приложений Java за исключением приложений платформы NetBeans указаны в окне 'Свойства проекта'. Чтобы открыть "Свойства проекта", щелкните проект правой кнопкой мыши и выберите "Свойства".

Параметры Javac Java 6	Команда среды IDE	Описание
`-processor`	"Свойства проекта" > "Построение" > "Компиляция" > поле "Обработчики аннотаций". Укажите полностью определенное имя процессора аннотаций в поле "Обработчики аннотаций".	Явным образом указывает обработчик аннотаций, который необходимо выполнить. Благодаря этому параметру создание файлов настройки поставщика службы не требуется (META-INF/services/javax.annotation.processing.Processor)
`-proc:none`	"Свойства проекта" > "Сборка" > "Компиляция" > флажок "Включить обработку аннотаций" Если флажок не установлен, проект компилируется без обработки аннотации.	Компиляция выполняется без обработки аннотации. Механизм обнаружения обработчика аннотаций во время компиляции не используется.
`-processorpath`	"Свойства проекта" > "Библиотеки" > вкладка "Обработчик" Следует указать путь к проекту·среды IDE, библиотеке или файлу JAR, который содержит обработчик аннотаций. Рекомендуется использовать этот параметр, если обработчик аннотаций и аннотации упакованы в различные файлы JAR.	Указывает расположение обработчиков аннотаций. Если данный параметр отсутствует, поиск обработчиков выполняется по пути для поиска классов (см. ниже).
`-classpath`	"Свойства проекта" > "Библиотеки" > вкладка "Компиляция" Следует указать путь к проекту среды IDE, библиотеке или файлу JAR, который содержит процессор аннотаций и объявления аннотаций. Этот параметр рекомендуется использовать, если процессор аннотаций и аннотации упакованы в один файл JAR.	Указывает расположение пользовательских файлов классов, обработчиков аннотаций и исходных файлов (при необходимости). Поиск обработчиков аннотаций выполняется по этому пути, если не указан параметр "-processorpath".
`-Akey[=value]`	"Свойства проекта" > "Построить" > "Компиляция" > поле "Параметры обработчика" Добавьте параметры, которые требуется передать в обработчик аннотаций, связанный с проектом. Данное значение не является обязательным.	Параметры, которые необходимо передать в обработчики аннотаций (необязательно).