Seam事件

SEAM学习（七）---Seam事件

Seam事件
Seam组件模型是为使用 事件驱动的应用程序 而开发的，特别是在一个细粒度的事件模型里进行细粒度的松耦合组件的开发。 Seam的事件有几种类型，大部分是我们已经见过的：

JSF事件

jBPM的状态转移事件

Seam页面动作

Seam组件驱动事件

Seam上下文事件

所有这些不同种类的事件都通过绑定了表达式的JSF EL方法映射到Seam组件去。JSF事件是在JSF模板中定义的：

<h:commandButton value="Click me!" action="#{helloWorld.sayHello}"/>对于jBPM的转换事件，是在jBPM过程定义或页面流定义中指定的：

<start-page name="hello" view-id="/hello.jsp">
    <transition to="hello">
        <action expression="#{helloWorld.sayHello}"/>
    </transition>
</start-page>你可以在其他地方找到更多关于JSF事件和jBPM事件的信息。我们现在主要关注由Seam定义的两种新增类型的事件上。

5.1.1. 页面动作
Seam的页面动作是指就在我们渲染页面之前发生的事件。我们在 WEB-INF/pages.xml 中声明页面动作。 我们可以为任何一个特殊的JSF视图id定义一个页面动作：

<pages>
    <page view-id="/hello.jsp" action="#{helloWorld.sayHello}"/>
</pages>或者，我们可以使用一个通配符 * 作为 view-id 的后缀来指定一个动作，应用到所有符合该模式的视图ID中：

<pages>
    <page view-id="/hello/*" action="#{helloWorld.sayHello}"/>
</pages>如果多通配符的页面动作匹配当前的view-id，Seam将按照从最通用到最特殊的顺序来调用所有的动作。

页面动作方法可以返回一个JSF的结果。如果这个结果非空，Seam将用定义好的导航规则导航到一个视图中去。

此外，在元素 <page> 里提到的视图id不需要对应一个真实的JSP或Facelets页面！ 因此，我们可以再生传统的面向动作的框架的功能，就像Struts或WebWork使用页面动作那样。例如：

TODO: translate struts action into page action如果你想要应non-faces的请求做点复杂的事情（例如HTTP GET请求），这就非常有用。

对于多页面或者条件页面的动作，可以使用 <action> 标签指定：

<pages>
    <page view-id="/hello.jsp">
        <action execute="#{helloWorld.sayHello}" if="#{not validation.failed}"/>
        <action execute="#{hitCount.increment}"/>
    </page>
</pages>5.1.1.1. 页面参数
一个JSF faces请求（表单提交）同时封装了一个“动作action”（一个方法绑定）和“多个参数parameters”（输入值绑定）。一个页面动作也可能需要参数！

由于GET请求是可以做标记的，页面参数是作为人类易读的请求参数来传递的。（不像JSF form的输入，什么都有就是不具有可读性！）

你可以使用页面参数，带不带动作方法都可以。

5.1.1.1.1. 将请求参数映射到模型
Seam让我们提供一个值绑定，来将一个已命名的请求参数映射成一个模型对象的属性。

<pages>
      <page view-id="/hello.jsp" action="#{helloWorld.sayHello}">
          <param name="firstName" value="#{person.firstName}"/>
          <param name="lastName" value="#{person.lastName}"/>
      </page>
  </pages><param> 的声明是双向的，就像一个JSF输入的值绑定：

当视图id的一个non-faces(GET)请求发生时，Seam在执行了相应的类型转变之后，就在模型对象上设置已命名的请求参数的值。

任何 <s:link> 或 <s:button> 透明地或者说自动地包括request带有的参数。 参数的值由渲染阶段（当 <s:link> 被渲染）的绑定值来决定。

使用 <redirect/> 到视图id的任何导航规则很明显是含有请求参数。 参数的值由调用应用程序阶段结束时的值绑定大小来决定。

这个值很明显是由带有视图id的被提交的任何JSF页面传播的。 这意味着视图参数表现得就像faces请求的 PAGE 范围内上下文变量一样。

最理想的情形是 无论 我们从什么页面到 /hello.jsp （或者从/hello.jsp回到/hello.jsp）， 在值绑定中被引用的模型属性的值都应该被“记住”，而不需要对话来存储（或者其他的服务器端状态来存储）。

