让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
文中的例子可以下载运行, 并且附带扩展的原代码

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

评论

37 楼 leeon 2007-10-01  

yyjn12 写道

这么用annotation,简直是种误用,用的不伦不类.

我关注的方向也许是偏了,我总是想如何能让开发更简便些.

如果你关注的方向没偏,请你告诉我.为什么要用annotation代替xml?xml配置是个好东西.凡事要适度.xml过于冗长的解决办法是,设法简化它,使之变短,避免它的缺点,沿用它的优点.而不是一次做菜过咸,就以后再也不用食盐.

你这么用annotation,带来了什么好处?是没有xml冗长的坏处了,可是xml的好处不也就没了吗?当初struts1设计用xml,难道本质上就是个错误?你写在源文件中的annotation,算是程序代码,还是算配置信息?如果算程序代码的话,那就是硬编码,真是不用配置啊.如果annotation不算代码,算配置信息,那还叫什么0配置?

修改annotation就需要修改源文件,重新编译生成.class文件.如果你说annotation写成了就不需要改.那你还不如用最原始的硬编码,搞成annotation,只是不伦不类.

sun在java5中引入了annotation,初衷是这么用的吗?

什么呀，struts的xml能叫配置文件吗，明明就是代码文件。
配置文件应该用在最基础的比如数据库连接，以及和j2ee容器相关的一些信息的配置，
因为谁都不想将程序从开发环境换到测试环境，或者正式发布的时候还要从新编译打包

struts的xml文件只可能开发人员真正开发的时候做修改，现在ide都这么好
编译java和修改xml都很方便

36 楼 ahuaxuan 2007-09-27  

yyjn12 写道

这么用annotation,简直是种误用,用的不伦不类.


你这么用annotation,带来了什么好处?是没有xml冗长的坏处了,可是xml的好处不也就没了吗?当初struts1设计用xml,难道本质上就是个错误?你写在源文件中的annotation,算是程序代码,还是算配置信息?如果算程序代码的话,那就是硬编码,真是不用配置啊.如果annotation不算代码,算配置信息,那还叫什么0配置?

修改annotation就需要修改源文件,重新编译生成.class文件.如果你说annotation写成了就不需要改.那你还不如用最原始的硬编码,搞成annotation,只是不伦不类.

sun在java5中引入了annotation,初衷是这么用的吗?

1，你说这样做叫不伦不类，按照你的观点，spring的annotation也是不伦不类，hibernate-annotation也是不伦不类，struts2.0也是不伦不类，那请问怎么用叫伦怎么用叫类

你能否举个伦和类的例子出来呢。

2，struts1.x出来的时候annotation还没有出来好不好，有什么“本质的错误”可言。


3， 关于使用annotation的好处在主贴以及大家的回帖中都体现出来了，请仔细阅览。

4，修改annotation需要重新编译的问题在本文的第二篇也有讨论，开发时可以使用annotation，再通过工具把annotation来转成xml部署，这不是什么大问题。

5，annotation即使是硬编码在代码中的配置，那也是为了便于开发人员理解的一种方式，确实还是有配置，即使是struts2.0.8也是如此，但确实大家都称之为0配置，这是一种约定俗成的称呼，到底是谁第一这么叫它的，我不知道，但是你为什么还是在这个“零”配置上咬文嚼字呢。

6，我好像没有完全否定xml吧，而且你应该没有看过本文第二篇，看过你就知道，我实现的方式是xml+annotation，既能利用xml的优点，也能利用annotation的优点，在讲述自己的理由之前先弄清楚别人的观点好不好。

35 楼 williamy 2007-09-27  

啊，看到这个东西我就。。。我头晕，但是很开心，因为我发现有点傻的人不只我一个，哈哈
你搞webwork，我搞struts1.2.4，呵呵，都是相同的造轮子工程阿
不过很明显，偶得工程比你的大嘛，我还自己写了ioc和aop和ajax框架呢，嘿嘿，有空商量一下我们的轮子也整合了，绝对赛过struts2

