Struts框架之构建Controller组件

一、概述

  在Struts 架构中,Controller主要是ActionServlet,但是对于业务逻辑的操作则主要由Action、ActionMapping、ActionForward这几个组件协调完成。其中,Action扮演了真正的业务逻辑的实现者,而ActionMapping和ActionForward则指定了不同业务逻辑或流程的运行方向。

应用程序的 Controller 部分集中于从客户端接收请求(典型情况下是一个运行浏览器的用户),决定执行什么商业逻辑功能,然后将产生下一步用户界面的责任委派给一个适当的View组件。在Struts中,controller的基本组件是一个ActionServlet 类的servlet。这个servlet通过定义一组映射(由Java接口 ActionMapping 描述)来配置。每个映射定义一个与所请求的URI相匹配的路径和一个 Action 类(一个实现 Action 接口的类)完整的类名,这个类负责执行预期的商业逻辑,然后将控制分派给适当的View组件来创建响应。

  Struts也支持使用包含有运行框架所必需的标准属性之外的附加属性的 ActionMapping 类的能力。这允许我们保存特定于我们的应用程序的附加信息,同时仍可利用框架其余的特性。另外,Struts允许我们定义控制将重定向到的逻辑名,这样一个行为方法可以请求"主菜单"页面,而不需要知道相应的JSP页面的实际名字是什么。这个功能极大地帮助我们分离控制逻辑(下一步做什么)和显示逻辑(相应的页面的名称是什么)。

二、创建Controller组件

  Struts包括一个实现映射一个请求URI到一个行为类的主要功能的servlet。因此我们的与Controller有关的主要责任是:

  为每一个可能接收的逻辑请求写一个 Action 类(也就是,一个 Action 接口的实现);写一个定义类名和与每个可能的映射相关的其它信息的 ActionMapping 类(也就是,一个 ActionMapping 接口的实现);写行为映射配置文件(用XML)用来配置controller servlet。

  为应用程序更新web应用程序展开描述符文件(用XML)用来包括必需的Struts组件,我们给应用程序添加适当的Struts组件。

  1、Action 实现

  Action 接口定义一个单一的必须由一个 Action 类实现的方法,就象下面这样:

