自己动手写一个Struts2

使用Struts2或webwork2有一段时间了，想把Struts2框架的思路简单的与大家分享一下，之前我是看过Struts2源代码的，所以本文算是它的一个功能非常有限的压缩版本。我也不打算重复发明轮子，只想让Struts2或Webwork2的新手更多的了解框架本身，而不仅仅是应用。废话少说，开始吧。

 

 

本文采用基本Xml来配置Action，如果有时间会继续写Annotation的实现。Xml文件结构与Struts2的配置文件struts.xml几乎一样，这样大家都比较熟悉，不过我简写了某些地方：

 

Struts.xml

Xml代码  

1. <?xml version="1.0" encoding="UTF-8" ?>  
2. <!-- 为简化框架,package的属性都没有实现;而且所有的元素都是简化版的 -->  
3. <struts>  
4.     <package>  
5.         <action name="hello" method="hello"  
6.             class="com.leo.action.HelloAction">  
7.             <result name="success">/index.jsp</result>  
8.         </action>  
9.     </package>  
10. </struts>  

 

 

是不是很熟悉啊，不过为了简单我都给简化了，否则这是一个没有尽头的工作。核心部分仍然是Filter，Struts2所有工作都是通过一个Filter来完成的(struts1.*是通过一个Action实现的)。我们先来看代码：

 

Java代码  

1. public class StrutsFilter implements Filter {  
2.     public void doFilter(ServletRequest req, ServletResponse res,  
3.             FilterChain chain) throws IOException, ServletException {  
4.         // TODO Auto-generated method stub  
5.         HttpServletRequest request = (HttpServletRequest) req;  
6.         HttpServletResponse response = (HttpServletResponse) res;  
7.         ServletContext servletContext = filterConfig.getServletContext();  
8.         // 解析Request的URL和传过来的参数  
9.         String actionName = StringUtil.parseServletPath(request  
10.                 .getServletPath());  
11.   
12.         // 如果后缀不为.action,那么直接放过，不进行拦截  
13.         if (StringUtil.isEmpty(actionName)) {  
14.             chain.doFilter(request, response);  
15.         } else {  
16.             // 解析得到ActionClass,里面包括Action的类全名,返回页面值,Action执行的方法  
17.             ActionClass clas = this.getActionClass(actionName);  
18.             // 得到页面的所有parameters参数(没考虑上传情况)  
19.             Map<String, String[]> params = request.getParameterMap();  
20.             // 为要调用的Action的set**方法设值,并返回要调用的Action对象本身  
21.             setBeforeActionValue(clas, params);  
22.             // 调用的Action执行方法,并返回值设置在request域中  
23.             setResultValue(clas, request);  
24.             // 返回相应的JSP页面  
25.             servletContext.getRequestDispatcher(clas.getResult()).forward(  
26.                     request, response);  
27.         }  
28.     }  
29. }  

 

 没错一些因果都因doFilter方法而起。我的作法是：

 

• 解析URL路径，从而得到相应action在struts.xml配置文件中所配置的方法。如果不为合法的action后缀，直接chain.doFilter(request, response)放行。
• 将URL上的参数通过request.getParameterMap()取出，在调用action执行方法之前，将具有set**属性的字段赋值。这里利用了反射。
• 继续利用反射，执行Action的方法。结束前将具有get**属性的字段存于request域中，供页面使用。大家记得在每次执行Action的方法时都会返回一个String字符串，比如SUCCESS，INPUT，ERROR等，我们可以将这个值与struts.xml的<result name="success" ....>/index.jsp</result>　结点进行匹配，取出返回页面/index.jsp
• 一切准备就绪后，调用servletContext.getRequestDispatcher().forward()方法到相应的页面上去。

这就是大概的流程。因为是一个入门的框架所以很不完善，拦截器，result type的各种类型都没有去实现，因为我压根没想过要重复发明轮子。好，我们开始一步一步的看。

 

 

 

我们先来看这一句：ActionClass clas = this.getActionClass(actionName);
其中ActionClass的结构如下：

 

Java代码  

1. public class ActionClass {  
2.     /** 
3.      * 类名 
4.      */  
5.     private String className;  
6.     /** 
7.      * 要调用的方法名 
8.      */  
9.     private String method;  
10.     /** 
11.      * 返回结果页面 
12.      */  
13.     private String result;  
14.     /** 
15.      * 临时存储Action下的所有result结点 
16.      */  
17.     private List<Element> elements = new ArrayList<Element>();  
18.   
19.     /** 
20.      * 要调用的Action本身 
21.      */  
22.     private Object action;  
23.   
24.     //省略所有的set,get方法  
25. }   

 

ActionClass主要是用来存放解析struts.xml文件一些有用的值，以及反射时所调用的Action本身对象，其实就是一个简单的JavaBean，存储临信息。

 

 

getActionClass(actionName)方法就是将URL上的actionName取出与struts.xml中的<action>结点匹配，可以得到Action的类全名，Action所调用的具体哪个方法名，Action的所有result结点(因为方法还没有执行，还不知道是具体哪一个result结点，所以先存起来，后面来解析)分别存在ActionClass对象中相应的属性中去。具体的解析代码我就不打出来了，否则文章太长。

 

 