5.1.1.1.2. 传播请求参数
如果只是指定 name 属性，那么请求参数就会利用 PAGE 进行上下文传播（它没有被映射成模型属性）。

<pages>
      <page view-id="/hello.jsp" action="#{helloWorld.sayHello}">
          <param name="firstName" />
          <param name="lastName" />
      </page>
  </pages>如果你想要建立多层的复杂CRUD页面，页面参数的传递尤其有用。你可以用它“记住”你前面到过的页面（例如当按了保存按钮时）和正在编辑的实体。

很明显，如果参数是视图的页面参数的话，任何 <s:link> 或者 <s:button> 都会传播请求参数。

这个值很明显是由带有指定视图id的页面的任何jsf页面表单提交传播的。 （这意味着视图参数表现得就像faces请求的PAGE范围内视图参数一样。）

所有这些听起来很复杂，你可能会想这么一个外来的构造是否真的值得去努力。实际上，一旦你“掌握了它”，有这种想法非常自然。 理解这些资料显然需要花费时间的。页面参数是跨越non-faces请求来传播状态的最优雅方式。 对于用可标记的结果页，搜索屏幕的问题尤其有效，在这种情况下，我们喜欢可以写应用程序代码、用同一段代码来处理POST和GET请求。 页面参数消除了视图定义中请求参数的重复清单，并使得重定向更容易用代码实现。

5.1.1.1.3. 转换和验证
你可以为复杂的模型属性指定一个JSF转换器:

<pages>
    <page view-id="/calculator.jsp" action="#{calculator.calculate}">
        <param name="x" value="#{calculator.lhs}"/>
        <param name="y" value="#{calculator.rhs}"/>
        <param name="op" converterId="com.my.calculator.OperatorConverter" value="#{calculator.op}"/>
    </page>
</pages>或者：

<pages>
    <page view-id="/calculator.jsp" action="#{calculator.calculate}">
        <param name="x" value="#{calculator.lhs}"/>
        <param name="y" value="#{calculator.rhs}"/>
        <param name="op" converter="#{operatorConverter}" value="#{calculator.op}"/>
    </page>
</pages>JSF验证器和 required="true" 也可以这样用：

<pages>
    <page view-id="/blog.xhtml">
        <param name="date"
               value="#{blog.date}"
               validatorId="com.my.blog.PastDate"
               required="true"/>
    </page>
</pages>或者：

<pages>
    <page view-id="/blog.xhtml">
        <param name="date"
               value="#{blog.date}"
               validator="#{pastDateValidator}"
               required="true"/>
    </page>
</pages>更好的方式，基于模型的Hibernate验证器注解会自动被识别和验证。

当类型转换或者验证失败后，一个全局的 FacesMessage 就会被添加到 FacesContext 中。

5.1.1.2. 导航
你可以使用在Seam应用程序的 faces-config.xml 中定义的标准JSF导航规则。然而，JSF导航规则也有许多烦人的限制：

在重定向时，不可能指定一个将要使用的请求参数。

不可能由一个规则来开始或者结束对话。

通过给动作方法求取返回值来运作规则；不可能去给一个任意的EL表达式取值。

更深层次的问题在于”管理“逻辑在 pages.xml 和 faces-config.xml 之间是分散的。 最好是把这种逻辑统一进 pages.xml 中。

这个JSF导航规则：

<navigation-rule>
    <from-view-id>/editDocument.xhtml</from-view-id>

    <navigation-case>
        <from-action>#{documentEditor.update}</from-action>
        <from-outcome>success</from-outcome>
        <to-view-id>/viewDocument.xhtml</to-view-id>
        <redirect/>
    </navigation-case>

</navigation-rule>可以重写如下：

<page view-id="/editDocument.xhtml">

    <navigation from-action="#{documentEditor.update}">
        <rule if-outcome="success">
            <redirect view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>

</page>如果我们不必用字符类型的返回值（JSF的结果）来污染 DocumentEditor 组件的话会更好。 因此Seam允许我们写成：

<page view-id="/editDocument.xhtml">

    <navigation from-action="#{documentEditor.update}"
                   evaluate="#{documentEditor.errors.size}">
        <rule if-outcome="0">
            <redirect view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>

