让webwork2零配置，第一章(主贴再次更新)

/**
*作者：张荣华(ahuaxuan)
*2007-06-18
*转载请注明出处及作者
*/

让webwork2零配置，第一章

一直以来我都有一个想法，想要找一个比较好的web框架，不用jsp，不用繁琐的配置，比如说struts1.x的action的配置，webwork2的action的配置，其他框架我没有用过，但是类似的，都有很多这样的配置，一个很大的项目，struts的配置文件都是上w，上十几w行，当然我早已放弃struts，投向webwork2.2的怀抱，虽然没有了form的配置，action的配置也比struts的简化了很多。但是我还是不满足，我想要的框架应该比这个还要简单，而action的配置应该抛弃，xwork.xml中应该只存放一些common的配置，比如说interceptor，自定义的result等等。也许你要说你也可以扩展struts1.x啊，而且他的用户更多，但是struts给我感觉是他马上就要退出历史的舞台了，这都是由于他本身的缺点导致的，比如说ActionForm，他把我们绑定到jsp上，如果用模板，那么我们就要自己组装pojo了，这一点，有了拦截器的webwork2做得很好，这也是我选他的原因，同样，我也没有选择struts2.0，因为我讨厌它的庞大和笨重，呵呵。

那么你也许要问，我action中返回页面如何指定呢，我怎么知道我要返回到那个页面呢，我的想法是coc，使用固定的规则能够使我们省去不少繁琐的配置，虽然说配置能够给我们带来巨大的灵活性，但是配置也给我们带来了巨大的不可维护性（这里是指维护起来很繁琐）。

以下是我想象中的做法（我强烈建议在view层使用模板技术，velocity或者freemarker）：
1， 每个action的页面都单独放置，路径和Action的package类似，只是在Action的那一级目录创建一个和Action同名的目录用来放这个Action中方法所返回的页面。比如说有一个UserAction，package：org.easywebwork.action.UserAction，那么就在这个package下创建一个UserAction目录，这个目录下存放所有的UserAction返回的页面。
2， Action的方法返回的字符串在annotation中指定，比如：@result name=”success” template=”editUser.htm” type=”redirect”，editUser.html就是UserAction目录下的一个页面模板

说到底还是得用规则和注释来实现这个功能，这样做的一个优点是方法的返回页面一眼就能看出来，根本不用去xml中找了，尤其在Action类很多的情况下，这样做优点更是明确了。

那最终的效果我想应该是这样的，http://localhost:8080/test/userAction!editUser，就能触发上面这个方法，之后根据editUser的注释就能返回对应的模板页面了。

思路定下来了，那么就是实现了，要实现这个方案的第一步就是自定义annotation，关于annotation，已经属于java基初知识了，java engineer迟早都需要学习的，任何一本关于jdk5.0的书上都有详细的解释，而且论坛上也能搜出一堆，固不作重复的解释，让我们来直接定义我们需要的annotation吧。
既然我们定义的是result，那么我们的annotation元素的个数和类型就应该和xwork.xml中的result的元素的个数和类型是一样的：

/**
 * @author 张荣华(aaron)
 * @since 2007-6-17
 * @version $Id$
 */
//这个annotation是用在方法级别的
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME) 
public @interface Result {
	//action方法的返回名称
	String name();
	
	//result类型，如果没有就是默认值, 如果使用模板那么就是velocity或者freemarker
	String result() default "velocity";
	//默认值使用velocity，正如前面所说，我强烈推荐在view层使用模板引擎
	
	//模板的名字
	String template();
	
	//是哪些返回类型，比如说redirect, chain等等
	String type() default "dispatcher";
}

那么接下来就是定义一个ResultList的annotation了，因为action中的每一个方法都可以有多个返回的result：

/**
 * @author 张荣华(aaron)
 * @since 2007-6-17
 * @version $Id$
 */

//这个annotation是用在方法级别的
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME) 
public @interface ResultList {
	
	//这里存放的是每个方法可能拥有的多个result
	Result [] results();
}

接下来查看一下这个annotation的定义是否是正确的，让我们来创建一个Action和对应的ActionTest：

/**
 * @author 张荣华(aaron)
 * @since 2007-6-17
 * @version $Id$
 */
public class UserAction {
	
