SEAM学习（一）-----安装运行example

1.下载jboss seam并解压

2.安装ant：解压bin版本，新建ANT_HOME，并将其bin目录添加到系统path

3.更改seam的build.properties，添加jboss.home D:\\DevelopTool\\jboss-4.2.2.GA。注意路径后边不能有空格

4.用cmd转到examples的registration目录下，运行ant deploy

5.浏览器：http://localhost:8080/seam-registration



分析：

user

//$Id: User.java 2360 2006-10-25 20:17:46Z gavin $
package org.jboss.seam.example.registration;

import static org.jboss.seam.ScopeType.SESSION;

import java.io.Serializable;

import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Table;

import org.hibernate.validator.Length;
import org.hibernate.validator.NotNull;
import org.jboss.seam.annotations.Name;
import org.jboss.seam.annotations.Scope;

@Entity
@Name("user")//组件名称
@Scope(SESSION)//作用范围

/*Seam组件需要一个 组件名称，此名称由注解 @Name来指定。此名称必须在Seam应用内唯一。

当JSF用一个与组件同名的名称去请求Seam来解析上下文变量， 且该上下文变量尚未定义（null）时，

Seam就将实例化那个组件，并将新实例绑定给上下文变量。 在此例中，Seam将在JSF第一次遇到名为 user 的变量时实例化 User。

每当Seam实例化一个组件时，它就将始化后的实例绑定给组件中 默认上下文 的上下文变量。

默认的上下文由 @Scope注解指定。 User Bean是个会话作用域的组件。*/

@Table(name="users")
public class User implements Serializable
{
   private static final long serialVersionUID = 1881413500711441951L;
  
   private String username;
   private String password;
   private String name;
  
   public User(String name, String password, String username)
   {
      this.name = name;
      this.password = password;
      this.username = username;
   }
  
   public User() {}
  
   @NotNull
   public String getName()
   {
      return name;
   }

   public void setName(String name)
   {
      this.name = name;
   }
  
   @NotNull @Length(min=5, max=15) //hibernate校验
   public String getPassword()
   {
      return password;
   }

   public void setPassword(String password)
   {
      this.password = password;
   }
  
   @Id @NotNull @Length(min=5, max=15)//@NotNull 和 @Length 注解是

                   Hibernate Validator框架的组成部份，

    // Seam集成了Hibernate Validator并让你用它来作为数据校验。

   public String getUsername()
   {
      return username;
   }

   public void setUsername(String username)
   {
      this.username = username;
   }
  
   @Override
   public String toString()
   {
      return "User(" + username + ")";
   }
}



---------------------------------------------------------------------------------------------

register接口：

//$Id: Register.java 2056 2006-09-28 00:36:56Z gavin $
package org.jboss.seam.example.registration;

import javax.ejb.Local;

@Local
public interface Register
{
   public String register();
}



-----------------------------------------------------------------------------------------------

register action

//$Id: RegisterAction.java 5298 2007-06-20 00:08:47Z gavin $
package org.jboss.seam.example.registration;

import java.util.List;

import javax.ejb.Stateless;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;

import org.jboss.seam.annotations.In;
import org.jboss.seam.annotations.Logger;
import org.jboss.seam.annotations.Name;
import org.jboss.seam.faces.FacesMessages;
import org.jboss.seam.log.Log;

@Stateless
@Name("register")//组件名称
public class RegisterAction implements Register
{

   @In //注解 @In将Bean的一个属性标记为由Seam来注入。 在此例中，此属性由名为 user 的上下文变量注入（实例的变量名）。

   private User user;
  
   @PersistenceContext
   private EntityManager em;
  
   @Logger
   private static Log log;
  
   public String register()
   {
      List existing = em.createQuery("select u.username from User u where u.username=#{user.username}")
         .getResultList();
     
      if ( existing.size()==0 )
      {
         em.persist(user);
         log.info("Registered new user #{user.username}");
         return "/registered.jspx";
      }
      else
      {
         FacesMessages.instance().add("User #{user.username} already exists");



//Seam提供了大量的 内置组件（built-in components） 来协助解决那些经常遇到的问题。

  用 FacesMessages 组件就可很容易地来显示模板化的错误或成功的消息。 内置的Seam组件还可由注入或通过调用 instance() 方法来获取。

         return null;

//多个JSF动作监听器方法返回一个字符串值的输出，它决定了接下来应显示的页面内容。

  空输出（或返回值为空的动作监听器方法）重新显示上一页的内容.
      }
   }

}