</page>或者甚至可以写成：

<page view-id="/editDocument.xhtml">

    <navigation from-action="#{documentEditor.update}">
        <rule if="#{documentEditor.errors.empty}">
            <redirect view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>

</page>第一种形式计算一个值绑定，来确定要被后面的一系列导航规则所使用的结果值。 第二种方法忽略结果，并为每个可能的规则来计算值绑定。

当然，当一个更新成功，我们可能想要结束当前的对话。我们可以这样做：

<page view-id="/editDocument.xhtml">

    <navigation from-action="#{documentEditor.update}">
        <rule if="#{documentEditor.errors.empty}">
            <end-conversation/>
            <redirect view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>

</page>由于我们终止了会话，后面的任何请求都无法知道我们对哪个文档感兴趣。 我们可以将文档id作为一个请求参数传递，这样也使得视图变成是可标记的：

<page view-id="/editDocument.xhtml">

    <navigation from-action="#{documentEditor.update}">
        <rule if="#{documentEditor.errors.empty}">
            <end-conversation/>
            <redirect view-id="/viewDocument.xhtml">
                <param name="documentId" value="#{documentEditor.documentId}"/>
            </redirect>
        </rule>
    </navigation>

</page>在JSF中，null是一个特殊的结果。结果null被解释成“重新显示页面”。 下面的导航规则符合任何非null的结果，而 不符合 null的结果：

<page view-id="/editDocument.xhtml">

    <navigation from-action="#{documentEditor.update}">
        <rule>
            <render view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>

</page>如果结果出现null，你还想执行导航，就使用下面的形式：

<page view-id="/editDocument.xhtml">

    <navigation from-action="#{documentEditor.update}">
        <render view-id="/viewDocument.xhtml"/>
    </navigation>

</page>view-id可以作为一个JSF EL表达式提供：

<page view-id="/editDocument.xhtml">

    <navigation if-outcome="success">
        <redirect view-id="/#{userAgent}/displayDocument.xhtml"/>
    </navigation>

</page>5.1.1.3. 导航的定义、页面动作和参数的细粒度文件
如果你有很多不同的页面动作和页面参数，或者甚至是很多导航规则，你就会很想把这些声明分开放到多个文件中去。 你可以在一个名为 calc/calculator.page.xml 的资源中，为一个有着视图id /calc/calculator.jsp 的页面定义动作和参数。 这个例子中的根元素是 <page> 元素，隐含着视图id：

<page action="#{calculator.calculate}">
    <param name="x" value="#{calculator.lhs}"/>
    <param name="y" value="#{calculator.rhs}"/>
    <param name="op" converter="#{operatorConverter}" value="#{calculator.op}"/>
</page>5.1.2. 组件驱动的事件
Seam组件可以通过方法间简单的调用相互影响。状态组件甚至实现 Observer/Observable 模式。 但在组件直接调用彼此方法的时候，为了使组件在一个比可能存在的更加松耦合的方式下相互作用，Seam提供了 组件驱动事件。

我们在 components.xml 里指定了事件监听器（观察者）。

<components>
    <event type="hello">
        <action execute="#{helloListener.sayHelloBack}"/>
        <action execute="#{logger.logHello}"/>
    </event>
</components>在这里，event type 是任意的字符串。

事件发生时，该事件已经注册过的动作将按照它们在 components.xml 中出现的顺序被依次调用。 组件如何发起事件？Seam为此提供了一个内置的组件。

@Name("helloWorld")
public class HelloWorld {
    public void sayHello() {
        FacesMessages.instance().add("Hello World!");
        Events.instance().raiseEvent("hello");
    }
}或者你可以使用注解。

@Name("helloWorld")
public class HelloWorld {
    @RaiseEvent("hello")
    public void sayHello() {
        FacesMessages.instance().add("Hello World!");
    }
}注意这个事件产生器没有依赖任何事件消费者。事件监听器现在可以完全不依赖于产生器而实现：

@Name("helloListener")
public class HelloListener {
    public void sayHelloBack() {
        FacesMessages.instance().add("Hello to you too!");
    }
}上述在 components.xml中定义的方法绑定关心把事件映射到消费者去。 如果你不喜欢 components.xml 文件中的那一套，可以用注解来替代：