34 楼 timerri 2007-09-27  

在我前一代的框架里，我的action的名字就是模板的名字，调用模板就是调用action.

在我现在正在设计的框架里，action的名字是写在模板里的，调用模板就会自己去找action

把配置写在程序里，开发速度是快了，重用性几乎就没有了。

为了重用，我放弃了annotation.

33 楼 yyjn12 2007-09-27  

这么用annotation,简直是种误用,用的不伦不类.

我关注的方向也许是偏了,我总是想如何能让开发更简便些.

如果你关注的方向没偏,请你告诉我.为什么要用annotation代替xml?xml配置是个好东西.凡事要适度.xml过于冗长的解决办法是,设法简化它,使之变短,避免它的缺点,沿用它的优点.而不是一次做菜过咸,就以后再也不用食盐.

你这么用annotation,带来了什么好处?是没有xml冗长的坏处了,可是xml的好处不也就没了吗?当初struts1设计用xml,难道本质上就是个错误?你写在源文件中的annotation,算是程序代码,还是算配置信息?如果算程序代码的话,那就是硬编码,真是不用配置啊.如果annotation不算代码,算配置信息,那还叫什么0配置?

修改annotation就需要修改源文件,重新编译生成.class文件.如果你说annotation写成了就不需要改.那你还不如用最原始的硬编码,搞成annotation,只是不伦不类.

sun在java5中引入了annotation,初衷是这么用的吗?

32 楼 ahuaxuan 2007-09-27  

yyjn12 写道

0配置?
如果一个项目做出来是0配置的,那么意思就是不可配置.就是说,什么都是写死的,完全没有灵活性.

楼主的意思似乎不是要把项目的灵活性砍掉吧?
那么能否改个名称,不要使用 "0配置" 这么煽情的字眼?

这个“零配置”的叫法不是我想出来得，struts2.0称这种方式为零配置，你要是觉得真有什么问题的话可以发个email给apache的人，建议它们不要用“零配置”这个词。

作为技术人员，如果一味的在某个单词上抓着不放势必会失去更多的东西，有必要咬住这个不放吗，关键不是个把单词的问题，主要是要领会它的原理和思想，你如果天天想着“零配置”这个单词有问题，你不觉得作为技术人员，你关注的方向偏了吗

31 楼 yyjn12 2007-09-27  

0配置?
如果一个项目做出来是0配置的,那么意思就是不可配置.就是说,什么都是写死的,完全没有灵活性.

楼主的意思似乎不是要把项目的灵活性砍掉吧?
那么能否改个名称,不要使用 "0配置" 这么煽情的字眼?

30 楼 zhao 2007-08-03  

支持下先,刚开始学习webwork

29 楼 ahuaxuan 2007-07-23  

Sam1860 写道

看来Java的WEB框架只有Spring MVC是比较好用的，SpringMVC要COC有COC，要灵活有灵活。而且简单易用，自从第一次用它后就不想再用别的MVC框架了。
Webwork,struts2都要不少配置啊，楼主要搞个“零”配置还要自己搞这么多东西，不是一般的麻烦。

你指的麻烦是什么，使用起来麻烦还是指扩展webwork2麻烦，事实上扩展webwork2（就是第二章的实现）我只用了周末不到3个小时而已，加上之前的这篇文章的讨论，大概也就是5个小时，不是很麻烦，关键是要有自己的想法，能突破吗，能创新吗，我不得不承认在这个扩展的过程中，我学习到了很多知识，对我的帮助很大。

ps:我实在没有看出你说的麻烦是指什么麻烦

28 楼 Sam1860 2007-07-21  