	/*
	 * 注意: 这里有一个复合annotation，当然，如果你理解了annotation的用法，及如何自定义annotation，
	 * 那么复合annotation对你来说也是小菜一碟了
	 */
	@ResultList(results = {
			@Result(name="SUCCESS", template="editUser.htm"),
		    @Result(name="ERROR", template="error.htm")})
         //这个uploadInterceptor是在xwork.xml文件中声明的,我还是坚持把common的东西放到xml中去	    
          @Interceptor(interceptors = {"uploadInterceptor"})
	public String editUser(){
		System.out.println("edit user info");
		return "SUCCESS";
	}
	
	@ResultList(results = {
			@Result(name="SUCCESS", template="success.htm"),
			@Result(name="CANCEL", template="editUser.htm")})
	public String saveUser(){
		System.out.println("save user info");
		return "SUCCESS";
	}
	}

这个类就代表一个webwork2的action，再让我们来写一个测试类：

public class UserActionTest {
	public static void main(String args[]) throws ClassNotFoundException {
		UserAction action = new UserAction();
		Method[] methods = action.getClass().getDeclaredMethods();
		
		Set<Method> set = new HashSet<Method>();
		for (int i = 0; i < methods.length; i++) {
			if (methods[i].isAnnotationPresent(ResultList.class)) {
				set.add(methods[i]);
			}
		}

		for (Method m : set) {
			ResultList list = m.getAnnotation(ResultList.class);
			for (Result s : list.results()) {
				System.out.println(s.name() +" "+ s.template() +" "+ s.result() +" "+ s.type());
			}
		}
	}
}

Run一下这个test类的main方法，我们可以看到输出的内容为

SUCCESS editUser.htm velocity dispatcher
ERROR error.htm velocity dispatcher
SUCCESS success.htm velocity dispatcher
CANCEL editUser.htm velocity dispatcher

这说明我们定义的复合annotation是正确的，那么我们完成了扩展webwork2的第一步，接下来就要涉及到webwork2的源代码了，第一篇文章这么长够了，大家讨论一下，这个思路有哪些地方还需要改进吧。

我们已经迈出了扩展webwork2的第一步，接下来就是在webwork2中读取这些Result，并且放到原来放这些result的地方，思路很明确了，我会在这个系列的下面的文章中再作论述。

我用的JDK是6.0， 5.0应该也是没有问题的。

更改：在讨论之后，我发现我把<interceptor-ref这个节点给忘记了，现特加上，谢谢downpour，还有其他人的建议：

/**
 * @author 张荣华(aaron)
 * @since 2007-6-19
 * @version $Id$
 */

//这个annotation是用在方法级别的
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME) 
public @interface Interceptor {
	
	//在这里设置的interceptor就是相当于<interceptor-ref/>元素
	String[] interceptors();
}

看到大家的回帖，昨天晚上我回去又想了很多，觉得如果要实现downpour所提出的那个用法也是可以的，但是还要定义一个action：

/**
 * @author 张荣华(aaron)
 * @since 2007-6-19
 * @version $Id$
 */

//这个annotation是用在方法级别的
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME) 
public @interface Action {

	/*
	 * 这样一来，配置就想xwork.xml中的配置了，如果要实现downpour所说的用法，
	 * 就可以用这个annotation实现了。
	 */
	ResultList resultList();
	
	Interceptor interceptors();
}

这样就可以在action的方法上加多个Action注释了，实现它的定义是简单的，但是接下到来扩展webwork2的源码的时候会给我们带来更多的工作量及负担。不知道大家还有没有什么好办法

按照我昨天的想法:一个方法只定义一组result，这样实现起来也简单，使用起来也简单

修改：这个想法已经实现，大家请看第二章：
http://www.iteye.com/topic/93814
文中的例子可以下载运行, 并且附带扩展的原代码

作者：张荣华，未经作者同意不得随意转载！

评论

17 楼 memphis 2007-06-20  

to ahuaxuan:
呵呵，你不记得我说了有个前提，我这个是做网站用的框架，不是做企业应用的。所以在修改上不存在你说的问题，而且我也有支持集中配置，可以在web.xml里指定配置文件，大致格式就是

hello.html
----try:action.Try01:list
view.html
----hello:action.Try01:view