Seam组件需要一个 组件名称，此名称由注解 @Name来指定。此名称必须在Seam应用内唯一。当JSF用一个与组件同名的名称去请求Seam来解析上下文变量， 且该上下文变量尚未定义（null）时，Seam就将实例化那个组件，并将新实例绑定给上下文变量。 在此例中，Seam将在JSF第一次遇到名为 user 的变量时实例化 User。 每当Seam实例化一个组件时，它就将始化后的实例绑定给组件中 默认上下文 的上下文变量。默认的上下文由 @Scope注解指定。 User Bean是个会话作用域的组件。



页面：

<?xml version="1.0" encoding="utf-8"?>
<!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:s="http://jboss.com/products/seam/taglib"
      xmlns:h="http://java.sun.com/jsf/html"
      xmlns:f="http://java.sun.com/jsf/core">

   <head>
      <title>Register New User</title>
   </head>
   <body>
      <f:view>
         <h:form>
            <s:validateAll>这里的 <s:validateAll>标签是Seam特有的。

                            该JSF组件告诉JSF让它用实体Bean中所指定的Hibernat验证器注解来验证所有包含输入的字段。
               <h:panelGrid columns="2">
                  Username: <h:inputText value="#{user.username}" required="true"/>
                  Real Name: <h:inputText value="#{user.name}" required="true"/>
                  Password: <h:inputSecret value="#{user.password}" required="true"/>
               </h:panelGrid>
            </s:validateAll>
            <h:messages/>
            <h:commandButton value="Register" action="#{register.register}"/>
         </h:form>
      </f:view>
   </body>

</html>



registered

<?xml version="1.0" encoding="utf-8"?>
<!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:f="http://java.sun.com/jsf/core">

   <head>
      <title>Successfully Registered New User</title>
   </head>
   <body>
      <f:view>
         Welcome, #{user.name}, you are successfully registered as #{user.username}.
      </f:view>
   </body>

</html>



--------------------------------------------------------------------------------------------------------------------

部署描述文件：
（1）Seam组件部署描述文件：components.xml

如果你此前曾接触过许多的Java框架，你就会习惯于将所有的组件类放在某种XML文件中来声明，那些文件就会随着项目的不断成熟而不断加大到最终到不可收拾的地步。对于Seam应用，你尽可放心，因为它并不要求应用组件都要有相应的XML。大部份的Seam应用要求非常少量的XML即可，且XML文件大小不会随着项目的增大而快速增长。

无论如何，若能为 某些 组件（特别是Seam内置组件）提供某些 外部配置往往是有用的。这样一来，我们就有几个选择， 但最灵活的选择还是使用位于 WEB-INF 目录下的 components.xml 配置文件。 我们将用 components.xml 文件来演示Seam怎样在JNDI中找到EJB组件:

<components xmlns="http://jboss.com/products/seam/components"
            xmlns:core="http://jboss.com/products/seam/core">
     <core:init jndi-pattern="@jndiPattern@"/>
</components>

此代码配置了Seam内置组件 org.jboss.seam.core.init 的 jndiPattern 属性。这里需要奇怪的@符号是因为ANT脚本会在部署应用时将正确的JNDI语法在标记处自动填补
（2）Web部署描述文件：web.xml

我们将以WAR的形式来部署此小应用的表示层，因此需要web部署描述文件。

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
                        http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

    <!-- Seam -->

    <listener>
        <listener-class>org.jboss.seam.servlet.SeamListener</listener-class>
    </listener>

    <!-- MyFaces -->

    <listener>
        <listener-class>
            org.apache.myfaces.webapp.StartupServletContextListener
        </listener-class>
    </listener>

    <context-param>
        <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
        <param-value>client</param-value>
    </context-param>

    <servlet>
        <servlet-name>Faces Servlet</servlet-name>
        <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!-- Faces Servlet Mapping -->
    <servlet-mapping>
        <servlet-name>Faces Servlet</servlet-name>
        <url-pattern>*.seam</url-pattern>
    </servlet-mapping>

