Struts2的工作原理文档格式.docx

Struts2的工作原理文档格式.docx

《Struts2的工作原理文档格式.docx》由会员分享，可在线阅读，更多相关《Struts2的工作原理文档格式.docx（21页珍藏版）》请在冰豆网上搜索。

org.apache.struts2.dispatcher

Struts2的核心包，最重要的类都放在该包中。

org.apache.struts2.impl

该包只定义了3个类，他们是StrutsActionProxy、StrutsActionProxyFactory、StrutsObjectFactory，这三个类都是对xwork的扩展。

org.apache.struts2.interceptor

定义内置的截拦器。

org.apache.struts2.util

实用包。

org.apache.struts2.validators

只定义了一个类：

DWRValidator。

org.apache.struts2.views

提供freemarker、jsp、velocity等不同类型的页面呈现。

　　下表是对一些重要类的说明：

类名

org.apache.struts2.dispatcher.Dispatcher

该类有两个作用：

　　1、初始化

　　2、调用指定的Action的execute（）方法。

org.apache.struts2.dispatcher.FilterDispatcher

这是一个过滤器。

文档中已明确说明，如果没有经验，配置时请将url-pattern的值设成/*。

　　该类有四个作用：

　　1、执行Action

　　2、清理ActionContext，避免内存泄漏

　　3、处理静态内容（Servingstaticcontent）

　　4、为请求启动xwork’s的截拦器链。

com.opensymphony.xwork2.ActionProxy

Action的代理接口。

com.opensymphony.xwork2.ctionProxyFactory

生产ActionProxy的工厂。

com.opensymphony.xwork2.ActionInvocation

负责调用Action和截拦器。

com.opensymphony.xwork2.config.providers.XmlConfigurationProvider

负责Struts2的配置文件的解析。

Struts2的工作机制3.1Struts2体系结构图

　　Strut2的体系结构如图15所示：

　　（图15）

　　3.2Struts2的工作机制

　　从图15可以看出，一个请求在Struts2框架中的处理大概分为以下几个步骤：

　　1、客户端初始化一个指向Servlet容器（例如Tomcat）的请求；

　　2、这个请求经过一系列的过滤器（Filter）（这些过滤器中有一个叫做ActionContextCleanUp的可选过滤器，这个过滤器对于Struts2和其他框架的集成很有帮助，例如：

SiteMeshPlugin）；

　　3、接着FilterDispatcher被调用，FilterDispatcher询问ActionMapper来决定这个请求是否需要调用某个Action；

　　4、如果ActionMapper决定需要调用某个Action，FilterDispatcher把请求的处理交给ActionProxy；

　　5、ActionProxy通过ConfigurationManager询问框架的配置文件，找到需要调用的Action类；

　　6、ActionProxy创建一个ActionInvocation的实例。

　　7、ActionInvocation实例使用命名模式来调用，在调用Action的过程前后，涉及到相关拦截器（Intercepter）的调用。

　　8、一旦Action执行完毕，ActionInvocation负责根据struts.xml中的配置找到对应的返回结果。

返回结果通常是（但不总是，也可能是另外的一个Action链）一个需要被表示的JSP或者FreeMarker的模版。

在表示的过程中可以使用Struts2框架中继承的标签。

在这个过程中需要涉及到ActionMapper。

　　注：

以上步骤参考至网上，具体网址已忘记。

在此表示感谢！

　　3.3Struts2源代码分析　

　　和Struts1.x不同，Struts2的启动是通过FilterDispatcher过滤器实现的。

下面是该过滤器在web.xml文件中的配置：

　　代码清单6：

web.xml（截取）

　　<

filter>

　　　<

filter-name>

struts2<

/filter-name>

filter-class>

　　　　　org.apache.struts2.dispatcher.FilterDispatcher

/filter-class>

/filter>

filter-mapping>

url-pattern>

/*<

/url-pattern>

/filter-mapping>

　　Struts2建议，在对Struts2的配置尚不熟悉的情况下，将url-pattern配置为/*，这样该过滤器将截拦所有请求。

　　实际上，FilterDispatcher除了实现Filter接口以外，还实现了StrutsStatics接口，继承代码如下：

　　代码清单7：

FilterDispatcher结构

publicclassFilterDispatcherimplementsStrutsStatics,Filter{

}

　　StrutsStatics并没有定义业务方法，只定义了若干个常量。

Struts2对常用的接口进行了重新封装，比如HttpServletRequest、HttpServletResponse、HttpServletContext等。

　以下是StrutsStatics的定义：

　　代码清单8：

StrutsStatics.java

publicinterfaceStrutsStatics{

　　/**

　　*ConstantfortheHTTPrequestobject.

　　*/

