Jun 24 2009 at 18:40

Знакомьтесь, JBoss Seam

Invite pending

В комментариях к статье высказывалась мысль, что в Java-мире Spring Framework с его Inversion of Control является стандартом de facto. Позвольте представить вам framework, который незаслуженно обделён вниманием в русскоязычном интернете и, тем не менее, претендует на звание стандарта de jure.

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

Введение

JBoss Seam – это каркас для приложений на основе Java EE, разрабатываемый командой JBoss и распространяемый по лицензии LGPL. Руководитель проекта – Pete Muir. Идейный двигатель проекта – Gavin King, известный Java-сообществу как создатель популярного ORM решения Hibernate. В данный момент под руководством Гэвина идет работа над спецификацией Web Beans (JSR-299), которая уже находится на стадии Final Draft и выложена на публичное обозрение. Этот факт примечателен тем, что JSR-299 включен в платформу Java EE 6 в качестве унифицированной модели компонентов для Enterprise Java. И начиная с версии Seam 3.0, ядро фреймворка будет фактически являться имплементацией Web Beans. Кстати, насколько мне известно, руководство SpringSource проигнорировало предложение присоединиться к экспертной группе JSR-299 и принять участие в разработке спецификации (разработка ведется при участии представителей JBoss, Sun, Oracle, а также Google, в качестве создателя Guice). Помимо этого, Кинг приложил руку и к созданию спецификаций JSF 2.0, JPA 1.1 и EJB 3.1. Тем интереснее выглядит детище Кинга в глазах приверженцев стандартов. Так в чем же преимущества Seam перед другими фреймворками?

Особенности

Как сказал Dan Allen, разработчик Seam 3.0: «В мире, переполненном фреймворками, Seam – это unframework». Seam не заключает нас в рамки использования какой-либо новой модели программирования. Вместо этого, он обеспечивает простую интеграцию стандартов Java EE, в первую очередь EJB3, JSF, JPA и JAAS (Java Authentication and Authorization Service), и делает их более доступными, функциональными и приятными в использовании. Seam – не просто очередной фреймворк для генерации HTML-страниц. Это полноценный каркас для веб-приложений. Seam рассматривает такие проблемы, как сохранение состояния объектов, конкурентные запросы, асинхронные события, управление состоянием, безопасность, генерация PDF-файлов и графиков, workflows, wikitext, веб-сервисы, кэширование и многое другое.

Seam объединяет JPA и Hibernate3 для persistence-уровня, EJB Timer Service и Quartz для обработки асинхронных событий, jBPM для описания workflow, JBoss Rules для бизнес-правил, Meldware Mail для отправки электронной почты, JMS для сообщений, Hibernate Search и Lucene для полнотекстового поиска, JBoss Cache для кэширования фрагментов страницы. Seam использует инновационный слой безопасности, управляемой правилами на основе JBoss Rules. Даже есть библиотеки JSF тегов для PDF, диаграмм, отправки почты и wiki-текста. Компоненты Seam можно вызывать посредством обращения через веб-сервисы, асинхронно из JavaScript или Google Web Toolkit, ну и, конечно же, напрямую из JSF. О каждом из этих аспектов использования Seam можно написать целую статью. А пока затронем лишь основные моменты.

Унифицированная модель компонентов

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

Seam не различает компоненты презентационного уровня и компоненты бизнес-логики. А это значит, что Вы можете проектировать своё приложение, как Вам вздумается, вместо того, чтобы втискивать логику приложения в неестественную архитектуру, продиктованную комбинацией фреймворков. Конечно, никто не запрещает создавать модульную архитектуру при использовании Seam. Отличие лишь в том, что теперь Вы, а не фреймворк, решаете, какие уровни должны присутствовать в приложении, и как они будут взаимодействовать.

Интеграция JSF с EJB 3

С помощью Seam вполне возможно написать приложение, где каждый компонент – EJB. В принципе неудивительно, что после EJB 2.x большинство Java-разработчиков считают EJB-компоненты некими «тяжеловесными» объектами. Тем не менее, версия EJB 3.0 полностью изменила подход к созданию EJB. Теперь это не более чем аннотированный Java Bean. И Seam даже одобряет использование session-бинов в качестве слушателей JSF действий.

С другой стороны, если в данный момент Вы предпочитаете не использовать EJB, то Вам и не обязательно этого делать. Фактически, любой Java класс может быть компонентом Seam. И Seam предоставляет все функциональные возможности, которые ожидаются от «легковесных» контейнеров для любых компонентов, будь то EJB или обычный Java Bean.

