Struts2 源码学习(一):模拟拦截器

   这是一篇模拟Struts2拦截器的文章，模拟就不可能和Struts2的一样，但是我尽量需找模拟的重点，理解思路...好了不多说了，现在开始了

首先来看一下，Struts2 框架的整个流程图

这个图把Struts 2 的整个处理流程详细地描述出来，在这里我再讲一下

当我们请求一个Action后，请求到达过滤器FilterDispatcher，FilterDispatcher帮我们创建一个ActionProxy，ActionProxy通过Configuratiion Manager从struts.xml中读到相应的配置信息，ActionProxy拥有一个ActionInvocation的实例，通过ActionInvocation调用invoke()方法，invoke()中的请求过程就是ActionInvocation()右边那样的顺序，最后形成HttpServletResponse对象，返回到客户端

现在我们顺序来进行模拟

1、按照Struts 2，首先创建一个Action接口

Action.java

package imitation.action;/** * @project_name struts2 * @file_name Action.java * @author tianhandigeng * @version Nov 19, 2010 9:39:44 AM * @declaration */public interface Action { public abstract String execute() throws Exception; public static final String SUCCESS = "success"; public static final String NONE = "none"; public static final String ERROR = "error"; public static final String INPUT = "input"; public static final String LOGIN = "login";}

在Struts2中它提供了一个ActionSupport抽象类，这个除了实现Action接口以外，还实现了一系列的接口，比如说验证的接口，等于说这个ActinoSupport是一个工具类，所以在实际的开发中，我们就继承ActinSupport类就行

ActionSupport.java

