1、本章讲述 Struts2 的工作原理。读者如果曾经学习过 Struts1.x 或者有过 Struts1.x 的开发经验,那么千万不要想当然地以为这一章可以跳过。实际上 Struts1.x 与 Struts2 并无我们想象的血缘关系。虽然 Struts2 的开发小组极力保留 Struts1.x 的习惯,但因为 Struts2 的核心设计完全改变,从思想到设计到工作流程,都有了很大的不同。Struts2 是 Struts 社区和 WebWork 社区的共同成果,我们甚至可以说, Struts2 是 WebWork 的升级版,他采用的正是 WebWork 的核心,所以,Struts2 并不是一个不成
2、熟的产品,相反,构建在 WebWork 基础之上的 Struts2 是一个运行稳定、性能优异、设计成熟的 WEB 框架。本章主要对 Struts 的源代码进行分析,因为 Struts2 与 WebWork 的关系如此密不可分,因此,读者需要下载 xwork 的源代码,访问 http:/ 即可自行下载。下载的 Struts2 源代码文件是一个名叫 struts-2.1.0-src.zip 的压缩包,里面的目录和文件非常多,读者可以定位到 struts-2.1.0-src“struts-2.0.10“src“core“src“main“java 目录下查看 Struts2 的源文件,如图 14 所
3、示。(图 14)主要的包和类 Struts2 框架的正常运行,除了占核心地位的 xwork 的支持以外,Struts2 本身也提供了许多类,这些类被分门别类组织到不同的包中。从源代码中发现,基本上每一个 Struts2 类都访问了 WebWork提供的功能,从而也可以看出 Struts2 与 WebWork 千丝万缕的联系。但无论如何,Struts2 的核心功能比如将请求委托给哪个 Action 处理都是由 xwork 完成的,Struts2 只是在 WebWork 的基础上做了适当的简化、加强和封装,并少量保留 Struts1.x 中的习惯。以下是对各包的简要说明:包名 说明org.apac
4、he.struts2. components该包封装视图组件,Struts2 在视图组件上有了很大加强,不仅增加了组件的属性个数,更新增了几个非常有用的组件,如updownselect、doubleselect、datetimepicker、token、tree等。 另外,Struts2 可视化视图组件开始支持主题(theme),缺省情况下,使用自带的缺省主题,如果要自定义页面效果,需要将组件的theme 属性设置为 simple。org.apache.struts2. config该包定义与配置相关的接口和类。实际上,工程中的 xml 和properties 文件的读取和解析都是由 WebW
5、ork 完成的,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 只定义
6、了一个类: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、执行 Action2
7、、清理 ActionContext,避免内存泄漏3、处理静态内容(Serving static content)4、为请求启动 xworks 的截拦器链。com.opensymphony.xwork2. ActionProxy Action 的代理接口。com.opensymphony.xwork2. ctionProxyFactory 生产 ActionProxy 的工厂。com.opensymphony.xwork2.ActionInvocation 负责调用 Action 和截拦器。com.opensymphony.xwork2.config.providers. XmlConfigur
8、ationProvider 负责 Struts2 的配置文件的解析。Struts2 的工作机制 3.1Struts2 体系结构图 Strut2 的体系结构如图 15 所示:(图 15)3.2Struts2 的工作机制 从图 15 可以看出,一个请求在 Struts2 框架中的处理大概分为以下几个步骤:1、客户端初始化一个指向 Servlet 容器(例如 Tomcat)的请求;2、这个请求经过一系列的过滤器(Filter)(这些过滤器中有一个叫做 ActionContextCleanUp 的可选过滤器,这个过滤器对于 Struts2 和其他框架的集成很有帮助,例如: SiteMesh Plugi
9、n);3、接着 FilterDispatcher 被调用,FilterDispatcher 询问 ActionMapper 来决定这个请求是否需要调用某个 Action;4、如果 ActionMapper 决定需要调用某个 Action,FilterDispatcher 把请求的处理交给 ActionProxy;5、ActionProxy 通过 Configuration Manager 询问框架的配置文件,找到需要调用的 Action 类;6、ActionProxy 创建一个 ActionInvocation 的实例。7、ActionInvocation 实例使用命名模式来调用,在调用 Ac
10、tion 的过程前后,涉及到相关拦截器(Intercepter)的调用。8、一旦 Action 执行完毕,ActionInvocation 负责根据 struts.xml 中的配置找到对应的返回结果。返回结果通常是(但不总是,也可能是另外的一个 Action 链)一个需要被表示的 JSP 或者 FreeMarker 的模版。在表示的过程中可以使用 Struts2 框架中继承的标签。在这个过程中需要涉及到 ActionMapper。注:以上步骤参考至网上,具体网址已忘记。在此表示感谢!3.3Struts2 源代码分析 和 Struts1.x 不同,Struts2 的启动是通过 FilterDis
11、patcher 过滤器实现的。下面是该过滤器在 web.xml 文件中的配置:代码清单 6:web.xml (截取)struts2org.apache.struts2.dispatcher.FilterDispatcherstruts2/*Struts2 建议,在对 Struts2 的配置尚不熟悉的情况下,将 url-pattern 配置为/*,这样该过滤器将截拦所有请求。实际上,FilterDispatcher 除了实现 Filter 接口以外,还实现了 StrutsStatics 接口,继承代码如下:代码清单 7:FilterDispatcher 结构publicclass FilterD
12、ispatcher implements StrutsStatics, Filter StrutsStatics 并没有定义业务方法,只定义了若干个常量。 Struts2 对常用的接口进行了重新封装,比如 HttpServletRequest、HttpServletResponse、HttpServletContext 等。 以下是 StrutsStatics 的定义:代码清单 8:StrutsStatics.javapublicinterface StrutsStatics /*ConstantfortheHTTPrequestobject.*/publicstaticfinal Strin
13、g HTTP_REQUEST = “com.opensymphony.xwork2.dispatcher.HttpServletRequest“;/*ConstantfortheHTTPresponseobject.*/publicstaticfinal String HTTP_RESPONSE = “com.opensymphony.xwork2.dispatcher.HttpServletResponse“;/*ConstantforanHTTPrequest dispatcher.*/publicstaticfinal String SERVLET_DISPATCHER = “com.o
14、pensymphony.xwork2.dispatcher.ServletDispatcher“;/*Constantfortheservlet contextobject.*/publicstaticfinal String SERVLET_CONTEXT = “com.opensymphony.xwork2.dispatcher.ServletContext“;/*ConstantfortheJSPpage context.*/publicstaticfinal String PAGE_CONTEXT = “com.opensymphony.xwork2.dispatcher.PageCo
15、ntext“;/*ConstantforthePortletContextobject*/publicstaticfinal String STRUTS_PORTLET_CONTEXT = “struts.portlet.context“;容器启动后,FilterDispatcher 被实例化,调用 init(FilterConfig filterConfig)方法。该方法创建Dispatcher 类的对象,并且将 FilterDispatcher 配置的初始化参数传到对象中(详情请参考代码清单 10),并负责 Action 的执行。然后得到参数 packages,值得注意的是,还有另外三个固
16、定的包和该参数进行拼接,分别是 org.apache.struts2.static、template、和 org.apache.struts2.interceptor.debugging,中间用空格隔开,经过解析将包名变成路径后存储到一个名叫 pathPrefixes 的数组中,这些目录中的文件会被自动搜寻。代码清单 9:FilterDispatcher.init()方法publicvoid init(FilterConfig filterConfig) throws ServletException this.filterConfig = filterConfig; dispatcher =
17、 createDispatcher(filterConfig);dispatcher.init(); String param = filterConfig.getInitParameter(“packages“);String packages = “org.apache.struts2.static template org.apache.struts2.interceptor.debugging“;if (param != null) packages = param + “ “ + packages;this.pathPrefixes = parse(packages);代码清单 10
18、:FilterDispatcher.createDispatcher() 方法protected Dispatcher createDispatcher(FilterConfig filterConfig) Map params = new HashMap();for (Enumeration e = filterConfig.getInitParameterNames(); e.hasMoreElements(); ) String name = (String) e.nextElement();String value = filterConfig.getInitParameter(nam
19、e);params.put(name, value);returnnew Dispatcher(filterConfig.getServletContext(), params);当用户向 Struts2 发送请求时,FilterDispatcher 的 doFilter()方法自动调用,这个方法非常关键。首先,Struts2 对请求对象进行重新包装,此次包装根据请求内容的类型不同,返回不同的对象,如果为 multipart/form-data 类型,则返回 MultiPartRequestWrapper 类型的对象,该对象服务于文件上传,否则返回 StrutsRequestWrapper 类
20、型的对象,MultiPartRequestWrapper 是 StrutsRequestWrapper 的子类,而这两个类都是 HttpServletRequest 接口的实现。包装请求对象如代码清单 11 所示:代码清单 11:FilterDispatcher.prepareDispatcherAndWrapRequest()方法protectedHttpServletRequest prepareDispatcherAndWrapRequest(HttpServletRequest request,HttpServletResponse response) throws ServletEx
21、ception Dispatcher du = Dispatcher.getInstance();if (du = null) Dispatcher.setInstance(dispatcher); dispatcher.prepare(request, response); else dispatcher = du; try request = dispatcher.wrapRequest(request, getServletContext(); catch (IOException e) String message = “Could not wrap servlet request w
22、ith MultipartRequestWrapper!“;LOG.error(message, e);thrownew ServletException(message, e);return request;request 对象重新包装后,通过 ActionMapper 的 getMapping()方法得到请求的 Action,Action的配置信息存储在 ActionMapping 对象中,该语句如下:mapping = actionMapper.getMapping(request, dispatcher.getConfigurationManager();。下面是 ActionMapp
23、er 接口的实现类 DefaultActionMapper 的 getMapping()方法的源代码:代码清单 12:DefaultActionMapper.getMapping() 方法public ActionMapping getMapping(HttpServletRequest request,ConfigurationManager configManager) ActionMapping mapping = new ActionMapping();String uri = getUri(request);/得到请求路径的 URI,如:testAtcion.action 或 tes
24、tAction!methoduri = dropExtension(uri);/删除扩展名,默认扩展名为 action,在代码中的定义是 List extensions = new ArrayList() add(“action“);if (uri = null) returnnull;parseNameAndNamespace(uri, mapping, configManager);/从 uri 变量中解析出 Action 的 name 和 namespacehandleSpecialParameters(request, mapping);/将请求参数中的重复项去掉/如果 Action
25、的 name 没有解析出来,直接返回if (mapping.getName() = null) returnnull;/下面处理形如 testAction!method 格式的请求路径if (allowDynamicMethodCalls) / handle “name!method“ convention.String name = mapping.getName();int exclamation = name.lastIndexOf(“!“);/!是 Action 名称和方法名的分隔符if (exclamation != -1) mapping.setName(name.substrin
26、g(0, exclamation);/提取左边为 namemapping.setMethod(name.substring(exclamation + 1);/提取右边的 methodreturn mapping;该代码的活动图如下: (图 16)从代码中看出,getMapping() 方法返回 ActionMapping 类型的对象,该对象包含三个参数:Action 的 name、namespace 和要调用的方法 method。如果 getMapping()方法返回 ActionMapping 对象为 null,则 FilterDispatcher 认为用户请求不是 Action,自然另当
27、别论,FilterDispatcher 会做一件非常有意思的事:如果请求以/struts 开头,会自动查找在 web.xml 文件中配置的 packages 初始化参数,就像下面这样(注意粗斜体部分):代码清单 13:web.xml(部分)struts2org.apache.struts2.dispatcher.FilterDispatcherpackagescom.lizanhong.actionFilterDispatcher 会将 com.lizanhong.action 包下的文件当作静态资源处理,即直接在页面上显示文件内容,不过会忽略扩展名为 class 的文件。比如在 com.li
28、zanhong.action 包下有一个 aaa.txt的文本文件,其内容为“中华人民共和国”,访问 http:/localhost:8081/Struts2Demo/struts/aaa.txt 时会有如图 17 的输出:(图 17)查找静态资源的源代码如清单 14:代码清单 14:FilterDispatcher.findStaticResource() 方法protectedvoid findStaticResource(String name, HttpServletRequest request, HttpServletResponse response) throws IOException if (!name.endsWith(“.class“) /忽略 class 文件