集成JSF与BEEHIVE PAGE FLOW

　　JSF对通过关联组件和事件来构建页面而说是非常棒的，但是，与所有现有的技术一样，它需要一个控制器来分离出页面间的导航决策，并提供到业务层的链接。它拥有一个基本的导航处理程序，可以用功能完备的处理程序来替换它。Page Flow为创建可重用的封装页面流提供了基础，并可以与视图层并行工作。它是一个功能完备的导航处理程序，将JSF页面作为最优先的处理对象。本文将讨论如何集成这两种技术来利用二者的优点。

　　构建Beehive/JSF应用程序

　　要构建Beehive/JSF应用程序，首先要启动Page Flow，然后添加对JSF的支持。起点是从基本的支持NetUI（Beehive中包含Page Flow的组件）的项目开始。根据指导构建基本的支持NetUI的Web应用程序。在本文中，我们暂且称之为“jsf-beehive”，可以在 上获得。

　　接下来，安装并配置JSF。Page Flow可以使用任何与Server Faces 1.1兼容的实现，并针对两种主流实现进行了测试：Apache MyFaces和JSF Reference Implementation。根据下面的指导在新的Web应用程序中安装JSF：MyFaces v1.0.9及更高版本，JSF Reference Implementation v1.1_01，或者其他实现。之后，可以使用WEB-INF/faces-config.xml中的一个简单入口启动Page Flow集成，入口在标签之下，标签之上：

 
  org.apache.beehive.netui.pageflow.faces.PageFlowApplicationFactory
 

　　添加了这些就为页面流提供了一个机会，使其可以提供自己的JSF框架对象版本来定制其行为。通常来说，只有在使用页面流功能的时候，JSF行为才会被修改；JSF的基本行为不会改变。

　　基本集成

　　JSF中页面流的最基本用处是引发（调用）来自JSF页面的动作。JSF页面可以处理页面内事件，而页面流动作则是从一个页面导航到另一页面的方法。首先，在Web应用程序中创建一个名为“example”的目录，在其中创建一个页面流控制器类：

package example;

import org.apache.beehive.netui.pageflow.Forward;
import org.apache.beehive.netui.pageflow.PageFlowController;
import org.apache.beehive.netui.pageflow.annotations.Jpf;

@Jpf.Controller(
  simpleActions={
    @Jpf.SimpleAction(name="begin", path="page1.faces")
  }
)
public class ExampleController extends PageFlowController
{
  @Jpf.Action(
    forwards={
      @Jpf.Forward(name="success", path="page2.faces")
    }
  )
  public Forward goPage2()
  {
    Forward fwd = new Forward("success");
    return fwd;
  }
}

　　在这个页面流中有两个动作：跳转到page1.faces的begin动作和跳转到page2.faces的goPage2动作。将goPage2作为一个方法动作（而不是简单动作）的原因是稍后将会对其进行扩充。

　　在构造页面的时候，应当以.jsp为扩展名创建page1和page2；JSF servlet处理每个.faces请求，并最终跳转到相关的JSP。所以，跳转到page1.faces最终将显示page1.jsp，如下：

<%@ taglib prefix="f" uri="" %>
<%@ taglib prefix="h" uri="" %>
 

 
   
     
       
         
         
       
     
   
 

　　从JSF页面引发一个动作很简单：使用命令组件的action属性中的动作名字就可以了。在上面的例子中，commandLink指向goPage2动作。使用页面流集成，这意味着goPage2动作会在example.ExampleController中运行。

　　就是这样。要试验的话，构建应用程序，点击 /example/ExampleController.jpf ，这将通过begin动作跳转到page1.faces。单击链接“Go to page 2”，会引发goPage2动作并跳转到page2.faces。

　　后台Bean

　　Page Flow框架可以管理与JSF页面相关的后台bean（backing bean）。该类是放置与页面相关的事件处理程序和状态的方便场所。可以把它看作是集中放置与页面交互时所运行的所有代码的单一场所。当点击一个JSF页面时，Page Flow会判断是否有具有同样名称和包的类，例如，page /example/page1.faces的example.page1类。如果存在这样的类，并且它用@Jpf.FacesBacking进行注释并扩展了FacesBackingBean，它就会创建该类的一个实例。当离开JSF页面而转到一个动作或者其它任何页面时，后台bean会被销毁。后台bean与JSF页面共存亡。

　　绑定到后台bean中的属性

　　下面是page1.faces的一个非常简单的后台bean，以及属性someProperty。文件名是page1.java：

package example;

import org.apache.beehive.netui.pageflow.FacesBackingBean;
import org.apache.beehive.netui.pageflow.annotations.Jpf;

