自己动手写一个Struts2

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

 

 

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

 

Struts.xml

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

 

 

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

 

public class StrutsFilter implements Filter {
	public void doFilter(ServletRequest req, ServletResponse res,
			FilterChain chain) throws IOException, ServletException {
		// TODO Auto-generated method stub
		HttpServletRequest request = (HttpServletRequest) req;
		HttpServletResponse response = (HttpServletResponse) res;
		ServletContext servletContext = filterConfig.getServletContext();
		// 解析Request的URL和传过来的参数
		String actionName = StringUtil.parseServletPath(request
				.getServletPath());

		// 如果后缀不为.action,那么直接放过，不进行拦截
		if (StringUtil.isEmpty(actionName)) {
			chain.doFilter(request, response);
		} else {
			// 解析得到ActionClass,里面包括Action的类全名,返回页面值,Action执行的方法
			ActionClass clas = this.getActionClass(actionName);
			// 得到页面的所有parameters参数(没考虑上传情况)
			Map<String, String[]> params = request.getParameterMap();
			// 为要调用的Action的set**方法设值,并返回要调用的Action对象本身
			setBeforeActionValue(clas, params);
			// 调用的Action执行方法,并返回值设置在request域中
			setResultValue(clas, request);
			// 返回相应的JSP页面
			servletContext.getRequestDispatcher(clas.getResult()).forward(
					request, response);
		}
	}
}

 

 没错一些因果都因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的结构如下：

 

public class ActionClass {
	/**
	 * 类名
	 */
	private String className;
	/**
	 * 要调用的方法名
	 */
	private String method;
	/**
	 * 返回结果页面
	 */
	private String result;
	/**
	 * 临时存储Action下的所有result结点
	 */
	private List<Element> elements = new ArrayList<Element>();

	/**
	 * 要调用的Action本身
	 */
	private Object action;

	//省略所有的set,get方法
} 

 

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

 

 

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

 

 

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

 