还有拦截器的配置基本上也不用的，我定义了一些接口，如果有实现这些接口的我就调用指定的方法，都是非常简单的。
学习曲线也不存在，hello.html里用到的就是velocity或freemaker等模板语法，Try01.java也就是普通的java类。
result.type根本就不用配置，因为我只支持html、js,哈哈，网站常用的就是如此吧。

16 楼 ahuaxuan 2007-06-20  

to memphis:
   恕我直言，看到你的例子之后的第一个感觉就是简化xwork的配置对吗，原来xwork的配置明显要比你的配置有更多的字符，但是我想说的是你这种做带来了配置不明确这个缺点，如果你的东西要给别人用，别人会有什么样的感觉，你想过没有，别人不能一眼就看出try01:action.Try01:hello这个含义啊。否则我也可以考虑把try01:action.Try01:hello这段放到annotation里面去啊，而且我把配置放在annotation里有一个好处你肯定做不到，就是返回的result我能一眼就看清楚，如果象你这么做，你的result是如何指定的呢，按照你的hello例子，我并不能想象出来你是怎么做的。同时扩展webwork2一定要考虑到学习曲线的问题，我的做法只是把<action></action>节点搬到类中，这样更加直观，只要用过webwork2的同学，肯定能够立刻上手，而你的做法是放到html中，项目一庞大，维护将会比较麻烦，因为配置得到一个个html文件中去找。以上是我的观点

以下是我的问题：
1，你的interceptor（对于action来说）是在什么地方配置的？
2，你的result是在什么地方配置的？
3，如果我有新的result-type那应该在什么地方配置？
4，你的interceptor是在什么地方定义的？

如果用annotation+xml，那么以上问题就不存在了，比如1，2就写在annotation里（因为每个方法都有自己的定义），3,4就定义在xwork.xml中，因为3,4是属于common的配置。

总结一下，我觉得你这样的0配置有一下缺点：
1，学习曲线高（因为你做了自己独立的一套）
2，维护比较麻烦（因为你把配置分散到html中了）
就这两点估计就不容易被大家所接受，希望你在回帖时也能回答我上面提出的4点问题

15 楼 memphis 2007-06-19  

ahuaxuan 写道

能讲清楚点吗，我的理解好像是你把配置搬到html里去了

不是简单的搬移，
举个例子html内容为

<!--try01:action.Try01:hello-->
<html>
<head><title>test</title></head>
<body>
   hello, ${try01.name}
</body>
</html>

Try01.java代码为

public class Try01
{
   private String name;
    public void hello()
    {
        System.out.println("hello");
    }
    ........//name的get set方法
}

在浏览器里请求http://...../hello.html?name=memphis
则显示hello,memphis
后台执行hello方法输出hello
其中<!--try01:action.Try01:hello-->这样的标签可以在html里放入多个，还有一些其他更方便的标签属性。

14 楼 ahuaxuan 2007-06-19  

icefire 写道

wicket的零配置做得不错的说！
LZ想做的话，不如直接加入对REST风格URL的支持。。。

能否讲讲rest风格是什么样的，因为rest我没有看过

memphis 写道

我已经成功的实现了一个零配置的MVC框架，主要是方便我做网站用的，基本上是一个非常简化的WEBWROK2（有些方面也做了强化，比如一个view可以包含多个action)，Webwork的Action复用也包含在其中。与WW2最大的区别就是WW2是以XML为控制中心，而我的是以HTML为控制中心，也就是说我可以在我的HTML里用注释指定内含那个ACTION类（取了一般unix下的script执行思路，但script执行只是在第一行指定，而我的则不限制）。
现在用JAVA做网站是很不方便的，用jsp+javabean则太简陋，用流行的框架则太繁琐也太笨重，所以催生了我的MVC框架，呵呵，其实也不是简单的MVC，也包含了JDBC的包装以及其他的一些网站常用功能。

能讲清楚点吗，我的理解好像是你把配置搬到html里去了

13 楼 memphis 2007-06-19  