　　publicstaticfinalStringHTTP_REQUEST="

com.opensymphony.xwork2.dispatcher.HttpServletRequest"

;

　　*ConstantfortheHTTPresponseobject.

　　publicstaticfinalStringHTTP_RESPONSE="

com.opensymphony.xwork2.dispatcher.HttpServletResponse"

　　*ConstantforanHTTPrequestdispatcher}.

　　publicstaticfinalStringSERVLET_DISPATCHER="

com.opensymphony.xwork2.dispatcher.ServletDispatcher"

　　*Constantfortheservletcontext}object.

　　publicstaticfinalStringSERVLET_CONTEXT="

com.opensymphony.xwork2.dispatcher.ServletContext"

　　*ConstantfortheJSPpagecontext}.

publicstaticfinalStringPAGE_CONTEXT="

com.opensymphony.xwork2.dispatcher.PageContext"

　　/**ConstantforthePortletContextobject*/

　　publicstaticfinalStringSTRUTS_PORTLET_CONTEXT="

struts.portlet.context"

　　容器启动后，FilterDispatcher被实例化，调用init（FilterConfigfilterConfig）方法。

该方法创建Dispatcher类的对象，并且将FilterDispatcher配置的初始化参数传到对象中（详情请参考代码清单10），并负责Action的执行。

然后得到参数packages，值得注意的是，还有另外三个固定的包和该参数进行拼接，分别是org.apache.struts2.static、template、和org.apache.struts2.interceptor.debugging，中间用空格隔开，经过解析将包名变成路径后存储到一个名叫pathPrefixes的数组中，这些目录中的文件会被自动搜寻。

　　代码清单9：

FilterDispatcher.init（）方法