package imitation.action;/** * @project_name struts2 * @file_name ActionSupport.java * @author tianhandigeng * @version Nov 19, 2010 9:41:36 AM * @declaration */public class ActionSupport implements Action {public String execute() throws Exception {// TODO Auto-generated method stubreturn "success";}public void validate(){}}

 

这里写了其中的一个validate()，当验证的时候就会用到这个

最后实现自己的一个Action

MyAction.java

package imitation.action;import com.opensymphony.xwork2.ActionSupport;/** * @project_name struts2 * @file_name MyAction.java * @author tianhandigeng * @version Nov 19, 2010 9:48:28 AM * @declaration */public class MyAction extends ActionSupport { public String execute(){ System.out.println("execute a action..."); return SUCCESS; }}

 

2、创建拦截器

首先，创建一个Interceptor接口

Interceptor.java

package imitation.interceptor;import imitation.invocation.ActionInvocation;/** * @project_name struts2 * @file_name Interceptor.java * @author tianhandigeng * @version Nov 19, 2010 9:51:29 AM * @declaration */public interface Interceptor {public abstract void destroy();public abstract void init();public abstract String iterceptor(ActionInvocation actionInvocation)throws Exception;}

Struts2 中另外提供一个AbstractInterceptor类，该类提供了一个init和destory方法的空实现，如果我们实现的拦截器不需要打开资源，则可以无需实现两个方法。可见，用继承AbstractInterceptor类来实现自定义拦截器会更加简单

AbstractInterceptor.java

package imitation.interceptor;import imitation.invocation.ActionInvocation;/** * @project_name struts2 * @file_name AbstractInterceptor.java * @author tianhandigeng * @version Nov 19, 2010 10:01:08 AM * @declaration */public abstract class AbstractInterceptor implements Interceptor {public void destroy() {// TODO Auto-generated method stub}public void init() {// TODO Auto-generated method stub}public abstract String iterceptor(ActionInvocation actionInvocation)throws Exception;}

下面是自己实现的两个Interceptor

MyInterceptor_1.java

package imitation.interceptor;import imitation.invocation.ActionInvocation;/** * @project_name struts2 * @file_name MyInterceptor_1.java * @author tianhandigeng * @version Nov 19, 2010 10:02:25 AM * @declaration */public class MyInterceptor_1 extends AbstractInterceptor {@Overridepublic String iterceptor(ActionInvocation actionInvocation)throws Exception {System.out.println(this.getClass().getName()+"execute..."+new java.util.Date());String result=actionInvocation.invoke();System.out.println(this.getClass().getName()+"execute..."+new java.util.Date());return result;}}

MyInterceptor_2.java

package imitation.interceptor;import imitation.invocation.ActionInvocation;/** * @project_name struts2 * @file_name MyInterceptor_1.java * @author tianhandigeng * @version Nov 19, 2010 10:02:25 AM * @declaration */public class MyInterceptor_2 extends AbstractInterceptor {@Overridepublic String iterceptor(ActionInvocation actionInvocation)throws Exception {System.out.println(this.getClass().getName()+"execute..."+new java.util.Date());String result=actionInvocation.invoke();System.out.println(this.getClass().getName()+"execute..."+new java.util.Date());return result;}}

 

3、接下来写的我觉得是最重要的部分了，ActionInvocation接口，先来看看ActionInvocation的描述，这里就自己拿文档里面的解释来了

An ActionInvocation represents the execution state of an Action. It holds the Interceptors and the Action instance. By repeated re-entrant execution of the invoke() method, initially by the ActionProxy, then by the Interceptors, the Interceptors are all executed, and then the Action and the Result.

也就是说ActionInvocation是整个Aciton执行的控制者

现在来看看ActionInvocation接口

ActionInvocation.java

package imitation.invocation;/** * @project_name struts2 * @file_name ActionInvocation.java * @author tianhandigeng * @version Nov 19, 2010 9:54:43 AM * @declaration */public interface ActionInvocation { public abstract Object getAction();//获得与这个ActionInvocation关联的Action public abstract String invoke() throws Exception;//执行这个AcitonInvocation的下一步动作 public abstract String invokeActionOnly() throws Exception; public abstract String getResultCode(); public abstract void setResultCode(String s);}

同样为ActionInvocation提供了实现类DefaultActionInvocation

DefaultActionInvocation.java

package imitation.invocation;import imitation.interceptor.Interceptor;import java.lang.reflect.Method;import java.util.Iterator;/** * @project_name struts2 * @file_name DefaultActionInvocation.java * @author tianhandigeng * @version Nov 19, 2010 10:08:12 AM * @declaration */public class DefaultActionInvocation implements ActionInvocation {protected Iterator interceptors;protected Object action;protected String resultCode; /**源码中一个初始化方法,传入一个ActionProxy,获得拦截器初始化interceptorspublic void init(){ List interceptorList = new ArrayList(proxy.getConfig().getInterceptors()); interceptors = interceptorList.iterator();}*/public Object getAction() {return action;}public String getResultCode() {return resultCode;} public void setResultCode(String resultCode) { /** if(isExecuted()) { throw new IllegalStateException("Result has already been executed."); } else { this.resultCode = resultCode; return; }*/ this.resultCode=resultCode; }public String invoke() throws Exception {if(interceptors.hasNext()){Interceptor interceptor=(Interceptor)interceptors.next();resultCode=interceptor.iterceptor(DefaultActionInvocation.this);}elseresultCode=invokeActionOnly();//调用actionreturn resultCode;}/**源码中不是直接这样，这里简化一下*/public String invokeActionOnly() throws Exception {String result=null;try{Method method=getAction().getClass().getMethod("execute");//不一定只有executereturn (String) method.invoke(getAction(),null);}catch(NoSuchMethodException e){e.printStackTrace();}return result;}/**这个方法在源码中是没有的为了获得Action,所以引进来*/public void setAction(Object action) {this.action = action;}/**源码中创建Action的方法protected void createAction(Map contextMap){action = objectFactory.buildAction(proxy.getActionName(), proxy.getNamespace(), proxy.getConfig(), contextMap);}*/ /**这个方法在源码中没有*/public void setInterceptors(Iterator interceptors) {this.interceptors = interceptors;} }

 

4、测试，这里是直接创建Action进行测试，说到这里这就体现了Struts 2的一个好处了，Struts 1 的一个主要的问题就是execute()方法依赖于Servlet API，这使得Aciton测试要依赖Web容器。为了脱离Web容器测试Struts 1的Action，必须借助第三方的扩展：Struts TestCase，该扩展下包含了系列的Mock对象(模拟了HttpServletRequest和HttpServletResponse对象),从而可以脱离容器测试Action，Struts 2 可以通过初始化、设置属性、调用方法来测试。

Test.java

package imitation.test;import java.util.ArrayList;import java.util.Iterator;import java.util.List;import imitation.action.Action;import imitation.action.MyAction;import imitation.interceptor.Interceptor;import imitation.interceptor.MyInterceptor_1;import imitation.interceptor.MyInterceptor_2;import imitation.invocation.DefaultActionInvocation;/** * @project_name struts2 * @file_name Test.java * @author tianhandigeng * @version Nov 19, 2010 11:00:49 AM * @declaration */public class Test {/** * @param args * @throws Exception */public static void main(String[] args) throws Exception {// TODO Auto-generated method stub MyAction action=new MyAction(); //设置拦截器 List<Interceptor> list=new ArrayList<Interceptor>(); list.add(new MyInterceptor_1()); list.add(new MyInterceptor_2()); Iterator iterator=list.iterator(); DefaultActionInvocation actionInvocation=new DefaultActionInvocation(); actionInvocation.setAction(action); actionInvocation.setInterceptors(iterator); System.out.println(actionInvocation.invoke());}}

 测试结果

imitation.interceptor.MyInterceptor_1 execute...Fri Nov 19 14:16:39 CST 2010imitation.interceptor.MyInterceptor_2 execute...Fri Nov 19 14:16:39 CST 2010execute a action...imitation.interceptor.MyInterceptor_2 execute...Fri Nov 19 14:16:39 CST 2010imitation.interceptor.MyInterceptor_1 execute...Fri Nov 19 14:16:39 CST 2010success

 

5、总结

    这里我们没有模拟Struts 2 中很重要的一个东西ActionProxy，有机会的话以后模拟，好了我们再从代码的角度来讲一下Struts 2的处理流程：

   actionProxy.execute()--->invocation.invoke()---->interceptor.interceptor()--->action.execute()--->返回

在这里解释一下，当请求一个Action后，不是直接调用Action的execute方法，而是调用其代理ActionProxy的方法，ActionPrxoy中有ActionInvocation的引用，ActioinProxy代理的execute()方法被调用，execute方法中又调用ActionInvocation(由DefaultActionInvocation处理)的invoke()方法，invokef方法中有Interceptor的interceptor()方法，在这个时候通过

  resultCode = interceptor.getInterceptor().intercept(this);

循环执行interceptor，最后当没有Interceptor后，调用Action的execute方法，之后原路返回。

    这就是整个过程了，其中有不足，希望留言改正。