Общие сведения о внедрении контекстов и зависимостей и JSF 2.x

Внедрение контекстов и зависимостей (CDI), определяемое документом JSR-299, является неотъемлемой частью Java EE 6 и обеспечивает архитектуру, позволяющую компонентам Java EE (например, сервлетам, компонентам EJB и JavaBeans) существовать в жизненном цикле приложения с четко определенными контекстами. Кроме того, службы CDI позволяют компонентам Java EE (например, компонентам сеансов EJB и управляемым компонентам JavaServer Faces) внедряться и свободно взаимодействовать путем запуска и обработки событий.

Этот учебный курс основан на записи блога Энди Гибсона (Andy Gibson) Введение в JSF 2.0 и CDI в JEE 6. В нем рассматривается использование среды IDE для настройки веб-проекта Java с поддержкой JSF 2.0 и CDI. Затем описано связывание управляемых компонентов CDI со страницами Facelets и приводится краткий пример интеграции CDI и технологии EJB.

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

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

7.2, 7.3, 7.4, 8.0, пакет Java EE

Open Source Edition 3.x или 4.x

Создание веб-проекта Java с поддержкой CDI

В этом упражнении выполняется создание веб-проекта Java с поддержкой JSF 2.x и CDI.

Нажмите кнопку 'Создать проект' ( ) на главной панели инструментов IDE (Ctrl-Shift-N; ⌘-Shift-N в Mac).

В мастере создания проекта выберите категорию Java Web и команду "Веб-приложение". Нажмите кнопку "Далее".

Введите cdiDemo в качестве имени проекта и укажите местоположение проекта. Нажмите кнопку "Далее".

Выберите GlassFish в качестве сервера.

В качестве версии Java EE выберите Java EE 6 или Java EE 7 Web.

Если в качестве версии Java EE выбрана Java EE 6 Web, убедитесь, что выбран параметр "Разрешить внедрение контекстов и зависимостей". При выборе параметра "Включить внедрение контекстов и зависимостей" создается файл beans.xml в папке проекта WEB-INF при создании шаблона проекта. Файл beans.xml используется CDI для указания серверу, совместимому с Java EE, что проект является модулем, содержащим компоненты CDI. Java EE 6 Web поддерживает CDI 1.0, и в создаваемом файле beans.xml будет указана версия CDI 1.0.

Если в качестве версии Java EE указана Java EE 7 Web, по умолчанию включается поддержка версии CDI 1.1, и файл beans.xml не требуется. В Java EE 7 при отсутствии файла beans.xml развертываемый архив считается архивом неявного компонента bean. Файл beans.xml в приложениях Java EE 7 Web создается с помощью мастера создания файлов IDE. По умолчанию развернутый архив становится архивом явного компонента bean, поскольку в файле beans.xml указывается версия CDI 1.1 и атрибут bean-discovery-mode получает значение all .

Подробные сведения о типах архивов CDI см. в разделе Упаковка приложений CDI в руководстве по Java EE 7.

Нажмите кнопку "Далее".

На панели "Платформы" выберите параметр JavaServer Faces.

Перейдите на вкладку "Настройка" и убедитесь, что в качестве предпочтительного языка страницы выбран "Facelets". Нажмите кнопку "Завершить".

При нажатии кнопки "Завершить" в среде IDE создается проект веб-приложения и в редакторе открывается страница приветствия index.xhtml .

В окне "Проекты" разверните узел "Библиотеки > GlassFish Server". Вы увидите, что в этот узел автоматически добавлена библиотека weld-osgi-bundle.jar . В состав сервера GlassFish входит Weld, который является реализацией спецификации CDI JSR-299 от JBoss.

Обратите внимание, что если при создании проекта была выбрана версия Java EE 6 Web, папка "Web Pages > WEB-INF" будет содержать файл beans.xml . Файл пуст, но может использоваться как альтернатива аннотациям для указания информации, связанной с компонентами, в формате XML.

Доступ к Beans из языка выражений JSF

В этом упражнении демонстрируется способ связи компонентов, управляемых CDI, со страницами Facelets с помощью синтаксиса EL.

В окне "Проекты" щелкните правой кнопкой узел "Исходные файлы" и выберите команду "Создать" > "Класс Java".

В мастере создания класса Java введите имя класса MessageServerBean и введите exercise1 в поле "Пакет". Новый пакет будет создан после завершения работы мастера. Нажмите "Готово".

Создаются новый пакет и класс, после чего класс открывается в редакторе.