AJAX

Seam поддерживает два, основанных на JSF, AJAX-фреймворка: JBoss RichFaces и ICEfaces. Оба этих решения позволяют ощутить всю мощь AJAX'а без написания какого-либо JavaScript кода. В качестве альтернативы Seam предлагает собственный JavaScript remoting, позволяющий вызывать компоненты асинхронно из JavaScript без необходимости создания промежуточного слоя.

Пример приложения

Вероятно, разговор о стандартах платформы Java EE и о роли Seam, в качестве связующего звена этих самых стандартов, создает впечатление некой «монструозности». Но это далеко не соответствует истине. С помощью Seam можно достаточно быстро получить работающий прототип приложения, затратив минимум усилий. Я специально рассматриваю в качестве небольшого тестового приложения упрощенный контакт-лист из Seam examples. Минимум кода (а Java-код для CRUD-операций вообще отсутствует), но прочувствовать простоту использования фреймворка в контексте JPA+JSF уже можно.

Итак, опишем простую сущность Contact с полями name, address и phone

package org.jboss.seam.example.contactlist; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.Id; import javax.persistence.Version; import org.hibernate.validator.Length; @Entity public class Contact { @Id @GeneratedValue private Long id; @Length(max=50) private String name; @Length(max=250) private String address; @Length(max=20) private String phone; @Version private int version; /* геттеры и сеттеры опущены, но они есть! */ } * This source code was highlighted with Source Code Highlighter. Для тех, кто знаком с Java Persistence API, здесь ничего нового. Также для реализации CRUD операций нам потребуется задействовать класс org.jboss.seam.framework.EntityHome (не путать с интерфейсом EJBHome), предоставляющий спектр базовых операций по управлению состоянием экземпляра Entity конкретного типа. В нашем примере достаточно описать его в components.xml – базовый дескриптор для Seam-приложений, располагается в директории WEB-INF. В более сложных случаях возможно потребуется создать подкласс на основе EntityHome или же написать свой компонент. <?xml version="1.0" encoding="UTF-8"?> <components xmlns="http://jboss.com/products/seam/components" xmlns:core="http://jboss.com/products/seam/core" xmlns:fwk="http://jboss.com/products/seam/framework" xmlns:persistence="http://jboss.com/products/seam/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://jboss.com/products/seam/core jboss.com/products/seam/core-2.1.xsd jboss.com/products/seam/framework jboss.com/products/seam/framework-2.1.xsd jboss.com/products/seam/persistence jboss.com/products/seam/persistence-2.1.xsd jboss.com/products/seam/components jboss.com/products/seam/components-2.1.xsd"> <persistence:managed-persistence-context name="entityManager" persistence-unit-jndi-name="java:/contactlistEntityManagerFactory"/> <core:init jndi-pattern="jboss-seam-contactlist/#{ejbName}/local"/> <factory name="contact" value="#{contactHome.instance}"/> <fwk:entity-home name="contactHome" entity-class="org.jboss.seam.example.contactlist.Contact"/> <fwk:entity-query name="contacts" max-results="5"> <fwk:ejbql>from Contact</fwk:ejbql> <fwk:order>name</fwk:order> <fwk:restrictions> <value>lower(name) like lower( concat( #{exampleContact.name}, '%' ) )</value> </fwk:restrictions> </fwk:entity-query> <component name="exampleContact" class="org.jboss.seam.example.contactlist.Contact"/> </components> * This source code was highlighted with Source Code Highlighter. Здесь entityManager – компонент, реализующий интерфейс javax.persistence.EntityManager. Jndi-имя фабрики задается в обычном persistence.xml. Тег factory реализует паттерн «Factory Method». В данном случае при обращении к компоненту по имени «contact» будет вызван метод getInstance() у компонента contactHome. Этот метод возвращает нам чистый объект, который можно будет отредактировать и записать в базу данных, или же достанет из БД существующий объект, если перед вызовом getInstance() мы вызвали setId() у EntityHome-компонента с параметром, равным идентификатору нужной нам сущности. Кстати, можно обойтись и без явного вызова setId(), но об этом позднее. С описанием contactHome вопросов не возникает. А вот fwk:entity-query вызывает куда больший интерес. Этот тег делает прозрачным для разработчика создание и работу с javax.persistence.Query, а также поддерживает пагинацию результатов запроса без дополнительного кода. Ну и дополнительный компонент exampleContact, который потребуется для организации поиска контактов. Да и вообще, инкапсуляция параметров запроса в подходящий объект – хороший тон. Как видно из описания компонента contacts, параметры для поиска контактов мы достаём именно из него. Еще нам потребуются 2 facelet'а. Первый из них – search.xhtml: <!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://java.sun.com/jsf/facelets" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core" xmlns:s="http://jboss.com/products/seam/taglib"> <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <title>Contact List</title> <link href="screen.css" rel="stylesheet" type="text/css" /> </head> <body> <div class="menuButtons"> <s:link view="/search.xhtml" value="Search Contacts"> <f:param name="name" /> <f:param name="firstResult" /> </s:link> <s:link view="/editContact.xhtml" value="Create New Contact"> <f:param name="contactId"/>  </s:link> </div> <div class="body"> <h1>ContactList</h1> <h:messages styleClass="message"/>  <div class="dialog"> <h:form> Name: <h:inputText value="#{exampleContact.name}"/> <h:commandButton value="Search" action="newsearch"/> </h:form> </div>  <table> <tr> <th>Name</th> <th>Phone</th> <th>Address</th> </tr> <ui:repeat value="#{contacts.resultList}" var="cont"> <tr> <td> <s:link view="/editContact.xhtml" value="#{cont.name}"> <f:param name="contactId" value="#{cont.id}"/> </s:link> </td> <td>#{cont.phone}</td> <td>#{cont.address}</td> </tr> </ui:repeat> </table> <h:outputText value="No contacts to display" rendered="#{empty contacts.resultList}" styleClass="message"/>  <div class="tableControl"> <s:link view="/search.xhtml" rendered="#{contacts.previousExists}" value="<< First Page"> <f:param name="firstResult" value="0"/> </s:link> <s:link view="/search.xhtml" rendered="#{contacts.previousExists}" value="< Previous Page"> <f:param name="firstResult" value="#{contacts.previousFirstResult}"/> </s:link> <s:link view="/search.xhtml" rendered="#{contacts.nextExists}" value="Next Page >"> <f:param name="firstResult" value="#{contacts.nextFirstResult}"/> </s:link> <s:link view="/search.xhtml" rendered="#{contacts.nextExists}" value="Last Page >>"> <f:param name="firstResult" value="#{contacts.lastFirstResult}"/> </s:link> </div> </div> </body></html> * This source code was highlighted with Source Code Highlighter.Обращаю ваше внимание на тот факт, что тег s:link генерирует html-элемент «a», со всеми вытекающими последствиями. Да-да, Seam позволяет использовать GET для JSF запросов! И в ближайшем будущем (JSF 2.0) этот функционал будет определен в спецификации. А в остальном, мы видим обращения посредством expression language к компонентам, описанным в components.xml. Правда и в EL Seam внёс свои коррективы. Например, в приведенном выше коде мы видим обращение к cont.phone, cont.address вне JSF тегов, что позволяет обойтись без лишних элементов типа h:outputText. На самом деле интерполяция строковых выражений (а равно и локализация приложений) в Seam реализована на очень высоком уровне. К примеру, если Вы используете Hibernate Validator, Вы можете указать в качестве message-атрибута аннотации NotNull (и не только этой) строку вида "#{messages.validate.null_field}". Помимо этого, JBoss EL при использовании JSF вкупе с Facelets позволяет использовать параметры для методов и создавать совершенно логичные с точки зрения разработчика конструкции, которые невозможны в JSP: <h:dataTable value="#{items}" var="item"> <h:сolumn> <h:commandLink value="Select #{item.name}" action="#{itemSelector.select(item})" /> </h:column> </h:dataTable> * This source code was highlighted with Source Code Highlighter. Второй facelet – editContact.xhtml: <!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://java.sun.com/jsf/facelets" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core" xmlns:s="http://jboss.com/products/seam/taglib" template="template.xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <title>Edit Contact</title> <link href="screen.css" rel="stylesheet" type="text/css" /> </head> <body> <div class="menuButtons"> <s:link view="/search.xhtml" value="Search Contacts"/> <s:link view="/editContact.xhtml" value="Create New Contact"> <f:param name="contactId"/>  </s:link> <s:link view="/editContact.xhtml" value="Edit Contact" rendered="#{contactHome.managed}"/> </div> <div class="body"> <h1>Edit Contact</h1> <h:form> <h:messages globalOnly="true" styleClass="message"/>  <s:validateAll> <f:facet name="aroundInvalidField"> <s:span styleClass="errors"/> </f:facet> <f:facet name="afterInvalidField"> <s:span> <s:message/></s:span> </f:facet> <div class="dialog"> <table> <tr class="prop"> <td class="name">Name:</td> <td class="value"> <s:decorate><h:inputText id="name" value="#{contact.name}" required="true"/></s:decorate> </td> </tr> <tr class="prop"> <td class="name">Phone:</td> <td class="value"> <s:decorate><h:inputText id="phone" value="#{contact.phone}"/></s:decorate> </td> </tr> <tr class="prop"> <td class="name">Address:</td> <td class="value"> <s:decorate><h:inputText id="address" value="#{contact.address}"/></s:decorate> </td> </tr> </table> </div> </s:validateAll>  <div class="actionButtons"> <h:commandLink action="#{contactHome.update}" value="Update Contact" rendered="#{contactHome.managed}"/> <s:link action="#{contactHome.remove}" value="Delete Contact" rendered="#{contactHome.managed}"/> <h:commandLink action="#{contactHome.persist}" value="Create Contact" rendered="#{!contactHome.managed}"/> <s:link view="/search.xhtml" value="Cancel"/> </div> </h:form> </div> </body></html> * This source code was highlighted with Source Code Highlighter.Здесь мы видим пару новых тегов: s:validateAll и s:decorate. Первый из них задействует механизм проверки правильности ввода данных, второй выводит ошибки для поля, если введенное значение некорректно. Но основной функционал здесь возлагается на компонент contactHome. Как мы видим contactHome предоставляет разработчику стандартный набор CRUD операций (persist, update, remove), а также флаг managed для определения принадлежности объекта persistence-контексту (иными словами, существует ли он в БД, или мы создаём новый). Но всё-таки, как contactHome определяет какой именно объект нам нужен? Ведь мы обошлись без разбора GET-параметров, и не вызывали явно метод contactHome.setId(). Или как выполняется навигация после успешного выполнения операции contactHome.remove? Чтобы всё встало на свои места, рассмотрим еще один конфигурационный файл pages.xml, находится рядом с components.xml в директории WEB-INF. <?xml version="1.0" encoding="UTF-8"?><pages xmlns="http://jboss.com/products/seam/pages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://jboss.com/products/seam/pages jboss.com/products/seam/pages-2.1.xsd"> <page view-id="/editContact.xhtml">  <param name="contactId" value="#{contactHome.id}" converterId="javax.faces.Long"/>  <navigation> <rule if-outcome="updated"> <redirect view-id="/search.xhtml"/> </rule> <rule if-outcome="persisted"> <redirect view-id="/search.xhtml"/> </rule> <rule if-outcome="removed"> <redirect view-id="/search.xhtml"/> </rule> </navigation> </page> <page view-id="/search.xhtml"> <param name="name" value="#{exampleContact.name}"/> <param name="firstResult" value="#{contacts.firstResult}"/> <navigation>  <rule if-outcome="newsearch"> <redirect view-id="/search.xhtml"> <param name="firstResult" value="0"/> </redirect> </rule> </navigation> </page> <exception class="javax.persistence.PersistenceException"> <end-conversation/> <redirect>  <message>Database access failed</message> </redirect> </exception> <exception class="org.jboss.seam.framework.EntityNotFoundException"> <http-error error-code="404"/> </exception> <exception> <end-conversation/> <redirect view-id="/search.xhtml"> <message>Unexpected failure</message> </redirect> </exception></pages> * This source code was highlighted with Source Code Highlighter. После просмотра вышеприведенного кода складывается ложное мнение, что Seam – это программирование на XML. На самом деле я выбрал именно этот пример лишь потому, что в подобных статьях, как правило, появляются комментарии вида: «А вот в Ruby...». Базовая реализация CRUD-операций уже встроена в фреймворк, и доступна разработчику через класс EntityHome, а конкретный экземпляр этого класса можно описать всего одной строкой в конфигурационном файле. Но в большинстве случаев Seam всё же предполагает использование Java Bean (EJB или POJO) компонентов с аннотациями. Seam расширяет аннотации EJB 3.0 своим собственным набором для декларативного управления состоянием объекта и работы с контекстами. И одним из основополагающих принципов Seam является минимизация конфигурационных файлов. Это позволяет избежать надоедливых объявлений managed-bean'ов, и уменьшить количество требуемого XML за исключением той информации, которая по определению соответствует структуре XML-документа (навигационные правила в JSF). Иными словами, в приложении, написанном на Seam+JSF, может полностью отсутствовать faces-config.xml. Вообще в пользу Seam можно перечислить множество вещей. Это и динамическая биекция зависимостей (или просто bijection), радикальн

Hubs:

Lumber room