作者：Junsan Jin

日期：2005-4-4

版本：1.0

信箱：junsan21126.com ; junnef21sohu.com

声明：本人保留本文的所有权利。


第一部分：简介
Struts开始于2000年3月，是采用Java Servlet/JavaServer Pages技术，开发Web应用程序的开放源码的框架。




 


采用Struts能开发出基于MVC(Model-View-Controller)设计模式的Java Web前端应用。通常MVC设计模式把一个系统划分为相互协作的三个部分：




 


1、  Model（模型），模型用于封装系统的状态，比如业务数据；




 


2、  View（视图），视图是模型的表示，提供用户交互界面。当模型状态发生变化时，视图应该得到通知，以便更新模型的变化；




 


3、  Controller（控制器），接受来自视图的请求，修改模型的状态。




 


Struts应用有3个主要部件：一个是使用Servlet实现的中心控制器（Controller Servlet，由Struts提供的org.apache.action. ActionServlet类实现）及负责具体业务逻辑处理的Action（org.apache.action.Action的子类）；一个是用于显示的JSP页面（viewer）；另一个是用于封装系统状态的业务逻辑元件（Model）。Struts 的中心控制器接受所有来自客户端的请求，并根据系统的配置（struts-config.xml）路由HTTP请求到其它Action对象（开发者实现的org.apache.struts.action.Action的子类）。在这些Action对象中会完成所有的业务操作，比如插入一条订单、修改一条记录等。处理完毕，由Struts的Controller Servlet根据配置转向到适当的JSP页面，将处理结果显示给用户。从这里可以看出，在Struts中Controller Servlet担任了重要的角色，它控制所有的程序流转，使MVC三个相对独立的部分协调工作，从而使系统的功能更加完善。




 

第二部分：系统环境及安装版本1、系统环境
操作系统：Windows XP SP1

WEB服务器：TOMCAT 5.0.14


 

2、Struts版本
本文使用jakarta-struts-20031118版本（隶属1.1版本系列），下载地址：

http://jakarta.apache.org/builds/jakarta-struts/release/



我们得到安装包jakarta-struts-20031118.zip。


 

第三部分：安装配置Struts1、安装Struts
解压缩jakarta-struts-20031118.zip包到E:\mylib\jakarta-struts中。其中包含有lib和webapps两个子目录。lib子目录中是使用Struts需要的Jar文件、标签库定义文件（.tld），以及对一个Struts Web应用的web.xml和struts-config.xml配置文件的DTD定义（.dtd）。webapps子目录中包含了几个Struts的示例应用，都已打包为.war格式，这里主要介绍其中三个：




 


1.     struts-example.war，一个采用Struts框架的简单的示例程序Controller；



2.     struts-documentation.war，Struts文档的war包；



3.     struts-blank.war，一个空白的Struts的应用，可以方便地修改，并且配置自己的应用。




 


我们如果要建立新的应用，就使用第三个作为基本框架就行了。




 

2、运行struts-example.war
把struts-example.war拷入Tomcat下的webapps目录。然后启动Tomcat，Tomcat在启动时就会自动解压war包了(如果没有自动解压,察看你的tomcat服务器是否配制成了直接运行war文档的模式)，在浏览器中输入http://localhost:8080/struts-example，如果能看到如下图所示页面，就说明已经运行成功。




 









 


在上图中你可以点击“Register with the MailReader Demonstration Application”注册一个MailReader用户，或直接点击“Log on to the MailReader Demonstration Application”，输入用户名和密码（示例程序已经预置了一个用户user/pass，配置在struts-example下的WEB-INF\database.xml文件中）登入。


3、对例程的分析（1）web.xml分析


在上图所示的页面中，点击“Log on to the MailReader Demonstration Application”链接，进入/logon.jsp页面，输入预定义的用户名为user、密码为pass，然后提交就进入了下图所示的用户主页面。




 







 


注意，这里的URL的后缀是.do。那么它有什么意义？服务器又是怎样处理这样的请求呢？看看{TOMCAT}\WEB-INF\web.xml文件，就会非常清楚。在web.xml中，可以找到如下配置片断：




 


<!-- Action Servlet Mapping -->

<servlet-mapping>

<servlet-name>action</servlet-name>

<url-pattern>*.do</url-pattern>

</servlet-mapping>


 


从上面配置代码中可以知道，以.do结尾的请求URL是由一个名为action的Servlet处理，实际上可以为应用取另一个后缀，只要修改这里就行了。




 


再看下面的一段配置摘要：




 


<!-- Action Servlet Configuration -->



<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.webapp.example.ApplicationResources