　　publicvoidinit（FilterConfigfilterConfig）throwsServletException{

　　　　this.filterConfig=filterConfig;

　　　　dispatcher=createDispatcher（filterConfig）;

　　　　dispatcher.init（）;

　　　　Stringparam=filterConfig.getInitParameter（"

packages"

）;

　　　　Stringpackages="

org.apache.struts2.statictemplateorg.apache.struts2.interceptor.debugging"

　　　　if（param!

=null）{

　　　　　　packages=param+"

"

+packages;

　　　　}

　　　　this.pathPrefixes=parse（packages）;

　　代码清单10：

FilterDispatcher.createDispatcher（）方法

　　protectedDispatchercreateDispatcher（FilterConfigfilterConfig）{

　　　　Map<

String,String>

params=newHashMap<

（）;

　　　　for（Enumeratione=filterConfig.getInitParameterNames（）;

e.hasMoreElements（）;

）{

　　　　　　Stringname=（String）e.nextElement（）;

　　　　　　Stringvalue=filterConfig.getInitParameter（name）;

　　　　　　params.put（name,value）;

　　　　returnnewDispatcher（filterConfig.getServletContext（）,params）;

　}

　　当用户向Struts2发送请求时，FilterDispatcher的doFilter（）方法自动调用，这个方法非常关键。

首先，Struts2对请求对象进行重新包装，此次包装根据请求内容的类型不同，返回不同的对象，如果为multipart/form-data类型，则返回MultiPartRequestWrapper类型的对象，该对象服务于文件上传，否则返回StrutsRequestWrapper类型的对象，MultiPartRequestWrapper是StrutsRequestWrapper的子类，而这两个类都是HttpServletRequest接口的实现。

包装请求对象如代码清单11所示：

　　代码清单11：

FilterDispatcher.prepareDispatcherAndWrapRequest（）方法

protectedHttpServletRequestprepareDispatcherAndWrapRequest（

　　　　HttpServletRequestrequest,

　　　　HttpServletResponseresponse）throwsServletException{

　　　　Dispatcherdu=Dispatcher.getInstance（）;

　　　　if（du==null）{

　　　　　　Dispatcher.setInstance（dispatcher）;

　　　　　　dispatcher.prepare（request,response）;

　　　　}else{

　　　　　　dispatcher=du;

　　　　}　　　　

　　　　try{

　　　　　　request=dispatcher.wrapRequest（request,getServletContext（））;

　　　　}catch（IOExceptione）{

　　　　　　Stringmessage="

CouldnotwrapservletrequestwithMultipartRequestWrapper!

"

　　　　　　LOG.error（message,e）;

　　　　　　thrownewServletException（message,e）;

　　　　returnrequest;

　　request对象重新包装后，通过ActionMapper的getMapping（）方法得到请求的Action，Action的配置信息存储在ActionMapping对象中，该语句如下：

mapping=actionMapper.getMapping（request,dispatcher.getConfigurationManager（））;

。

下面是ActionMapping接口的实现类DefaultActionMapper的getMapping（）方法的源代码：

　　代码清单12：

DefaultActionMapper.getMapping（）方法

　　publicActionMappinggetMapping（HttpServletRequestrequest,

　　　　　　ConfigurationManagerconfigManager）{

　　　　ActionMappingmapping=newActionMapping（）;

　　　　Stringuri=getUri（request）;

//得到请求路径的URI，如：

testAtcion.action或testAction!

method

　　　　uri=dropExtension（uri）;

//删除扩展名，默认扩展名为action，在代码中的定义是Listextensions=newArrayList（）{{add（"

action"

}};

　　　　if（uri==null）{

　　　　　　returnnull;

　　　　parseNameAndNamespace（uri,mapping,configManager）;

//从uri变量中解析出Action的name和namespace

　　　　handleSpecialParameters（request,mapping）;

//将请求参数中的重复项去掉

　　　//如果Action的name没有解析出来，直接返回

　　　　if（mapping.getName（）==null）{

　　　//下面处理形如testAction!

method格式的请求路径

　　　　if（allowDynamicMethodCalls）{

　　　　　　//handle"

name!

method"

convention.

　　　　　　Stringname=mapping.getName（）;

　　　　　　intexclamation=name.lastIndexOf（"

!

//!

是Action名称和方法名的分隔符

　　　　　　if（exclamation!

=-1）{

　　　　　　　　mapping.setName（name.substring（0,exclamation））;

//提取左边为name

　　　　　　　　mapping.setMethod（name.substring（exclamation+1））;

//提取右边的method

　　　　　　}

　　　　returnmapping;

　　}

　　该代码的活动图如下：

　　（图16）

　　从代码中看出，getMapping（）方法返回ActionMapping类型的对象，该对象包含三个参数：

Action的name、namespace和要调用的方法method。

　　如果getMapping（）方法返回ActionMapping对象为null，则FilterDispatcher认为用户请求不是Action，自然另当别论，FilterDispatcher会做一件非常有意思的事：

如果请求以/struts开头，会自动查找在web.xml文件中配置的packages初始化参数，就像下面这样（注意粗斜体部分）：

　　代码清单13：

web.xml（部分）

init-param>

　　　　　<

param-name>

packages<

/param-name>

param-value>

com.lizanhong.action<

/param-value>

/init-param>

　　FilterDispatcher会将com.lizanhong.action包下的文件当作静态资源处理，即直接在页面上显示文件内容，不过会忽略扩展名为class的文件。

比如在com.lizanhong.action包下有一个aaa.txt的文本文件，其内容为“中华人民共和国”，访问http:

//localhost:

8081/Struts2Demo/struts/aaa.txt时会有如图17的输出：

　　（图17）

　　查找静态资源的源代码如清单14：

　　代码清单14：

FilterDispatcher.findStaticResource（）方法

　　protectedvoidfindStaticResource（Stringname,HttpServletRequestrequest,HttpServletResponseresponse）throwsIOException{

　　　　if（!

name.endsWith（"

.class"

））{//忽略class文件

　　　　　//遍历packages参数

　　　　　　for（StringpathPrefix:

pathPrefixes）{

　　　　　　　　InputStreamis=findInputStream（name,pathPrefix）;

//读取请求文件流

　　　　　　　　if（is!

　　　　　　　　　　……（省略部分代码）

　　　　　　　　　　//setthecontent-typeheader

　　　　　　　　　　StringcontentType=getContentType（name）;

//读取内容类型

　　　　　　　　　　if（contentType!

　　　　　　　　　　　　response.setContentType（contentType）;

//重新设置内容类型

　　　　　　　　　　}

　　　　　　　　　……（省略部分代码）