/**
	 * 调用Action,并执行Action的无参方法
	 * 
	 * @param actionClass
	 * @param request.getParameterMap()
	 * @return
	 */
	public Object setActionValues(ActionClass actionClass,
			Map<String, String[]> params) {
		try {
			// 得到Action的Class,并根据无参构造函数生成一个Action对象
			Class clas = Class.forName(actionClass.getClassName());
			Object obj = clas.newInstance();

			if (params != null && params.size() > 0) {
				Iterator<String> it = params.keySet().iterator();
				while (it.hasNext()) {
					String key = it.next();
					String[] value = params.get(key);
					String upperFirstLetter = key.substring(0, 1).toUpperCase();
					// 获得和属性对应的setXXX()方法的名字
					String setMethodName = "set" + upperFirstLetter
							+ key.substring(1);
					Method method = null;
					// 看看该页面提交的参数名中,是否在Action有set方法
					try {
						method = clas.getMethod(setMethodName,
								new Class[] { String.class });
					} catch (NoSuchMethodException e) {
						System.out.println("警告 " + actionClass.getClassName()
								+ "." + setMethodName + "("
								+ String.class.getName() + ") 不存在");
					}
					if (method != null) {
						// 如果有set方法,就调用set方法,进行赋值操作
						String result = StringUtil.StringArrayToString(value);
						method.invoke(obj, new String[] { result });
					}

				}

			}
			return obj;
		......
	}

 

 

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

 

 

/**
	 * 调用Action,并执行Action的无参方法
	 * 
	 * @param actionClass
	 * @param obj
	 *            要处理的对象
	 * @return
	 */
	public Object invokeAction(ActionClass actionClass) {
		try {
			Object obj = actionClass.getAction();
			Class clas = obj.getClass();
			Method method = clas.getMethod(actionClass.getMethod(), null);
			String result = (String) method.invoke(obj, null);
			this.setInvokeResult(result, actionClass);
			actionClass.setAction(obj);
			return obj;
                                                ......
		}
	}

 

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

 

 

/**
	 * 匹配<result name="success">/index.jsp</result> Xml中的result
	 * name属性，如果匹配成功,设置返回结果"/index.jsp"
	 * 
	 * @param result
	 * @param actionClass
	 */
	private void setInvokeResult(String result, ActionClass actionClass) {
		List<Element> elements = actionClass.getElements();
		for (Element elem : elements) {
			Attribute name = XmlUtil.getAttributeByName(elem, "name");
			if (StringUtil.equals(result, name.getText())) {
				actionClass.setResult(elem.getText());
				return;
			}

		}
		throw new RuntimeException("请确定在xml配置文件中是否有名叫 [" + result
				+ "]　的返回类型结点 ");
	}

 

 

 

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

 

 

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

 

 

<filter>
	<filter-name>struts</filter-name>
	<filter-class>com.framework.core.StrutsFilter</filter-class>
</filter>
<filter-mapping>
	<filter-name>struts</filter-name>
	<url-pattern>/*</url-pattern>
</filter-mapping>

 

 

 

 

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

 

 

public class HelloAction {

	private String message;

	public String hello() {
		message = "superleo " + this.message;
		return "success";
	}

	public String getMessage() {
		return message;
	}

	public void setMessage(String message) {
		this.message = message;
	}

}

 

 

 

 

 

 

如果下载了源代码，可分别输入下列几个链接看看测试效果：(test文件夹下是单元测试)

• http://localhost/framework/
• http://localhost/framework/hello.action
• http://localhost/framework/hello.action?message=superleo

评论

30 楼 jiao_zg22 2013-05-27  

美丽的姐姐，美丽的代码  

29 楼 jakoes 2010-06-12  

支持一下

28 楼 qbq 2009-08-07  

收藏了
有时间仔细研究下

27 楼 garluncn 2009-03-04  

谢谢楼主， 楼主是好人，楼主很有耐心，楼主 …………………… 谢谢 ！！！

26 楼 pj1987111 2009-01-07  

楼主，你好厉害我好崇拜你哦！

25 楼 liaobinxu 2008-12-16  

应为最经不好找工作，感觉只会有用是不行的。
我所在小组 正准备开struts2的源码，准备自己开发一套MVC框架，但是不知道从如何下手，请问你有什么资料[size=xx-small][/size][color=red]和书籍，可以使用。。。[/color]

24 楼 daoyongyu 2008-12-04  

楼主是牛人啦。

23 楼 lysunki 2008-11-22  

好牛啊 

22 楼 cicl 2008-10-31  

领教了，通俗易懂

21 楼 pxpaul 2008-10-30  

强人！学习学习

20 楼 h_yz 2008-09-10  

支持一下，强人哦

19 楼 kyo100900 2008-08-20  

谢谢　phz50　提供的方法，很优雅。

18 楼 phz50 2008-08-20  

首先作者这个写得真不错,不过有几处可能不够妥当:
关于StrutsFilter中setResultValue方法的改进:

private void setResultValue(ActionClass clas, HttpServletRequest request) {
		Object obj = manager.invokeAction(clas);
		Method[] methods = actionClass.getMethods();
			for (Method m : methods) {
				String methodName = m.getName();
				if (methodName.startsWith("get")
						&& Modifier.isPublic(m.getModifiers())) {
					String upperFirstLetter = methodName.substring(3, 4)
							.toLowerCase();
					String fieldName = upperFirstLetter
							+ methodName.substring(4);
					try {
						request.setAttribute(fieldName, m.invoke(obj));
					} catch (IllegalArgumentException e) {
						e.printStackTrace();
					} catch (IllegalAccessException e) {
						e.printStackTrace();
					}
				}
			}
	}

个人认为这样比较人性化

17 楼 kkllmey 2008-08-19  

public static void main(String strs[])
{
   System.out.println("很不错!!");
}

16 楼 guooo 2008-08-18  

不错,收藏下,有空看看

15 楼 Clayz 2008-08-15  

  
Struts2就是webwork的翻版吧，多了点ajax支持。别的还有什么？

14 楼 discus733 2008-08-15  

这个有点象struts 1.x中的ActionForm,用来进行转发的，但是思路比较好

13 楼 xiaObaiRabbit 2008-08-15  

   

12 楼 wj539h 2008-08-15  

兄弟,你很NB!!!谢谢了!

11 楼 Gudice 2008-08-15  

写的不错，struts 1.x用一个servlet来作为前端控制器，现在struts2用filter来拦截了，根本还真是“基础代码+模式的集合”，啥时候国人能整出一个这样的框架来啊，呵呵