@Jpf.FacesBacking
public class page1 extends FacesBackingBean
{
  private String _someProperty = "This is a property value from" 
                                 + getClass().getName() + ".";

  public String getSomeProperty()
  {
      return _someProperty;
  }

  public void setSomeProperty(String someProperty)
  {
      _someProperty = someProperty;
  }
}

　　在JSF页面(page1.jsp)中，可以利用backing绑定上下文来绑定到这个属性：

　　

　　上面的例子显示了someProperty（最终在后台bean上调用getSomeProperty()）的值。类似地，设置这个值：

　　

　　注意，在这个例子中，后台bean中没有出现事件处理程序或组件引用。这就缩短了代码；后台bean是放置页面所有的处理程序和组件引用的好地方。

　　从后台bean引发页面流动作

　　在上面的“基本集成”部分，我们直接从JSF组件引发页面流动作。通常情况下，只需这样即可；当单击一个按钮或者链接时，会运行一个动作并跳转到另一个页面上。如果想在调用控制器之前运行一些与页面相关的代码，或者如果希望页面可以在几个动作之间进行动态选择的话，可以在命令处理程序（JSF页面所运行的一个方法）中引发一个动作。下面是一个命令处理程序的例子，可以把它放到后台bean page2.java中（或者其它任何可公开访问的bean中）：

public String
chooseNextPage()
{
  return "goPage3";
}

　　这是一个非常简单的命令处理程序，它选择了goPage3动作。可以用标准的JSF方式从一个JSF命令组件绑定到这个命令处理程序：

　　当单击链接时，会运行chooseNextPage命令处理程序，它会选择引发goPage3动作。还可以对命令处理程序方法使用一个特殊的页面流注释——@Jpf.CommandHandler：

@Jpf.CommandHandler(
 raiseActions={
      @Jpf.RaiseAction(action="goPage3")
 }
)
public String chooseNextPage()
{
 return "goPage3";
}

　　该注释使支持Beehive的工具可以知道命令处理程序引发了后台bean中的哪个动作，并允许扩展JSF动作处理的能力（参见下面“从JSF页面向页面流发送数据”部分）。

　　从后台bean访问当前页面流或共享流

　　在某些情况下，您或许想直接从后台bean访问当前页面流或一个活动的共享流。为此，只需创建一个适当类型的字段，并使用@Jpf.PageFlowField或@Jpf.SharedFlowField对其进行适当注释：

@Jpf.CommandHandler(
 raiseActions={
      @Jpf.RaiseAction(action="goPage3")
 }
)
public String chooseNextPage()
{
 return "goPage3";
}

　　这些字段将在创建后台bean的时候被初始化。无需手动对其进行初始化。下面的例子使用了自动初始化的ExampleController字段。在这个例子中，“show hints”单选钮的事件处理程序在页面流中设置了一个普通优先级。

@Jpf.PageFlowField
private ExampleController myController;

@Jpf.SharedFlowField(name="sharedFlow2") // "sharedFlow2" is a 
                              // name defined in the
                              // page flow controller
private ExampleSharedFlow mySharedFlow;

　　在很多情况下，页面不需要直接与页面流或者共享流进行交互；使用其它方法从页面流向JSF页面传递数据就足够了，反之亦然。下面我将给出一些例子。

　　从页面流控制器访问后台bean

　　您不能从页面流控制器访问后台bean！至少，这不容易做到，这是有意为之的。后台bean与JSF页面紧密相关，当您离开页面的时候，后台bean会被销毁。正如页面流控制器不应了解页面细节一样，它也不应了解后台bean。当然了，可以从后台bean向控制器传递数据（稍后将会介绍），甚至可以传递后台bean实例本身，但是在大多数情况下，后台bean的内容是不应当泄露给控制器的。

　　生命周期方法

　　通常，当后台bean发生某些事情的时候，比如当它被创建或销毁时，我们希望能运行代码。在Page Flow框架的生命周期中，它会对后台bean调用一些方法：

• onCreate()：创建bean时
• onDestroy()：销毁bean时（从用户会话移除）
• onRestore()：这个需要详细解释一下。我说过，当您离开页面的时候，后台bean会被销毁。在大多数情况下是这样的，但是如果页面流使用了navigateTo特性（它使您可以再次访问先前显示的页面），在您离开页面之后，Page Flow框架会保留后台bean一小段时间，以防它需要还原。当通过@Jpf.Forward或@Jpf.SimpleAction使用navigateTo=Jpf.NavigateTo.currentPage或navigateTo=Jpf.NavigateTo.previousPage还原一个JSF页面时，页面的组件树及其后台bean都被Page Flow框架还原。当这种情况发生时，onRestore()就被调用。