Добавьте к классу аннотации @Named и @Dependent и создайте одиночный метод для возврата строки.

Во время добавления аннотаций @Dependent и @Named нажмите сочетание клавиш Ctrl-Пробел, чтобы включить в редакторе поддержку автозавершения кода и документации Javadoc. Если применить аннотацию с помощью функций автозавершения кода редактора (например, выбрав подходящую аннотацию и нажав ENTER), в файл автоматически добавляется оператор `импорта `. Во всплывающем окне Javadoc также можно нажать кнопку 'Показывать документацию во внешнем веб-браузере' ( ) для отображения полноразмерного Javadoc в отдельном окне.

Сохраните файл (сочетание клавиш Ctrl-S; ⌘-S в Mac). После добавления аннотации @Named класс MessageServerBean стал _ управляемым компонентом _, в соответствии с определением CDI.

Переключитесь в редакторе на страницу Facelets index.xhtml (нажмите сочетание клавиш CTRL+TAB) и добавьте следующий текст в теги <h:body> .

Нажмите кнопку 'Запустить проект' ( ) на главной панели инструментов IDE. Файл компилируется и развертывается в GlassFish, и страница приветствия приложения ( index.xhtml `) отображается в веб-браузере. На странице отображается текст "Hello World!" из `MessageServerBean .

Вернитесь к компоненту сообщения и измените сообщение на другое (например, "Hello Weld!"). Сохраните файл (Ctrl-S; ⌘-S в Mac), затем обновите браузер. Автоматически отображается новое сообщение. Это происходит благодаря возможности "Развертывание при сохранении" среды IDE, все сохраненные изменения вызывают компиляцию и повторное развертывание на сервере.

В третьей строке на этой странице видно, что имя класса – exercise1.MessageServerBean Обратите внимание, что компонент представляет собой объект POJO (Plain Old Java Object, простой старый объект Java). Несмотря на использование Java EE, при разработке отсутствует комплексная иерархия классов, связанная уровнями транзакций, перехватами и другие сложные особенности.

При развертывании приложения сервер осуществляет поиск управляемых bean-компонентов CDI. В приложениях Java EE 7 классы на пути по умолчанию проверяются на наличие аннотаций CDI. В приложениях Java EE 6 классы проверяются на наличие аннотаций CDI, если модуль содержит файл beans.xml . В модуле CDI все компоненты регистрируются в Weld, и для сопоставления компонентов с точками внедрения используется аннотация @Named . При отображении страницы index.xhtml JSF пытается разрешить значение messageServerBean на странице с применением зарегистрированных средств разрешения выражений JSF. Одно из них – средство разрешения Weld EL имеет класс MessageServerBean , зарегистрированный под именем MessageServerBean Можно было указать другое имя в аннотации @Named , но поскольку это не было сделано, класс был зарегистрирован под именем по умолчанию, которое совпадает с именем класса, первая буква которого находится в нижнем регистре. Средство разрешения Weld возвращает экземпляр этого компонента в ответ на запрос JSF. Именование компонентов требуется только при использовании выражений EL и не должно использоваться в качестве механизма внедрения, поскольку CDI обеспечивает безопасность по типу при внедрении по типу класса и аннотациям квалификатора.

Переход к EJB

Благодаря EJB 3.1 и использованию стека Java EE можно с небольшими изменениями легко развертывать компонент в качестве EJB.

Откройте MessageServerBean и добавьте аннотацию javax.ejb.Stateless на уровне класса, затем замените строку на "Hello EJB!".

Сохраните файл (Ctrl-S; ⌘-S в Mac), затем перейдите в браузер и обновите. Отображается приблизительно следующее:

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

Также можно использовать аннотацию @Stateful . В качестве альтернативы можно использовать новую аннотацию @Singleton для экземпляров единичных классов. При этом существует две аннотации: javax.ejb.Singleton и javax.inject.Singleton . Эти аннотации соответствуют двум видам единичных классов. Единичный класс CDI javax.inject.Singleton позволяет определить экземпляр единичного класса вне EJB при использовании CDI в окружении, отличном от EJB. Единичный класс EJB javax.ejb.Singleton предоставляет все возможности EJB, например управление транзакциями. Поэтому можно сделать выбор в зависимости от потребностей и от того, используется ли среда EJB.

Дополнительные сведения

В следующей части рассматривается внедрение CDI и приводятся подробные сведения об использовании CDI для управления зависимостями в среде Java EE.

Дополнительные сведения о CDI и JSF 2.0 приведены в следующих материалах.