struts2工作原理

Struts2是Struts社区和WebWork社区的共同成果,我们甚至可以说,Struts2是WebWork的升级版,他采用的正是WebWork的核心,所以,Struts2并不是一个不成熟的产品,相反,构建在WebWork基础之上的Struts2是一个运行稳定、性能优异、设计成熟的WEB框架。

下载的Struts2源代码文件是一个名叫struts-2.1.0-src.zip的压缩包,里面的目录和文件非常多,读者可以定位到struts-2.1.0-src"struts-2.0.10"src"core"src"main"java目录下查看Struts2的源文件,如图下所示。

主要的包和类

  Struts2框架的正常运行,除了占核心地位的xwork的支持以外,Struts2本身也提供了许多类,这些类被分门别类组织到不同的包中。从源代码中发现,基本上每一个Struts2类都访问了WebWork提供的功能,从而也可以看出Struts2与WebWork千丝万缕的联系。但无论如何,Struts2的核心功能比如将请求委托给哪个Action处理都是由xwork完成的,Struts2只是在WebWork的基础上做了适当的简化、加强和封装,并少量保留Struts1.x中的习惯。

  以下是对各包的简要说明:

包名

说明

org.apache.struts2. components

该包封装视图组件,Struts2在视图组件上有了很大加强,不仅增加了组件的属性个数,更新增了几个非常有用的组件,如updownselect、doubleselect、datetimepicker、token、tree等。

  另外,Struts2可视化视图组件开始支持主题(theme),缺省情况下,使用自带的缺省主题,如果要自定义页面效果,需要将组件的theme属性设置为simple。

org.apache.struts2. config

该包定义与配置相关的接口和类。实际上,工程中的xml和properties文件的读取和解析都是由WebWork完成的,Struts只做了少量的工作。

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、处理静态内容(Serving static content)

  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的工作机制

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

  1、客户端初始化一个指向Servlet容器(例如Tomcat)的请求;

  2、这个请求经过一系列的过滤器(Filter)(这些过滤器中有一个叫做ActionContextCleanUp的可选过滤器,这个过滤器对于Struts2和其他框架的集成很有帮助,例如:SiteMesh Plugin);

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

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

  5、ActionProxy通过Configuration Manager询问框架的配置文件,找到需要调用的Action类;

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

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

  8、一旦Action执行完毕,ActionInvocation负责根据struts.xml中的配置找到对应的返回结果。返回结果通常是(但不总是,也可能是另外的一个Action链)一个需要被表示的JSP或者FreeMarker的模版。在表示的过程中可以使用Struts2 框架中继承的标签。在这个过程中需要涉及到ActionMapper。

Struts2请求处理源码分析

当用户向Struts2发送请求时,FilterDispatcher的doFilter()方法自动调用,doFilter()方法处理请求过程,如下:

1. 创建值栈对象stack;

2. 创建Action上下文对象;

3. 对请求进行重新封装,此次封装根据请求内容的类型不同,返回不同的对象:

如果为multipart/form-data类型,则返回MultiPartRequestWrapper类型的对象,该对象服务于文件上传,否则返回StrutsRequestWrapper类型的对象,MultiPartRequestWrapper是StrutsRequestWrapper的子类,而这两个类都是HttpServletRequest接口的实现。

4. 通过actionMapper.getMapping()获得ActionMapping对象,Action的配置信息存储在ActionMapping对象中(Action的配置信息:Action的name、namespace和要调用的方法method)。相关代码如下图所示:

clip_image004

以上代码,活动图如下:

clip_image006

5. 如果getMapping()方法返回ActionMapping对象为null,则FilterDispatcher认为用户请求不是Action,此时FilterDispatcher会首先分析:

如果请求以/struts开头,会自动查找在web.xml文件中配置的packages初始化参数,FilterDispatcher会将packages参数值包下的文件当作静态资源处理,即直接在页面上显示文件内容。

如果用户请求的资源不是以/struts开头—可能是.jsp文件,也可能是.html文件,则通过过滤器链继续往下传送,直到到达请求的资源为止。

6. 如果getMapping()方法返回有效的ActionMapping对象,则被认为正在请求某个Action,将调用Dispatcher.serviceAction(request, response, servletContext, mapping)方法。

以上六步,相关代码如下图所示:

clip_image008

clip_image010

以上代码,活动图如下:

clip_image012

7. 请求进入dispatcher.serviceAction(request,response,servletContext,mapping)方法中:

a) 将相关对象信息封装为Map(如:HttpServletRequest、Http parameters、HttpServletResponse、HttpSession、ServletContext、ActionMapping等对象信息),并存入到执行上下文Map中,返回执行上下文Map对象extraMap;

b) 获取mapping对象中存储的action命名空间、name属性、method属性等信息;

c) 加载并解析Struts2配置文件,如果没有人为配置,默认按顺序加载struts-default.xml、struts-plugin.xml、struts.xml,将action配置、result配置、interceptor配置,解析并存入至config对象中,返回文件配置对象config;

d) 根据执行上下文Map、action命名空间、name属性、method属性等创建用户Action的代理对象;

e) 执行Action代理对象proxy.execute()方法,并转向结果;

以上步骤相关代码,如图所示:

clip_image014

8. 执行Action代理对象proxy.execute()方法,该方法的执行,其实就是调用了invocation.invoke()方法,如下图所示:

clip_image016

9. 执行invocation.invoke()方法,实现了截拦器的递归调用和执行Action的execute()方法,DefaultActionInvocation.invoke()方法中代码,如下图所示:

clip_image018

在以上代码中,并未看出拦截器的递归调用,其实是否递归调用,是由程序员来控制的,递归调用实现很简单:

a) 首先看下Interceptor接口定义:

clip_image020

b) 所有的截拦器必须实现intercept方法,而该方法的参数恰恰又是ActionInvocation,所以如果在intercept方法中调用invocation.invoke(),则会继续从Action的Intercepor列表中找到下一个截拦器执行,依此递归调用Intercepor;

Struts2中的日志拦截器LoggingInterceptor,如下图所示:

clip_image022

c) 拦截器递归调用活动图,如下所示:

clip_image024

10. 在invocation.invoke()方法中,执行拦截器、action并获得resultCode完毕后,则会继续执行PreResultListener集合,并生成Result对象,实现PreResultListener接口,可在返回Result之前,做些自定义处理,如图所示

clip_image026

在返回Result之前,通过PreResultListener实现自定义处理,常用的有两种方式:一种在Interceptor中实现,一种在Action实现,如图所示:

clip_image028

clip_image030

以上两种方式,大家可以发现都是通过匿名内部类的方式实现,其实还有一种方式就是通过在拦截器中实现PreResultListener接口,并实现方法beforeResult方法,即可。如下图所示:

clip_image032

11. 最后,通过生成Result完成用户响应;

以上1-11步,为Struts2处理请求的完整流程分析,其相关代码调用流程,如下图所示:

clip_image034

本文内容为struts2工作原理和源码的学习笔记

参考文章为:

1、Struts2请求处理流程及源码分析

2、Struts2源码浅析-请求处理

posted @ 2013-07-17 16:27  kivi  阅读(1039)  评论(0编辑  收藏  举报