　　不管要在哪个时期运行代码，只需重写适当的方法：

protected void onCreate()
{
 /*some create-time logic */
}

　　当重写这些方法时，不需要调用空的super版本。

　　在JSF页面和页面流之间传递数据

　　现在我们该看看如何在JSF页面和页面流之间传递数据了。

　　从页面流向JSF页面发送数据

　　通常，您会想要利用页面流的数据来初始化一个页面。为此，可以向page2.faces的Forward添加“action outputs”：

@Jpf.Action(
 forwards={
  @Jpf.Forward(
    name="success", path="page2.faces",
    actionOutputs={
      @Jpf.ActionOutput(name="message", type=String.class,required=true)
    }
  )
 }
)

public Forward goPage2()
{
  Forward fwd = new
  Forward("success");
   fwd.addActionOutput("message", "Got the message.");
  return fwd;
}

　　做完这些之后，可以直接从JSF页面或者后台bean将该值作为页面输入来访问。（如果您不喜欢键入冗长的注释，可以省去斜体的。它们主要用于再次检查添加的对象类型是否正确，确定不缺失类型。）

　　可以在页面中利用JSF表示语言中的页面流pageInput绑定上下文绑定到这个值：

　　注意，可以利用pageFlow和sharedFlow绑定上下文绑定到页面流控制器自身或者任何可用的共享流的属性：

　　最后，要想从后台bean访问页面输入，只需在bean类代码中的任意地方调用getPageInput：

String message = (String) getPageInput("message");

　　从JSF页面向页面流发送数据

　　还可以随着页面流所引发的动作发送数据。很多动作将要求表单bean作为输入；通常，表单bean用于从页面获取数据送到控制器。首先，让我们构建一个动作来接收表单bean并跳转到页面：

@Jpf.Action(
   forwards={
       @Jpf.Forward(name="success", path="page3.faces")
   }
)
public Forward goPage3(NameBean nameBean)
{
    _userName = nameBean.getFirstName() + ' ' + 
                nameBean.getLastName();
    return new Forward("success");
}

　　该动作包含一个NameBean，它是一个将getters/setters作为其firstName和lastName属性的表单bean类。它设置一个成员变量保存完整名字，之后跳转到page3.faces。我们知道，可以直接从JSF页面或者它的后台bean引发一个动作。在这两种情况下，都可以向动作发送表单bean。下面让我们依次看看每种情况。

　　从后台bean发送表单bean

　　要从后台bean中的命令处理程序发送表单bean，需要使用一个特定的注释。下面给出了page2.java中的情况：

private ExampleController.NameBean _nameBean;

protected void onCreate()
{
    _nameBean = new ExampleController.NameBean();
}

public ExampleController.NameBean getName()
{
    return _nameBean;
}

@Jpf.CommandHandler(
    raiseActions={
        @Jpf.RaiseAction(action="goPage3", 
             outputFormBean="_nameBean")
    }
)
public String chooseNextPage()
{
    return "goPage3";
}

　　在这个例子中，JSF页面可以用它选择的任何方式填充_nameBean的值（例如，通过将h:inputText值绑定到#{backing.name.firstName}和#{backing.name.lastName}）。之后它使用@Jpf.RaiseAction上的outputFormBean属性来标记_nameBean应当被传递到动作goPage3。

　　从JSF页面发送表单bean

　　从JSF页面直接发送表单bean很容易，只要您可以通过数据绑定表达式得到bean值。这是通过在commandButton组件内部添加名为submitFormBean的h:attribute组件来实现的：

　　在这里，为了使表单bean发送到动作goPage3，按钮绑定到后台bean的“name”属性(getName)。

　　结束语

　　本文展示了如何将JSF在构建页面方面的丰富特性与Beehive Page Flow在控制页面间导航方面的强大功能相结合。二者的集成非常容易，但是却会对应用造成深远的影响：它将JSF页面与应用级逻辑相分离，并把页面带入Page Flow所提供的功能领域中。JSF页面得到了清楚的任务：作为单个（如果有足够能力的话）视图元素参与到应用程序的流中。文中没有展示JSF页面中具有事件处理功能且控制器中具有复杂的导航逻辑的完备应用程序。但是随着应用程序的复杂程度提高，它就会更加需要责任的划分以及页面流添加给JSF的高级流功能。您可以花几分钟尝试一下——很快您就将意识到这样做所带来的好处。

【责编:yuan】

--------------------next---------------------