看来Java的WEB框架只有Spring MVC是比较好用的，SpringMVC要COC有COC，要灵活有灵活。而且简单易用，自从第一次用它后就不想再用别的MVC框架了。
Webwork,struts2都要不少配置啊，楼主要搞个“零”配置还要自己搞这么多东西，不是一般的麻烦。

27 楼 Norther 2007-07-20  

支持 这才是大方向

26 楼 guocy 2007-07-20  

从礼貌上支持一下楼主，因为是新手，就不在关公面前耍大刀了，希望LZ多听听大家的意见，永远支持你！

25 楼 hunter8v 2007-07-18  

skyact 写道

struts2是webwork2迁移过来的，我觉得挺好用的，特别是interceptor

public static void main(String[] args) {
        EventManager mgr = new EventManager();

        if (args[0].equals("store")) {
            mgr.createAndStoreEvent("My Event", new Date());
        }
        else if (args[0].equals("list")) {
            List events = mgr.listEvents();
            for (int i = 0; i < events.size(); i++) {
                Event theEvent = (Event) events.get(i);
                System.out.println("Event: " + theEvent.getTitle() +
                                   " Time: " + theEvent.getDate());
            }
        }
        else if (args[0].equals("addpersontoevent")) {
            Long eventId = mgr.createAndStoreEvent("My Event", new Date());
            Long personId = mgr.createAndStorePerson("Foo", "Bar");
            mgr.addPersonToEvent(personId, eventId);
            System.out.println("Added person " + personId + " to event " + eventId);
        }
        else if (args[0].equals("addemailtoperson")) {
            Long personId = mgr.createAndStorePerson("Foozy", "Beary");
            mgr.addEmailToPerson(personId, "foo@bar");
            mgr.addEmailToPerson(personId, "bar@foo");
            System.out.println("Added two email addresses (value typed objects) to person entity : " + personId);
        }

        HibernateUtil.getSessionFactory().close();
    }

24 楼 skyact 2007-07-17  

struts2是webwork2迁移过来的，我觉得挺好用的，特别是interceptor

23 楼 lprince 2007-07-16  

如果不想配置，直接JSP+JAVABEAN就最完美了！
配置是必须的，以为这个世界就是复杂的，所以技术发展到最后毕竟也是复杂的。

22 楼 ahuaxuan 2007-07-06  

引用

Struts 1.x通过Strecks(http://strecks.sf.net)实现使用annotation进行配置。
Struts 2 ， webwork 也不会比 struts 1 配置少什么，

strecks能减少配置量吗。
但是如果说不能减少配置量而是把配置挪个地方，那么struts1的配置是绝对要比webwork2多的。


最近做了一个添删改查的demo，为未来的产品升级做准备，所有的crud代码都放在基类中，有BaseService，BaseDao，BaseAction，通过范型实现这个功能，基本的crud都不需要写任何java代码了，添加任何一个实体，实现对应crud只要几个对应的页面和对应的配置文件就可以了。

但是这里还是出现了xwork的配置，每个实体都需要一个对应的crud的配置文件，而且根本没有办法用annotation来实现。除非是基于规则。 这让我认识到未来的mvc框架，应该是基于annotation和coc的
而且我确实想把crud做成基于规则的，大家有什么好的想法没有
。

21 楼 hantsy 2007-07-03  

Struts 1.x通过Strecks(http://strecks.sf.net)实现使用annotation进行配置。
Struts 2 ， webwork 也不会比 struts 1 配置少什么，

20 楼 ueseu 2007-07-03  

能不能不用JAVA5及以上的搞个

19 楼 annegu 2007-06-28  

aninfeel 写道

有个叫xdoclet的，好像可以让各种知名的框架不用写xml。

jdk的annotation是语言级别的，并且是类型安全的，在编译期进行检查，它比xdoclet强大的多，而且有更好的工具和ide的支持，xdoclet的注解怎么能和jdk的注解比呢。

18 楼 aninfeel 2007-06-21  

有个叫xdoclet的，好像可以让各种知名的框架不用写xml。