@Name("helloListener")
public class HelloListener {
    @Observer("hello")
    public void sayHelloBack() {
        FacesMessages.instance().add("Hello to you too!");
    }
}你可能想知道为什么在这个讨论中没有提到关于任何事件对象的东西。 在Seam中，对事件对象而言，不需要在事件生产者和监听器之间传播状态。 状态保留在Seam上下文中，在组件之间共享。然而，如果你真想传递事件对象，你可以：

@Name("helloWorld")
public class HelloWorld {
    private String name;
    public void sayHello() {
        FacesMessages.instance().add("Hello World, my name is #0.", name);
        Events.instance().raiseEvent("hello", name);
    }
}@Name("helloListener")
public class HelloListener {
    @Observer("hello")
    public void sayHelloBack(String name) {
        FacesMessages.instance().add("Hello #0!", name);
    }
}5.1.3. 上下文事件
Seam定义了许多内置事件，应用程序可以用它们来进行特殊类型的框架集成。这些事件是：

org.jboss.seam.validationFailed — JSF验证失败时被调用

org.jboss.seam.noConversation — 没有长时间运行的对话在运行或者长时间运行的对话被请求时调用

org.jboss.seam.preSetVariable.<name> — 设置上下文变量 <name> 时调用

org.jboss.seam.postSetVariable.<name> — 设置上下文变量 <name> 时调用

org.jboss.seam.preRemoveVariable.<name> — 未设置上下文变量 <name> 时调用

org.jboss.seam.postRemoveVariable.<name> — 未设置上下文变量 <name> 时调用

org.jboss.seam.preDestroyContext.<SCOPE> — 在 <SCOPE> 上下文被销毁之前调用

org.jboss.seam.postDestroyContext.<SCOPE> — 在 <SCOPE> 上下文被销毁之后调用

org.jboss.seam.beginConversation — 当一个长时间运行的对话开始的时候调用

org.jboss.seam.endConversation — 当一个长时间运行的对话结束的时候调用

org.jboss.seam.beginPageflow.<name> — 在页面流 <name> 开始时调用

org.jboss.seam.endPageflow.<name> — 在页面流 <name> 结束时调用

org.jboss.seam.createProcess.<name> — 在创建进程 <name> 时调用

org.jboss.seam.endProcess.<name> — 在进程 <name> 结束时调用

org.jboss.seam.initProcess.<name> — 在进程 <name> 与对话相关联时调用

org.jboss.seam.initTask.<name> — 在任务 <name> 与对话相关联时调用

org.jboss.seam.startTask.<name> — 在任务 <name> 开始时调用

org.jboss.seam.endTask.<name> — 在结束任务 <name> 时调用

org.jboss.seam.postCreate.<name> — 在创建组件 <name> 时调用

org.jboss.seam.preDestroy.<name> — 在销毁组件 <name> 时调用

org.jboss.seam.beforePhase — 在开始一个JSF阶段之前调用

org.jboss.seam.afterPhase — 在一个JSF阶段结束之后调用

org.jboss.seam.postInitialization — 当Seam被初始化并启动所有组件时被调用

org.jboss.seam.postAuthenticate.<name> — 用户认证之后调用

org.jboss.seam.preAuthenticate.<name> — 在尝试认证用户之前调用

org.jboss.seam.notLoggedIn — 在不需要认证用户和需要认证的时候调用

org.jboss.seam.rememberMe — 当Seam安全在cookie中发现用户名时发生

org.jboss.seam.exceptionHandled.<type> — 在Seam处理未被捕捉的异常时被调用

org.jboss.seam.exceptionHandled — 在Seam处理未被捕捉的异常时被调用

org.jboss.seam.exceptionNotHandled — 在没有未被捕捉异常的处理器时被调用

org.jboss.seam.afterTransactionSuccess — 当事务在Seam Application Framework中成功时调用

org.jboss.seam.afterTransactionSuccess.<name> — 当管理具名 <name> 实体的事务在Seam Application Framework中成功时调用

Seam组件可以用它们观察任何其他组件驱动事件的同样方式来观察这些事件中的任何一种。