public ActionForward perform(ActionServlet servlet,
ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws IOException, ServletException;


  一个 Action 类的目标是处理这个请求,然后返回一个标识JSP页面的 ActionForward 对象,控制应该重定向这个JSP页面以生成相应的响应。Struts 架构为应用系统中的每一个Action类只创建一个实例。因为所有的用户都使用这一个实例,所以你必须确定你的Action 类运行在一个多线程的环境中。

注意,客户自己继承的Action子类,必须重写execute()方法,因为Action类在默认情况下是返回null的。

  在 Model 2 设计模式中,一个典型的 Action 类将在它的 perform() 方法中实现下面的逻辑:

  验证用户session的当前状态(例如,检查用户已经成功地注册)。如果 Action 类发现没有注册存在,请求应该重定向到显示用户名和口令用于注册的JSP页面。应该这样做是因为用户可能试图从"中间"(也就是,从一个书签)进入我们的应用程序,或者因为session已经超时并且servlet容器创建了一个新的session。如果验证还没有发生(由于使用一个实现 ValidatingActionForm 接口的form bean),验证这个 form bean 的属性是必须的。如果发现一个问题,当作一个请求属性保存合适的出错信息关键字,然后将控制重定向回输入表单这样错误可以被纠正。

  执行要求的处理来处理这个请求(例如在数据库里保存一行)。这可以用嵌入 Action 类本身的代码来完成,但是通常应该调用一个商业逻辑bean的一个合适的方法来执行。更新将用来创建下一个用户界面页面的服务器端对象(典型情况下是request范围或session范围beans,定义我们需要在多长时间内保持这些项目可获得)。返回一个标识生成响应的JSP页面的适当的 ActionForward 对象,基于新近更新的beans。典型情况下,我们将通过接收到的 ActionMapping 对象(如果我们使用一个局部于与这个映射上的逻辑名)或者在controller servlet 本身(如果我们使用一个全局于应用程序的逻辑名)上调用 findForward() 得到一个对这样一个对象的引用。

  当为 Action 类编程时要记住的设计要点包括以下这些:

  controller servlet仅仅创建一个我们的 Action 类的实例,用于所有的请求。这样我们需要编写我们的 Action 类使其能够在一个多线程环境中正确运行,就象我们必须安全地编写一个servlet的 service() 方法一样。

  帮助线程安全编程的最重要的原则就是在我们的 Action 类中仅仅使用局部变量而不是实例变量。局部变量创建于一个分配给每个请求线程的栈中,所以没有必要担心会共享它们。

  尽管不应该,代表我们的系统中Model部分的的beans仍有可能抛出违例。我们应该在我们的 perform() 方法的逻辑中捕捉所有这样的违例,并且通过执行以下语句将它们记录在应用程序的日志文件中(包括相应的栈跟踪信息):

servlet.log("Error message text", exception);


  作为一个通用的规则,分配很少的资源并在来自同一个用户(在用户的session中)的请求间保持它们会导致可伸缩性的问题。另外,我们将会想要防止出现非常大的 Action 类。最简单的实现途径是将我们的功能逻辑嵌入到 Action 类本身,而不是将其写在独立的商业逻辑beans中。除了使 Action 类难于理解和维护外,这种方法也使得难于重用这些商业逻辑代码,因为代码被嵌入到一个组件(Action 类)中并被捆绑运行于web应用程序环境中。

  包括在Struts中的例子程序某种程度上延伸了这个设计原则,因为商业逻辑本身是嵌入到 Action 类中的。这应该被看作是在这个样本应用程序设计中的一个bug,而不是一个Struts体系结构中的固有特性,或者是一个值得仿效的方法。

2、ActionMapping实现

  为了成功地运行,Struts的controller servlet需要知道关于每个URI该怎样映射到一个适当的 Action 类的几件事。需要了解的知识封装在一个叫做 ActionMapping 的Java接口中,它有以下属性:

  actionClass :用于这个映射的 Action 类完整的Java类名。第一次一个特定的映射被使用,一个这个类的实例将被创建并为以后重用而保存。

  formAttribute :session范围的bean的名字,当前的这个映射的 ActionForm 被保存在这个bean之下。如果这个属性没有被定义,没有 ActionForm 被使用。

  formClass :用于这个映射的 ActionForm 类完整的Java类名。如果我们在使用对form beans的支持,这个类的一个实例将被创建并保存(在当前的用户会话中)

  path :匹配选择这个映射的请求的URI路径。看下面如何匹配的例子。

  Struts在一个叫做 ActionMappingBase 的类中包括了一个 ActionMapping 接口的方便的实现。如果我们不需要为我们自己的映射定义任何附加的属性,尽管把这个类作为我们的 ActionMapping 类好了,就向下面部分描述的那样配置。然而,定义一个 ActionMapping 实现(多半是扩展 ActionMappingBase 类)来包含附加的属性也是可能的。controller servlet知道怎样自动配置这些定制属性,因为它使用Struts的Digester模块来读配置文件。

  包括在Struts的例子程序中,这个特性用来定义两个附加的属性:

  failure :如果Action类检测到它接收的输入字段的一些问题,控制应该被重定向到的上下文相关的URI。典型情况下是请求发向的JSP页面名,它将引起表单被重新显示(包含Action类设置的出错消息和大部分最近的来自ActionForm bean的输入值)。

  success :如果Action类成功执行请求的功能,控制应该被重定向到的上下文相关的URI。典型情况下是准备这个应用程序的会话流的下一个页面的JSP页面名。

  使用这两个额外的属性,例子程序中的 Action 类几乎完全独立于页面设计者使用的实际的JSP页面名。 这个页面可以在重新设计时被重命名,然而几乎不会影响到 Action 类本身。如果"下一个"JSP页面的名字被硬编码到 Action 类中,所有的这些类也需要被修改。

  3、ActionForward实现

  目的是控制器将Action类的处理结果转发至目的地。

  Action类获得ActionForward实例的句柄,然后可用三种方法返回到ActionServlet,所以我们可以这样使用ActionForward():ActionServlet根据名称获取一个全局转发;ActionMappin实例被传送到perform()方法,并根据名称找到一个本地转发。

  另一种是调用下面的一个构造器来创建它们自己的一个实例:

public ActionForward()
public ActionForward(String path)
public ActionForward(String path,Boolean redirect)

  4、Action映射配置文件

  controller servlet怎样知道我们想要得到的映射?写一个简单地初始化新的 ActionMapping 实例并且调用所有适当的set方法的小的Java类是可能的(但是很麻烦)。为了使这个处理简单些,Struts包括一个Digester模块能够处理一个想得到的映射的基于XML的描述,同时创建适当的对象。

  开发者的责任是创建一个叫做 action.xml 的XML文件,并且把它放在我们的应用程序的WEB-INF目录中。(注意这个文件并不需要 DTD,因为实际使用的属性对于不同的用户可以是不同的)最外面的XML元素必须是<action-mappings>,在这个元素之中是嵌入的0个或更多的 <action> 元素 -- 每一个对应于我们希望定义的一个映射。

  来自例子程序的 action.xml 文件包括"注册"功能的以下映射条目,我们用来说明这个需求:

<action-mappings>
 <forward name="logon" path="/logon.jsp"/>
 <action path="/logon" actionClass="org.apache.struts.example.LogonAction"
formAttribute="logonForm" formClass="org.apache.struts.example.LogonForm" inputForm="/logon.jsp">
  <forward name="success" path="/mainMenu.jsp"/>
 </action>
</action-mappings>

  就象我们所看到的,这个映射匹配路径 /logon (实际上,因为例子程序使用扩展匹配,我们在一个JSP页面指定的请求的URI结束于/logon.do)。当接收到一个匹配这个路径的请求时,一个 LogonAction 类的实例将被创建(仅仅在第一次)并被使用。controller servlet将在关键字 logonForm 下查找一个session范围的bean,如果需要就为指定的类创建并保存一个bean。

  这个 action 元素也定义了一个逻辑名"success",它在 LogonAction 类中被用来标识当一个用户成功注册时使用的页面。象这样使用一个逻辑名允许将 action 类隔离于任何由于重新设计位置而可能发生的页面名改变。

  这是第二个在任何 action 之外宣告的 forward 元素,这样它就可以被所有的action全局地获得。在这个情况下,它为注册页面定义了一个逻辑名。当我们调用 mapping.findForward() 时在我们的 action 代码中,Struts首先查找这个action本地定义的逻辑名。如果没有找到,Struts会自动为我们查找全局定义的逻辑名。
5、Web应用程序展开描述符

  设置应用程序最后的步骤是配置应用程序展开描述符(保存在文件WEB-INF/web.xml中)以包括所有必需的Struts组件。作为一个指南使用例子程序的展开描述符,我们看到下面的条目需要被创建或修改。

  1)配置ActionServlet实例

  添加一个条目定义actionservlet本身,同时包括适当的初始化参数。这样一个条目看起来象是这样:

<servlet>
 <servlet-name>action</servlet-name>
 <servlet-class>org.apache.struts.action.ActionServlet</servlet-class>
 <init-param>
  <param-name>application</param-name>
  <param-value>org.apache.struts.example.ApplicationResources</param-value>
 </init-param>
 <init-param>
  <param-name>config</param-name>
  <param-value>/WEB-INF/action.xml</param-value>
 </init-param>
 <init-param>
  <param-name>debug</param-name>
  <param-value>2</param-value>
 </init-param>
 <init-param>
  <param-name>mapping</param-name>
  <param-value>org.apache.struts.example.ApplicationMapping</param-value>
 </init-param>
 <load-on-startup>2</load-on-startup>
</servlet>

  controller servlet支持的初始化参数在下面描述,拷贝自 ActionServlet 类的 Javadocs 。方括号描述如果我们没有为那个初始化参数提供一个值时假设的缺省值。

  application :应用程序资源包基类的Java类名。[NONE]

  config :包含配置信息的XML资源的上下文相关的路径。[/WEB-INF/action.xml]

  debug :这个servlet的调试级别,它控制记录多少信息到日志中。[0]

  digester : 我们在 initMapping() 中利用的Digester的调试级别,它记录到System.out而不是
servlet的日志中。[0]

  forward :使用的ActionForward实现的Java类名。[org.apache.struts.action.ActionForward]

  mapping :使用的ActionMapping实现的Java类名。[org.apache.struts.action.ActionMappingBase]

  nocache : 如果设置为 true,增加HTTP头信息到所有响应中使浏览器对于生成或重定向到的任何响应不做缓冲。[false]

  null :如果设置为 true,设置应用程序资源使得如果未知的消息关键字被使用则返回 null。否则,一个包括不欢迎的消息关键字的出错消息将被返回。[true]

  2)配置ActionServlet映射

  有两种通常的方法来定义将被controller servlet处理的URL:前缀匹配和扩展匹配。每种方法的一个适当的映射条目将在下面被描述。

  前缀匹配意思是我们想让所有以一个特殊值开头(在上下文路径部分之后)的URL传递给这个servlet。这样一个条目看起来可以象是这样:

<servlet-mapping>
 <servlet-name>action</servlet-name>
 <url-pattern>/execute/*</url-pattern>
</servlet-mapping>

  它意味着一个匹配前面描述的 /logon 路径的请求的URL看起来象是这样:
http://www.mystudy.com/myapplication/execute/logon

  这里 /myapplication是我们的应用程序展开所在的上下文路径。

  另一方面,扩展映射基于URL以一个跟着定义的一组字符的句点结束的事实而将URL匹配到action servlet 。例如,JSP处理servlet映射到 *.jsp 模式这样它在每个JSP页面请求时被调用。为了使用 *.do 扩展(它意味着"做某件事")映射条目看起来应该象是这样:

<servlet-mapping>
 <servlet-name>action</servlet-name>
 <url-pattern>*.do</url-pattern>
</servlet-mapping>

  并且一个匹配以前描述的 /logon 路径的请求的URI可以看起来象是这样:
http://www.mystudy.com/myapplication/logon.do

  3)配置Struts标记库

  下一步,我们必须添加一个定义Struts标记库的条目。这个条目看起来应该象是这样:

<taglib>
 <taglib-uri>/WEB-INF/struts.tld</taglib-uri>
 <taglib-location>/WEB-INF/struts.tld</taglib-location>
</taglib>

  它告诉JSP系统到哪里去找这个库的标记库描述符(在我们的应用程序的WEB-INF目录)。

  4)添加Struts组件到我们的应用程序中

  为了在我们的应用程序运行时使用Struts,我们必须将 struts.tld 文件拷贝到我们的 WEB-INF 目录,将struts.jar 文件拷贝到我们的 WEB-INF/lib 。

你可能感兴趣的:(controller)