</param-value>



</init-param>



<init-param>



<param-name>config</param-name>



<param-value>/WEB-INF/struts-config.xml</param-value>



</init-param>



……



<load-on-startup>2</load-on-startup>



</servlet>


 


由上可见，action对应的类是org.apache.struts.action.ActionServlet。这是一个Struts提供的处于中心控制地位的Servlet，即Controller Servlet，正是用它监听所有的来自于用户的以.do为后缀的请求。在上面的配置中，为ActionServlet配置了一个名为config的初始化参数，值为 /WEB-INF/struts-config.xml。struts-config.xml是一个基于Struts应用的最重要的配置文件，其中包含了所有的Action请求（指以.do结尾的请求）、相应的Action处理类、Form Bean，以及页面的转向等信息的配置。struts-config.xml在应用启动时读入，然后根据这些配置进行响应。下面以示例程序中的LogonAction的配置为例，对struts-config.xml进行分析。




 

（2）Struts-config.xml分析
下面是struts-config.xml中对LogonAction进行配置的部分代码：




 


<action



 path="/logon"



 type="org.apache.struts.webapp.example.LogonAction"



 name="logonForm"



 scope="request"



 input="/logon.jsp">



</action>


 


从上面可以看出，MailReader应用中对应/logon.do的请求是由org.apache.struts.webapp.example. LogonAction类进行处理的，name属性指定的是这个请求对应的表单所对应的模型组件。




 


logonForm也是在struts-config.xml中配置的，下面是其配置的部分代码:




 


<form-bean  name="logonForm"



           type="org.apache.struts.validator.DynaValidatorForm">    



</form-bean>




 


LogonForm类是一个普通的JavaBean，其中定义了几个属性及属性的读写方法，而且这些属性的名字要和页面表单中的输入域对应。比如LogonForm中定义了两个属性，代码如下：




 


private String username = null;



private String password = null;




 


这两个属性分别对应于logon.jsp表单中的两个输入域，代码如下：




 


<html:form action="/logon" focus="username">



<html:text property="username" />



<html:password property="password" redisplay="false"/>



</html:form>




 


这里要注意一点，LogonForm中的属性名一定要和logon.jsp中的表单域名完全对应起来。Struts就是由此从浏览器端抓取提交的数据，并填充到LogonForm对象中，再传送给LogonAction类进行处理的。Struts实现的表单验证和重填技术也是这样实现的。在上面的页面代码中我们使用了Struts的HTML定制标签库，这些标签都定义在Struts的标签库中，有意研究的可以看一下，不过建议大家最好少用，因为这些标签支持的Javascript事件很少，而且失去了自动回填的支持，所以，还是自己做扩展标签比较好。还可以直接使用类似<input type="text" name="username" />的HTML代码，去Struts的标签库中找吧。




 

（3）Action分析
上面我们已经对Struts前端应用框架的整体结构、数据流转有了一定的认识。也知道了Struts是怎样从配置文件中获取配置信息的，即先启动，然后等待请求，再从前台抓取数据，根据配置信息调用（或生成）Action类进行处理，最后根据处理的结果转向到对应的页面响应用户。那么，现在就让我们看看LogonAction是怎样进行业务处理，并将处理结果显示给用户的。主要代码如下：




 


package org.apache.struts.webapp.example;



import org.apache.struts.action.Action;



......



public final class LogonAction extends Action {



     public ActionForward perform(ActionMapping mapping,



                                  ActionForm form,



                                  HttpServletRequest request,



                                  HttpServletResponse response)



throws IOException, ServletException {



......



ActionErrors errors = new ActionErrors();



String username = ((LogonForm) form).getUsername();



String password = ((LogonForm) form).getPassword();



......



// 进行用户验证



// 如果不存在此用户，或密码错误，则将错误添加到errors中



if (!errors.empty()) {



saveErrors(request, errors);



return (new ActionForward(mapping.getInput()));



}



HttpSession session = request.getSession();



session.setAttribute(Constants.USER_KEY, user);



//删除过期的form bean



......



if (mapping.getAttribute() != null) {



if ("request".equals(mapping.getScope()))



request.removeAttribute(mapping.getAttribute());



else



session.removeAttribute(mapping.getAttribute());



}



//定位到成功页面



return (mapping.findForward("success"));



       }



     }



}




 


