2.2.5 JSF OmniFaces
Компонента JSF платформы Java EE имеет множество реализаций. В данном учебном пособии используется проект OmniFaces.
В прикладном плане, наш проект labs готов для запуска первых демонстрационных примеров, но к нему необходимо подключить конкретную реализацию компонента JSF. Для этого, формально, имеются две реализации JSF, претендующие на роль эталонных решений:
а) проект Mojarra с открытым исходным кодом от компании Oracle, доступный в сервере приложений GlassFish;
б) проект MyFaces, который разрабатывается и продвигается организациейфондом Apache Software Foundation, доступный в частности в сервере приложений Apache TomEE.
Тем не менее, в связи с текущим состоянием дел и переменами, которые обсуждались в подразделе 1.5 первой главы, последняя версия JSF 2.3 проекта MyFaces не может быть использована в учебном процессе, поэтому далее используется сторонний проект OmniFaces с текущей версией 3.7.1 [25].
Данный пункт учебного пособия описывает последовательность шагов, достаточных для преобразования проекта Dynamic Web Project в проект обеспечивающий функционирование компонента JSF OmniFaces.
Подготовка проекта требует выполнения всего четырех операций, которые также демонстрируются рисунком 2.18:
1)положить файл omnifaces-3.7.1.jar, представляющий библиотеку JSF, в каталог WebContent/WEB-INF/lib/ проекта (выделено красным цветом);
2)создать в каталоге WebContent/META-INF/ файл context.xml, содержимое которого приведено на листинге 2.4 (выделено синим цветом);
3)создать в каталоге WebContent/WEB-INF/ файл beans.xml, содержимое которого приведено на листинге 2.5 (выделено зеленым цветом);
4)модифицировать дескриптор развертывания проекта (файл web.xml), как это показано на листинге 2.6.
Указанные четыре преобразования являются достаточными и могут быть применены к любому новому проекту , но не к проекту HttpServlet !
80
Рисунок 2.18 — Установка OmniFaces и файлов конфигурации в проекте labs
Файл omnifaces-3.7.1.jar — это последняя на момент написания пособия версия библиотеки JSF. Она реализована так, что может находиться только в указанном красным цветом месте проекта. В частости, любые библиотеки помещенные в этот каталог будут автоматически доступны проекту.
Листинг 2.4 — Дескриптор ресурсов context.xml проекта labs
<?xml version="1.0" encoding="UTF-8"?> <Context>
<Resource name="BeanManager" auth="Container"
type="javax.enterprise.inject.spi.BeanManager" factory="org.apache.webbeans.container.ManagerObjectFactory" />
</Context>
Файл context.xml — минимально необходимый для JSF дескриптор ресурсов сервера Apache Tomcat. В данном случае, указывается ресурс менеджера BeanManadger, который управляет прикладными компонентами проекта. В дальнейшем этот файл может использоваться для добавления других ресурсов необходимых проекту, например, ресурсов используемых баз данных.
Листинг 2.5 — Дескриптор развертывания CDI beans.xml проекта labs
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
81
http://xmlns.jcp.org/xml/ns/javaee/beans_2_0.xsd" bean-discovery-mode="all" version="2.0">
</beans>
Файл beans.xml — дескриптор развертывания управляемых компонентов CDI. Необходимость в нем отпала, поскольку использются аннотации, но нужен «пустой» файл с содержимым подобным содержимому листинга 2.5.
Листинг 2.6 — Дескриптор приложения web.xml проекта labs
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" version="4.0">
<!-- Имя проекта --> <display-name>labs</display-name>
<!-- Сервлеты и фильтры. -->
<servlet> <servlet-name>facesServlet</servlet-name>
<servlet-class>javax.faces.webapp.FacesServlet</servlet-class> <load-on-startup>1</load-on-startup>
</servlet>
<!-- Какие web-ресурсы - доступны --> <servlet-mapping>
<servlet-name>facesServlet</servlet-name> <url-pattern>*.xhtml</url-pattern>
</servlet-mapping> <servlet-mapping>
<servlet-name>facesServlet</servlet-name> <url-pattern>*.html</url-pattern>
</servlet-mapping>
<filter> <filter-name>characterEncodingFilter</filter-name>
<filter-class>org.omnifaces.filter.CharacterEncodingFilter</filter-class> </filter>
<filter-mapping> <filter-name>characterEncodingFilter</filter-name> <servlet-name>facesServlet</servlet-name>
</filter-mapping>
<filter> <filter-name>gzipResponseFilter</filter-name>
<filter-class>org.omnifaces.filter.GzipResponseFilter</filter-class> </filter>
<filter-mapping> <filter-name>gzipResponseFilter</filter-name> <servlet-name>facesServlet</servlet-name> <dispatcher>REQUEST</dispatcher>
82
<dispatcher>ERROR</dispatcher> </filter-mapping>
<filter> <filter-name>noCacheFilter</filter-name>
<filter-class>org.omnifaces.filter.CacheControlFilter</filter-class> </filter>
<filter-mapping> <filter-name>noCacheFilter</filter-name> <servlet-name>facesServlet</servlet-name>
</filter-mapping>
<filter> <filter-name>facesExceptionFilter</filter-name>
<filter-class>org.omnifaces.filter.FacesExceptionFilter</filter-class> </filter>
<filter-mapping> <filter-name>facesExceptionFilter</filter-name> <servlet-name>facesServlet</servlet-name>
</filter-mapping>
<!-- Листенеры - те, кто принимает какие-либо запросы --> <listener>
<listener-class>org.apache.webbeans.servlet.WebBeansConfigurationListener </listener-class>
</listener>
<!-- Ресурс, который может быть доступен по умолчанию --> <welcome-file-list>
<welcome-file>default.xhtml</welcome-file> <welcome-file>index.html</welcome-file>
</welcome-file-list>
</web-app>
Файл web.xml — главный дескриптор развертывания для проекта labs. В нем, в частности, описываются ресурсы, которые не были указаны в файле context.xml.
Выше, на листинге 2.6, указаны только ресурсы, необходимые для запуска JSF OmniFaces и достаточные для запуска наших демострационных примеров данного пункта. Когда наш проект будет развиваться, то среда разработки Eclipse EE может добавить в этот файл описание ресурсов, коорые необходимы дополнительно.
Если теперь запустить сервер приложений с проектом labs и обратиться к URI-ресурсу http://localhost:8080/labs/index.xhtml, то мы получим изображение шаблона рисунка 2.17, в виде показанном на рисунке 2.19.
Обратите внимание, что рисунки 2.17 и 2.19 отличаются только стилем отображения, но имеют общую геометрическую архитектуру размещения своих компонент. Если запустить любой браузер и обратиться к URI-ресурсу http://localhost:8080/labs/, то изображение шаблона не изменится.
83
Рисунок 2.19 — Изображение Facelets-шаблона /WEB-INF/templates/lab2Templ.xhtml
Каждый шаблон допускает множество вариантов использования.
Каждый Facelets-шаблон может использоваться для различных бизнесприложений. В этом и состоит основная парадигма программной платформы Java EE. Для этого используются теги, представленные ранее в таблице 2.4 . Например, тег <ui:define> переопределяет компоненту шаблона по его имени. Если изменить содержимое файла index.xhtml, как это показано на листинге 2.7, то изменится и вид подзаголочной страницы, а боковая страница будет удалена.
Листинг 2.7 — Содержимое файла index.xhtml проекта labs
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:ui="http://xmlns.jcp.org/jsf/facelets" xmlns:h="http://xmlns.jcp.org/jsf/html" xmlns:f="http://xmlns.jcp.org/jsf/core" xml:lang="ru">
<ui:composition template="/WEB-INF/templates/lab2Templ.xhtml"> <ui:define name="subheader">Новое содержание</ui:define> <ui:define name="menus"></ui:define>
</ui:composition> </html>
84