struts2源代码分析

本章讲述Struts2的工作原理。

　　读者如果曾经学习过Struts1.x或者有过Struts1.x的开发经验，那么千万不要想当然地以为这一章可以跳过。实际上Struts1.x与Struts2并无我们想象的血缘关系。虽然Struts2的开发小组极力保留Struts1.x的习惯，但因为Struts2的核心设计完全改变，从思想到设计到工作流程，都有了很大的不同。

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

　　本章主要对Struts的源代码进行分析，因为Struts2与WebWork的关系如此密不可分，因此，读者需要下载xwork的源代码，访问http://www.opensymphony.com/xwork/download.action即可自行下载。

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

主要的包和类 

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

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

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

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

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

　3.2Struts2的工作机制 

　　从图15可以看出，一个请求在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。

　　注：以上步骤参考至网上，具体网址已忘记。在此表示感谢！

　　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>
　　　 <filter-name>struts2</filter-name>
　　　 <url-pattern>/*</url-pattern>
　　</filter-mapping>

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

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

　　代码清单7：FilterDispatcher结构

publicclass FilterDispatcher implements StrutsStatics, Filter {
}

　　StrutsStatics并没有定义业务方法，只定义了若干个常量。Struts2对常用的接口进行了重新封装，比如HttpServletRequest、HttpServletResponse、HttpServletContext等。　以下是StrutsStatics的定义：

　　代码清单8：StrutsStatics.java

publicinterface StrutsStatics {
　　/**
　　 *ConstantfortheHTTPrequestobject.
　　 */
　　publicstaticfinal String HTTP_REQUEST = "com.opensymphony.xwork2.dispatcher.HttpServletRequest";
　　/**
　　 *ConstantfortheHTTPresponseobject.
　　 */
　　publicstaticfinal String HTTP_RESPONSE = "com.opensymphony.xwork2.dispatcher.HttpServletResponse";
　　/**
　　 *ConstantforanHTTPrequest dispatcher}.
　　 */
　　publicstaticfinal String SERVLET_DISPATCHER = "com.opensymphony.xwork2.dispatcher.ServletDispatcher";
　　/**
　　 *Constantfortheservlet context}object.
　　 */
　　publicstaticfinal String SERVLET_CONTEXT = "com.opensymphony.xwork2.dispatcher.ServletContext";
　　/**
　　 *ConstantfortheJSPpage context}.
　　 */
publicstaticfinal String PAGE_CONTEXT = "com.opensymphony.xwork2.dispatcher.PageContext";
　　/**ConstantforthePortletContextobject*/
　　publicstaticfinal String STRUTS_PORTLET_CONTEXT = "struts.portlet.context";
}

　　容器启动后，FilterDispatcher被实例化，调用init(FilterConfig filterConfig)方法。该方法创建Dispatcher类的对象，并且将FilterDispatcher配置的初始化参数传到对象中（详情请参考代码清单10），并负责Action的执行。然后得到参数packages，值得注意的是，还有另外三个固定的包和该参数进行拼接，分别是org.apache.struts2.static、template、和org.apache.struts2.interceptor.debugging，中间用空格隔开，经过解析将包名变成路径后存储到一个名叫pathPrefixes的数组中，这些目录中的文件会被自动搜寻。

　　代码清单9：FilterDispatcher.init()方法

　　publicvoid init(FilterConfig filterConfig) throws ServletException {
　　　　this.filterConfig = filterConfig;　　　
　　　　dispatcher = 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：FilterDispatcher.createDispatcher()方法
　　protected Dispatcher createDispatcher(FilterConfig filterConfig) {
　　　　Map<String,String> params = new HashMap<String,String>();
　　　　for (Enumeration e = filterConfig.getInitParameterNames(); e.hasMoreElements(); ) {
　　　　　　String name = (String) e.nextElement();
　　　　　　String value = filterConfig.getInitParameter(name);
　　　　　　params.put(name, value);
　　　　}
　　　　returnnew Dispatcher(filterConfig.getServletContext(), params);
　 }

　　当用户向Struts2发送请求时，FilterDispatcher的doFilter()方法自动调用，这个方法非常关键。首先，Struts2对请求对象进行重新包装，此次包装根据请求内容的类型不同，返回不同的对象，如果为multipart/form-data类型，则返回MultiPartRequestWrapper类型的对象，该对象服务于文件上传，否则返回StrutsRequestWrapper类型的对象，MultiPartRequestWrapper是StrutsRequestWrapper的子类，而这两个类都是HttpServletRequest接口的实现。包装请求对象如代码清单11所示：

　　代码清单11：FilterDispatcher.prepareDispatcherAndWrapRequest()方法

protectedHttpServletRequest prepareDispatcherAndWrapRequest(
　　　　HttpServletRequest request,
　　　　HttpServletResponse response) throws ServletException {
　　　　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 with MultipartRequestWrapper!";
　　　　　　LOG.error(message, e);
　　　　　　thrownew ServletException(message, e);
　　　　}
　　　　return request;
}

　　request对象重新包装后，通过ActionMapper的getMapping()方法得到请求的Action，Action的配置信息存储在ActionMapping对象中，该语句如下：mapping = actionMapper.getMapping(request, dispatcher.getConfigurationManager());。下面是ActionMapper接口的实现类DefaultActionMapper的getMapping()方法的源代码：

　　代码清单12：DefaultActionMapper.getMapping()方法

　　public ActionMapping getMapping(HttpServletRequest request,
　　　　　　ConfigurationManager configManager) {
　　　　ActionMapping mapping = new ActionMapping();
　　　　String uri = getUri(request);//得到请求路径的URI，如：testAtcion.action或testAction!method
　　　　uri = dropExtension(uri);//删除扩展名，默认扩展名为action，在代码中的定义是List extensions = new ArrayList() {{ add("action");}};
　　　　if (uri == null) {
　　　　　　returnnull;
　　　　}
　　　　parseNameAndNamespace(uri, mapping, configManager);//从uri变量中解析出Action的name和namespace
　　　　handleSpecialParameters(request, mapping);//将请求参数中的重复项去掉
　　　 //如果Action的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.substring(0, exclamation));//提取左边为name
　　　　　　　　mapping.setMethod(name.substring(exclamation + 1));//提取右边的method
　　　　　　}
　　　　}
　　　　return mapping;
　　}

　　该代码的活动图如下： 

　从代码中看出，getMapping()方法返回ActionMapping类型的对象，该对象包含三个参数：Action的name、namespace和要调用的方法method。

　　如果getMapping()方法返回ActionMapping对象为null，则FilterDispatcher认为用户请求不是Action，自然另当别论，FilterDispatcher会做一件非常有意思的事：如果请求以/struts开头，会自动查找在web.xml文件中配置的packages初始化参数，就像下面这样(注意粗斜体部分)：

　　代码清单13：web.xml(部分)

　　<filter>
　　　 <filter-name>struts2</filter-name>
　　　 <filter-class>
　　　　　 org.apache.struts2.dispatcher.FilterDispatcher
　　　 </filter-class>
　　　 <init-param>
　　　　　 <param-name>packages</param-name>
　　　　　 <param-value>com.lizanhong.action</param-value>
　　　 </init-param>
　　</filter>

【下载地址】

百度网盘链接：https://pan.baidu.com/s/1WSrtpkIunVgUuRIXhgB3jQ

提取码：5s11