LogonAction类继承于org.apache.struts.action.Action，Action类是所有的Action的基类。其中定义的perform()方法完成对请求处理，并根据处理结果转向到不同的页面，然后显示给用户。Action类并不是Servlet，它不直接监听来自客户端的请求。上面所提到的中心控制器ActionServlet是一个Servlet，客户端发出的Action请求，由ActionServlet接收，根据struts-config.xml中的配置，传入对应的mapping、form、request、response对象，并调用对应的Action类的perform()方法进行处理（在第一次调用时，实例化一个Action，随后的请求将直接调用已存在的Action类进行处理，所以Action类是共享的，编程中须注意处理并发问题）。下面对上述的LogonAction的perform()方法进行简单的分析。



1. 首先从传入的form对象中获取username和password。我们可能会奇怪这两个属性是在什么时候置入的？这是ActionServlet在调用LogonAction的perform()方法之前根据struts-config.xml中的配置及对应的LogonForm中的属性从前端请求抓取数据，置入LogonForm对象的。然后进行用户验证。本例没有使用数据库进行存储，用户信息是存储在database.xml文件中的。如果username/password在database.xml文件不存在或密码错误，则生成一个ActionError对象，将错误信息存储到该对象中，并把这个对象添加到ActionErrors中，其它发生的错误也类似处理。在随后的程序中，首先校检是否有错误发生，如果有错误发生，就把错误对象存储到request中，使用的方法为saveErrors(request, errors)。该方法是在基类org.apache.struts.action.Action中实现的，它完成的功能很简单，将errors对象通过setAttribute()方法存储到request中即可。实现如下：




 


protected void saveErrors(HttpServletRequest request,ActionErrors errors) {



   //删除掉不需要的错误信息



   if ((errors == null) || errors.empty()) {



      request.removeAttribute(ERROR_KEY);



      return;



   }



   //保存我们需要的错误对象



   request.setAttribute(ERROR_KEY, errors);



}




 


如果发生错误，将重定向到输入页面，同时自动完成输入域的重填，代码如下：


 


return (new ActionForward(mapping.getInput()));



如果在登陆页面输入user/abc将提示上面的错误，那么原来输入的username域就会自动填充进来了，在一个有大量输入域的表单会大大方便用户。




 


2．在上面的程序执行通过后，就说明这是一个合法登陆。我们要做的就是把当前用户保存到session中，同时清除已经无效的Form Bean，最后转向到success页面，代码为：




 


return (mapping.findForward("success"))；




 


一个ActionMapping对象对应于struts-config.xml中的一个<action/>的配置。如果你很细心的话，可能已经发现了，在struts-config.xml中举例的/logon Action的配置中，并没有Forward配置，但在它的开始部分却有一个全局的Forward配置。配置代码如下：




 


<global-forwards>



<forward   name="logoff"  path="/logoff.do"/>



<forward   name="logon"   path="/logon.jsp"/>



<forward   name="success" path="/mainMenu.jsp"/>



</global-forwards>




 


这个Forward配置将对所有的Action都有效。但如果中已经有和这些全局Forward配置同名的项，那么它将覆盖全局配置。所以你登录成功后，将转向到/mainMenu.jsp页面。当然，如果你想定义只对一个action起作用的forward，那么就把他们放到<action/>中去吧。




 

第四部分：空模板的使用
在struts的webapps目录下包含有struts-blank.war包，这个是struts的一个空白框架。我们可以直接使用WinRAR等工具将struts-blank.war包解开，或者是放到tomcat 5.0.14的webapps下，启动tomcat，让tomcat将包解开，然后删掉struts-blank.war就可以了。


 


该目录下有三个文件夹和一个jsp文件，下面的工作就简单了。META-INF我们可以不予理会，在不涉及到高级组件技术或者要打成ear或是jar包发布的话，这个文件夹是多余的，因为在打war包时，打包器会搞定一切的；而page文件夹下可以放置所有的jsp文件，按照项目需要组织目录就行了；而WEB-INF下放什么，不用说也知道了，但是为了以后项目维护的方便，你需要组织好类包的结构，Struts的配置文件还是struts-conf.xml，而项目产生的java文件最好放到src文件夹下，这样的话就可以使用ant来编译了，也就是说，你的开发工具只需要一个文本编辑器就可以了，编译工作可以交给ant了，它会帮你完成一切的。使用ant编译后在classes下存有编译好的类文件，当然，它也同时生成了组件包，你可以选择部署一个；至于index.jsp文件则完全可以被项目的主页面代替。


 


OK，Struts的配置就这么简单，上面讲的已经足够一个项目的使用了。当然，Struts还有更多高级的应用，这些可以去看struts的帮助文档，就是那个struts-documentation.war，部署到tomcat上就可以浏览了。


 


备注：本文档为初稿，如果有什么补充或发现什么错误，请及时联系，以便补充或更正。