用Struts框架开发Java应用 作者:赵科 本文选自:开放系统世界——赛迪网 2002 年10 月22 日
Struts开始于2000年3月,是采用Java Servlet/JavaServer Pages技术,开发Web应用程序的开放源码的框架。当前最新的正式版本是 1.0.2 ,本文内容就是针对这个版本的。采用Struts能开发出基于MVC(Model-View-Controller)设计模式的Java Web前端应用。通常MVC设计模式把一个系统划分为相互协作的三个部分: 1. Model(模型),模型用于封装系统的状态,比如业务数据; 2. View(视图),视图是模型的表示,提供用户交互界面。当模型状态发生变化时,视图应该得到通知,以便更新模型的变化; 3. Controller(控制器),接受来自视图的请求,修改模型的状态; 但是,在基于JSP/Servlet的Web应用中要使用MVC模式,需要解决这样一个问题,就是HTTP的底层是TCP/IP协议,而TCP/IP是一种无状态连接的协议,如果我们的模型发生了变化,就无从通知视图。而Struts采用了在“JSP规范v 0.92” 中就提出的MVC Model 2,这是对MVC在Web上应用的修订版,它可以解决这个问题,见图1。
图1 MVC Model2(FromMalcolm Davis)
图2 Sturts工作机理(From Malcolm Davis)
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可见Struts是MVC Model 2的一个典型应用。
安装
你可以从http://jakarta.apache.org/builds/jakarta-struts/release/下载Struts最新的二进制版本和源码。首先进入v 1.0.2 下载页面,下载jakarta-struts-1.0.2.zip(3.4MB),然后将jakarta-struts-1.0.2.zip解压。其中包含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的应用,可以方便地修改,并且配置自己的应用。 下面运行struts-example这个示例程序。因为Struts是一个Web应用,所以要运行这个示例需要一个兼容Servlet 2.2、JSP 1.1以上规范的Web容器。本文以Tomcat 3.3a (对Tomcat 4.0也适用)为例进行介绍。首先保证Tomcat可以正常运行。而运行struts example不需要其它特殊配置的,只要把struts-example.war拷入Tomcat下的webapps目录,Tomcat在启动时就会自动解压了。然后启动Tomcat,在浏览器中输入http://localhost:8080/struts-example,如果能看到如图3页面,就说明已经运行成功。 在图3中你可以点击“Register with the MailReader Demonstration Application”注册一个MailReader用户,或直接点击“Log on to the MailReader Demonstration Application”,输入用户名和密码(示例程序已经预置了一个用户user/pass,配置在struts-example下的WEB-INF/database.xml文件中)登入。
分析
web.xml 在图3所示的页面中,点击“Log on to the MailReader Demonstration Application”链接,进入/logon.jsp页面,输入预定义的用户名为user、密码为pass,然后提交就进入了图4的用户主页面。
图3 struts example主页面
图4 用户主页面
大家可能已经注意到了,这里的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处理,实际上可以为应用取另一个后缀,只要修改就行了。但下面所有的讨论都以.do为例。我们再看一下这个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,即图2中的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进行分析。 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.webapp. example.LogonForm"/>.
|
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定制标签库,也可以直接使用类似<input type="text" name="username" />的HTML代码,但这样就失去了自动回填的支持。 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()));
|
如果在图5所示页面输入user/abc提示上面的错误,那么原来输入的username域就会自动填充进来了。在一个有大量输入域的表单会大大方便用户。
图5 登陆失败页面
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页面。 (Sunny)
href="file:///C:/DOCUME~1/ADMINI~1/LOCALS~1/Temp/msohtml1/01/clip_filelist.xml" rel="File-List" />