再来看看setBeforeActionValue(clas, params)这一句。其实就是将得到的ActionClass对象与提交的参数全部传进去，给Action的那些set属性赋值：

 

Java代码  

1. /** 
2.      * 调用Action,并执行Action的无参方法 
3.      *  
4.      * @param actionClass 
5.      * @param request.getParameterMap() 
6.      * @return 
7.      */  
8.     public Object setActionValues(ActionClass actionClass,  
9.             Map<String, String[]> params) {  
10.         try {  
11.             // 得到Action的Class,并根据无参构造函数生成一个Action对象  
12.             Class clas = Class.forName(actionClass.getClassName());  
13.             Object obj = clas.newInstance();  
14.   
15.             if (params != null && params.size() > 0) {  
16.                 Iterator<String> it = params.keySet().iterator();  
17.                 while (it.hasNext()) {  
18.                     String key = it.next();  
19.                     String[] value = params.get(key);  
20.                     String upperFirstLetter = key.substring(0, 1).toUpperCase();  
21.                     // 获得和属性对应的setXXX()方法的名字  
22.                     String setMethodName = "set" + upperFirstLetter  
23.                             + key.substring(1);  
24.                     Method method = null;  
25.                     // 看看该页面提交的参数名中,是否在Action有set方法  
26.                     try {  
27.                         method = clas.getMethod(setMethodName,  
28.                                 new Class[] { String.class });  
29.                     } catch (NoSuchMethodException e) {  
30.                         System.out.println("警告 " + actionClass.getClassName()  
31.                                 + "." + setMethodName + "("  
32.                                 + String.class.getName() + ") 不存在");  
33.                     }  
34.                     if (method != null) {  
35.                         // 如果有set方法,就调用set方法,进行赋值操作  
36.                         String result = StringUtil.StringArrayToString(value);  
37.                         method.invoke(obj, new String[] { result });  
38.                     }  
39.   
40.                 }  
41.   
42.             }  
43.             return obj;  
44.         ......  
45.     }  

 

 

这样就顺利的将页面的值赋给了Action的相应属性，接下来就是Action调用工作了。通过setActionValues方法，我们已经可以得到Action对象本身了，可以存在ActionClass对象clas中去，我们直接调用setResultValue(clas, request)在Action执行后，同时也把有get方法的属性一并存于request域中：

 

 

Java代码  

1. /** 
2.      * 调用Action,并执行Action的无参方法 
3.      *  
4.      * @param actionClass 
5.      * @param obj 
6.      *            要处理的对象 
7.      * @return 
8.      */  
9.     public Object invokeAction(ActionClass actionClass) {  
10.         try {  
11.             Object obj = actionClass.getAction();  
12.             Class clas = obj.getClass();  
13.             Method method = clas.getMethod(actionClass.getMethod(), null);  
14.             String result = (String) method.invoke(obj, null);  
15.             this.setInvokeResult(result, actionClass);  
16.             actionClass.setAction(obj);  
17.             return obj;  
18.                                                 ......  
19.         }  
20.     }  

 

很简单的代码——调用Action那个无参执行方法，得到返回String类型的返回结果，然后我们可以再次利用ActionClass将最终的返回结果也给解析出来，看this.setInvokeResult(result, actionClass)方法

 

 

Java代码  

1. /** 
2.      * 匹配<result name="success">/index.jsp</result> Xml中的result 
3.      * name属性，如果匹配成功,设置返回结果"/index.jsp" 
4.      *  
5.      * @param result 
6.      * @param actionClass 
7.      */  
8.     private void setInvokeResult(String result, ActionClass actionClass) {  
9.         List<Element> elements = actionClass.getElements();  
10.         for (Element elem : elements) {  
11.             Attribute name = XmlUtil.getAttributeByName(elem, "name");  
12.             if (StringUtil.equals(result, name.getText())) {  
13.                 actionClass.setResult(elem.getText());  
14.                 return;  
15.             }  
16.   
17.         }  
18.         throw new RuntimeException("请确定在xml配置文件中是否有名叫 [" + result  
19.                 + "]　的返回类型结点 ");  
20.     }  

 

 

 

一切大功告成，将刚刚得到的返回结果用servletContext.getRequestDispatcher(clas.getResult()).forward(
request, response)转发出去，编码部分完毕。

 

 

别忘记了在web.xml中配置这个Filter：

 

 

Xml代码  

1. <filter>  
2.     <filter-name>struts</filter-name>  
3.     <filter-class>com.framework.core.StrutsFilter</filter-class>  
4. </filter>  
5. <filter-mapping>  
6.     <filter-name>struts</filter-name>  
7.     <url-pattern>/*</url-pattern>  
8. </filter-mapping>  

 

 

 

 

最后写个测试Action吧，就按照本文最开始的那个struts.xml配置编写HelloAction.java

 

 

Java代码  

1. public class HelloAction {  
2.   
3.     private String message;  
4.   
5.     public String hello() {  
6.         message = "superleo " + this.message;  
7.         return "success";  
8.     }  
9.   
10.     public String getMessage() {  
11.         return message;  
12.     }  
13.   
14.     public void setMessage(String message) {  
15.         this.message = message;  
16.     }  
17.   
18. }