我已经成功的实现了一个零配置的MVC框架，主要是方便我做网站用的，基本上是一个非常简化的WEBWROK2（有些方面也做了强化，比如一个view可以包含多个action)，Webwork的Action复用也包含在其中。与WW2最大的区别就是WW2是以XML为控制中心，而我的是以HTML为控制中心，也就是说我可以在我的HTML里用注释指定内含那个ACTION类（取了一般unix下的script执行思路，但script执行只是在第一行指定，而我的则不限制）。
现在用JAVA做网站是很不方便的，用jsp+javabean则太简陋，用流行的框架则太繁琐也太笨重，所以催生了我的MVC框架，呵呵，其实也不是简单的MVC，也包含了JDBC的包装以及其他的一些网站常用功能。

12 楼 icefire 2007-06-18  

wicket的零配置做得不错的说！
LZ想做的话，不如直接加入对REST风格URL的支持。。。

11 楼 jianfeng008cn 2007-06-18  

downpour 写道

这个0配置做得似乎还不够彻底，最好是一个URL，马上就能根据URL的特征判断调用哪个Action，并同时知道Forward到哪里去。（我似乎太贪心了一点）

不过你现在的方案存在一个问题，不知道你是如何考虑的。因为Webwork的Action其实是可以复用的，也就是说，可能出现：

<action name="aa" class="XXX">
    <result name="success">/xxx.vm</result>
</action>


<action name="bb" class="XXX">
    <result name="success">/xxx2.vm</result>
</action>

在这种情况下，你如何写你的annotation来实现？

public string methoda(){
return success;
}

public string methodb(){
return methoda();
}

10 楼 ahuaxuan 2007-06-18  

yananay 写道

想法很好，不过我还是建议你去先看看 structs 2.0 的实现，站在巨人的肩膀上不是更好吗？
别等你费尽研究出来了 286, 抬眼一看，世界上早就用 686 了。

你说得对，所以我把贴子发出来了，就是要吸引大家一起来探讨这个问题，共同提高，呵呵

9 楼 ahuaxuan 2007-06-18  

downpour 写道

我也曾经想过这个问题，甚至为此跟踪了Struts2的源码，如果真的要做，工作量还是不小，尤其是要把默认的XML配置的实现切换成自己的实现，牵涉到一系列问题。后来也没有时间，就放弃了。

我的感觉就是struts2.0过于复杂，这也是我不想用它的原因，工作量肯定是有的，如果有志同道合者一起做，会快很多

downpour 写道

实际上真的要做到0配置是很困难的，因为类似Webwork或者Struts2，他们本身提供了极大的配置灵活性，我们还经常自己定义Interceptor和Result来实现我们自己的应用需要。0配置实际上意味着必须有另外一种方式，可以把这些特殊的Interceptor Stack或者不同的Result绑定到不同的Action上（当然，多数情况可能只需要Default配置就行了）。

其实我觉得0配置未必就是好的，我的文章的题目也确实有点歳头，其实我想要的方式是只有action的配置做成非xml文件的，其他common的东西完全可以写在xml里，而且这样更一目了然了。

让你一说，我发现我把interceptor给忘了，呵呵

8 楼 downpour 2007-06-18  

yananay 写道

ahuaxuan 写道

Artkai 写道

这个...貌似struts2已经有类似的实现了？？

struts2.0不是说零配置吗，肯定是实现了，但是是如何实现的我就没看过了，从我能找到的struts2.0的例子来看，好像都没有用零配置，而且我觉得struts2.0确实太笨重，我想找一个轻巧的，零配置的mvc框架，没找到，于是就想自己做一个，做成开源的，作为webwork2的一个tool出现，不知道大家是否有兴趣呢

想法很好，不过我还是建议你去先看看 structs 2.0 的实现，站在巨人的肩膀上不是更好吗？
别等你费尽研究出来了 286, 抬眼一看，世界上早就用 686 了。

Struts2的所谓的0配置可并没有抛弃配置文件，而是走了通配符配置的路线，我想这个不叫0配置，只是一定程度上的简化配置，不过实际上，一旦应用稍微大一点，就会发现这种通配符配置方案实在是一个噩梦啊。

7 楼 downpour 2007-06-18  

ahuaxuan 写道

Artkai 写道

这个...貌似struts2已经有类似的实现了？？