</web-app>

此 web.xml 文件配置了Seam和JSF。所有Seam应用中的配置与此处的配置基本相同。
（3）JSF配置：faces-config.xml

绝大多数的Seam应用将JSF来作为表示层。因而我们通常需要 faces-config.xml。SEAM将用Facelet定义视图表现层，所以我们需要告诉JSF用Facelet作为它的模板引擎。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE faces-config
PUBLIC "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN"
                            "http://java.sun.com/dtd/web-facesconfig_1_0.dtd">
<faces-config>

    <!-- A phase listener is needed by all Seam applications -->

    <lifecycle>
        <phase-listener>org.jboss.seam.jsf.SeamPhaseListener</phase-listener>
    </lifecycle>

</faces-config>

注意我们不需要申明任何JSF managed Bean！因为我们所有的managed Bean都是通过经过注释的Seam组件。所以在Seam的应用中，faces-config.xml比原始的JSF更少用到。

实际上，一旦你把所有的基本描述文件配置完毕，你所需写的 唯一类型的 XML文件就是导航规则及可能的jBPM流程定义。对于Seam而言， 流程（process flow） 及 配置数据 是唯一真正属于需要XML定义的。

在此简单的示例中，因为我们将视图页面的ID嵌入到Action代码中，所以我们甚至都不需要定义导航规则。
（4）EJB部署描述文件：ejb-jar.xml

ejb-jar.xml 文件将 SeamInterceptor 绑定到压缩包中所有的会话Bean上，以此实现了Seam与EJB3的整合。

<ejb-jar xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/ejb-jar_3_0.xsd"
         version="3.0">

   <interceptors>
     <interceptor>
       <interceptor-class>org.jboss.seam.ejb.SeamInterceptor</interceptor-class>
     </interceptor>
   </interceptors>

   <assembly-descriptor>
      <interceptor-binding>
         <ejb-name>*</ejb-name>
         <interceptor-class>org.jboss.seam.ejb.SeamInterceptor</interceptor-class>
      </interceptor-binding>
   </assembly-descriptor>

</ejb-jar>

（5）EJB持久化部署描述文件：persistence.xml

persistence.xml 文件告诉EJB的持久化层在哪找到数据源，该文件也含有一些厂商特定的设定。此例在程序启动时自动创建数据库Schema。

<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://java.sun.com/xml/ns/persistence"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"
             version="1.0">
    <persistence-unit name="userDatabase">
      <provider>org.hibernate.ejb.HibernatePersistence</provider>
      <jta-data-source>java:/DefaultDS</jta-data-source>
      <properties>
         <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
      </properties>
    </persistence-unit>
</persistence>



---------------------------------------------------------------------------------------------------------------------


工作原理

当提交表单时,JSF请求Seam来解析名为 user 的变量。由于还没有值绑定到 user 上（在任意的Seam上下文中）， Seam就会实例化 user组件，接着把它保存在Seam会话上下文后，然后将 User 实体Bean实例返回给JSF。

表单输入的值将由在 User 实体中所指定的Hibernate验证器来验证。 若有非法输入，JSF就重新显示当前页面。否则，JSF就将输入值绑定到 User 实体Bean的字段上。

接着，JSF请求Seam来解析变量 register。 Seam在无状态上下文中找到 RegisterAction 无状态的会话Bean并把它返回。JSF随之调用 register() 动作监听器方法。

Seam拦截方法调用并在继续调用之前从Seam会话上下文注入 User 实体。

register() 方法检查所输入用户名的用户是否已存在。 若存在该用户名，则错误消息进入 facesmessages 组件队列，返回无效结果并触发浏览器重显页面。facesmessages 组件嵌在消息字符串的JSF表达式，并将JSF facesmessage 添加到视图中。

若输入的用户不存在，"/registered.jsp" 输出就会将浏览器重定向到 registered.jsp 页。 当JSF来渲染页面时，它请求Seam来解析名为 user 的变量，并使用从Seam会话作用域返回的 User 实体的属性值。