struts2.0不是说零配置吗，肯定是实现了，但是是如何实现的我就没看过了，从我能找到的struts2.0的例子来看，好像都没有用零配置，而且我觉得struts2.0确实太笨重，我想找一个轻巧的，零配置的mvc框架，没找到，于是就想自己做一个，做成开源的，作为webwork2的一个tool出现，不知道大家是否有兴趣呢

我也曾经想过这个问题，甚至为此跟踪了Struts2的源码，如果真的要做，工作量还是不小，尤其是要把默认的XML配置的实现切换成自己的实现，牵涉到一系列问题。后来也没有时间，就放弃了。

实际上真的要做到0配置是很困难的，因为类似Webwork或者Struts2，他们本身提供了极大的配置灵活性，我们还经常自己定义Interceptor和Result来实现我们自己的应用需要。0配置实际上意味着必须有另外一种方式，可以把这些特殊的Interceptor Stack或者不同的Result绑定到不同的Action上（当然，多数情况可能只需要Default配置就行了）。

0配置的最佳情况应该是RequestURI，Action和Result形成一个有规律的Mapping方式，从而可以绕过配置文件通过命名约定的方式直接映射。但是目前的Web框架的很大一个特点就在于可以复用Action。此时，很难就这3点形成一定的规律，或许有很多人有好的方案，不妨提出来一起讨论讨论。

6 楼 yananay 2007-06-18  

ahuaxuan 写道

Artkai 写道

这个...貌似struts2已经有类似的实现了？？

struts2.0不是说零配置吗，肯定是实现了，但是是如何实现的我就没看过了，从我能找到的struts2.0的例子来看，好像都没有用零配置，而且我觉得struts2.0确实太笨重，我想找一个轻巧的，零配置的mvc框架，没找到，于是就想自己做一个，做成开源的，作为webwork2的一个tool出现，不知道大家是否有兴趣呢

想法很好，不过我还是建议你去先看看 structs 2.0 的实现，站在巨人的肩膀上不是更好吗？
别等你费尽研究出来了 286, 抬眼一看，世界上早就用 686 了。

5 楼 ahuaxuan 2007-06-18  

Artkai 写道

这个...貌似struts2已经有类似的实现了？？

struts2.0不是说零配置吗，肯定是实现了，但是是如何实现的我就没看过了，从我能找到的struts2.0的例子来看，好像都没有用零配置，而且我觉得struts2.0确实太笨重，我想找一个轻巧的，零配置的mvc框架，没找到，于是就想自己做一个，做成开源的，作为webwork2的一个tool出现，不知道大家是否有兴趣呢

4 楼 Artkai 2007-06-18  

这个...貌似struts2已经有类似的实现了？？

3 楼 ahuaxuan 2007-06-18  

yananay 写道

思路很象 workshop

我没看过workshop，只是闭门造车而已

downpour 写道

这个0配置做得似乎还不够彻底，最好是一个URL，马上就能根据URL的特征判断调用哪个Action，并同时知道Forward到哪里去。（我似乎太贪心了一点）

不过你现在的方案存在一个问题，不知道你是如何考虑的。因为Webwork的Action其实是可以复用的，也就是说，可能出现：

<action name="aa" class="XXX">
<result name="success">/xxx.vm</result>
</action>

<action name="bb" class="XXX">
<result name="success">/xxx2.vm</result>
</action>

在这种情况下，你如何写你的annotation来实现？

你说得对，因为我之前的想法是不这样用的，最好是xXX!method这样就行了，主要是觉得这样使用不是很合理。但你的回帖确实让我有了新的思考，你有什么建议吗
xml的灵活性是很大的，annotation在灵活性方面稍逊一筹吧，但灵活性大也意味着会更容易使程序员去乱用这种灵活性

2 楼 downpour 2007-06-18  

这个0配置做得似乎还不够彻底，最好是一个URL，马上就能根据URL的特征判断调用哪个Action，并同时知道Forward到哪里去。（我似乎太贪心了一点）

不过你现在的方案存在一个问题，不知道你是如何考虑的。因为Webwork的Action其实是可以复用的，也就是说，可能出现：

<action name="aa" class="XXX">
    <result name="success">/xxx.vm</result>
</action>


<action name="bb" class="XXX">
    <result name="success">/xxx2.vm</result>
</action>

在这种情况下，你如何写你的annotation来实现？

1 楼 yananay 2007-06-18  

思路很象 workshop