基于REST+CoC构建Java Web快速开发框架的架构思路

      在《Web开发敏捷之道》这本书的前面几章里，Dave向我们炫耀怎样简单的开始一个Ruby on Rails之旅，建一张表，执行一句ruby命令行生成一个scaffold脚手架程序，然后写一句代码，就可以完成了对一个表或者说是资源的CRUD操作的功能的实现。这激发了我的兴趣，用Java，能不能更简单的完成这件事。

      我在我们应该怎样看待框架 中，实现了一个JDBC版的Base类，和一个Hibernate版的Base类，取模仿RoR的ActiveRecord，这样我们编程的时候，只需要实现一个Base的子类，就可以完成CRUD了。

      我的毕设题目是与Rest ，更准确说是与ROA有关的，另外就是在看Spring MVC对于惯例优先 （Convention over Configuration，CoC）原则的实现。

      Web架构的四个元素

      无论是Rails还是Spring MVC都是MVC实现，因此我的研究也肯定是基于MVC模式的。那么分别来关注M，V和C，另外就是将url和C进行映射的Router（或者说是Struts里的映射文件）。

      首先是M，我不想自己编M，那就自动生成，怎么才能自动生成呢，根据数据库自动生成，而且我生成要是一个ActiveRecord模式的类。所以不是像过去弄个HashMap就能混过去了。之后就是看了ASM3.1和ClassLoader的知识，发现这是可以实现的。如下：

     先整个测试：

     @Test

	public void gerneratorClass() {
		try {
			Map<String,Object> fields=new HashMap<String,Object>();
			fields.put("id", 1l);
			fields.put("name", "wanxing");
			EntityGernerator.generateEntity("Student",fields );
			EntityGernerator.invoke("add");
		} catch (Exception e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}

    这块的实现我想了一下，EntityGernerator的generateEntity方法到底只是创建一个class还是连同实例化对象，而其还有invoke方法，这看上去不太对，嗯，它应该是只生成class就结束使命了。不过以后再迭代吧。

    实现的代码很简单，就是利用了ASM3.1，就搞定了。有两点需要声明：

    1 可以按需要设定生成类的父类

    2 只能创建类属性，不能创建方法，因为方法的实现太复杂，用JVM指令写会死人，不如转向动态语言了，而且它继承了有用的父类，就已经完成了自己的使命了。

 

    V和C都可以用通用的，就像用通用DAO一样。关于V有个特别之处，那就是FrontController，它来调配各个Controller，依照URI和Controller的Mapping，这符合Roy Fielding博士对于资源的定义：资源是 一种概念上的映射 ——服务器接收到标识符（标识这个映射），将它应用于当前的映射实现（mapping implementation，通常是与特定集合相关的树的深度遍历和/或哈希表的组合）上，以发现当前负责处理该资源的处理器实现 ，然后处理器实现基于请求的内容选择适当的动作+响应 。在RoR里这叫做Router。另外V中可以根据HTTP请求返回适当的Presentation。

 

    REST与CoC

    按照“惯例优先原则”可以做很多事情，比如Blog类对应BlogController，对应/blog。我们可以将该原则落实到以上四个元素上：M，V，C和Router。之后就是按照上述对应关系，形成一种简单的开发框架，我们需要做的事情只是：

    1 创建数据库Schema，比如建立表Blog

    2 配置数据库连接，选择使用何种数据库

    3 启动Tomcat，在浏览器的地址栏中输入http://localhost:8080/blog/new创建Blog（返回写blog的表单），http://localhost:8080/blog/12，显示文章；http://localhost:8080/blog/edit，返回修改表单；http://localhost:8080/blog/list，返回所有blog，加上q?time=2009-05-08或者http://localhost:8080/2009-05-08/blog/list，按时间查询，后者的问题是如果Blog表有两个字段是时间就没办法了，但是我们可以约定它只有一个时间的时候默认结果，这就是“惯例优先”作用。

 

 

     输入这些URL只是证明系统可以正常的工作。然后你可以定制你的HTML页面，把这些链接放到你喜欢的地方，或者作为按钮对应的服务。所有的服务，都是REST的。一个RCP客户端也可以使用，或者是Delphi。

 

     系统在背后默默的根据数据库Schema创建了Blog类，然后其他都是通用的组件，放入Blog类，比如GenericController.setModel(T model)，将Blog类的实例放入。

 

     灵活性与可扩展性  

    如果只是这样，那么这个系统实际上做不了什么太有价值的事情（这只是一个数据库外的薄层），“惯例优先”并不是“惯例决定”，我们必须能让Developer开发自己个性化的组件，以完成更强大的功能。

    那么就要有如下逻辑：

    1 对于M：首先检查classpath里是否有url中寻找的实体（比如blog，我们不能说那是资源，资源是映射），这个实体就是Developer创建的，如果没有，则去数据库中查找名为blog的表，创建Blog类（并不在文件系统中生成这个class）。如果也没有，则返回not found。

    2 对于C：首先根据Router中的默认定义，寻找BlogController，检查是否存在于classpath中，没有则用ControllerGenerator生成BlogController（与EntityGenerator相同，不过既然我的Generator可以指定父类，实际上用一个ClassGenerator就应该OK了）。

    3 对于V：现在默认路径下寻找页面（jsp或者html），如果没有，则创建Blog页面流（Stream）返回给客户端。

    4 对于Router：默认就是/blog对应BlogController。当然你可以建立自己的Router文件，来修改映射关系。

 

    “惯例优先”，那这个惯例是谁的惯例呢？ 其实Router的可Developer定制就表示了系统可以支持在四个Web架构元素中之间建立自己的“惯例”。比如，所有的表名都加上T_Blog，但是生成类名是Blog，而Controller是BlogAction（有人就是喜欢叫它Action），OK，这都没问题。

 

    技术细节

    我们回到M讨论。我这个M既要承担ORM的责任又要承担DVM（Domain View Mapping）的职责。也就是说，我期望我的对象里面可以关联其他对象，同时我也希望我在UI上显示正确的中文名，而不是字段名。

    先说ORM，关联关系（继承就先别指望自动生成了），我可以根据数据库表的主外键关系生成，然后用ASM动态加上注解（还是基于Hibernate）。我现在唯一不确定的是，用ASM生成的属性，类型可以是另外的类吗？答案是可以，跟内置的Java类型是一样一样的。

    然后是我要让生成HTML或者XML能正确显示字段的Label，这个可以提取表的注释，然后利用ASM动态加上注解。

 

 

 

    Just Play

    对于那些基础数据的简单维护，或者你的系统设计本来就不想什么OO范型，那么这个基础框架是有用的，面对真正复杂的大型企业应用，它比较好的一点是不会阻止你实现复杂的对象图。

     写到这，我第一次感到：我干嘛还要用Java呢？因此最后我只能说，Just Play，正如Dave所说，在真正的项目中，代码生成并不像看起来那么有用，但是，起码你有了一个好的脚手架~~~

 

    澄清几个误解

    1 这个架构并不是依靠代码生成Java，然后基于生成的代码再修改。而是在内存中生成字节码！这与Rails之类的是不一样的。

    2 与目前已有的框架相比，另外考虑了可配置的“惯例”

    3 REST风格，客户端不只局限于浏览器，也不局限于Java

评论

18 楼 sslaowan 2009-05-12  

unsid 写道

那篇论文学术性很强,很多语言高度抽象,再加上翻译过程的语义损失,很难完全看懂
但是其在第五章才真正引入"表述性状态转移"这个"专门面向网络应用的架构风格"
这很让人怀疑这个论文的主要目的是引入一种新的架构风格还是强调架构风格及分析评估架构风格的重要性.

当然是后者了，你看题目。不过前面都是对后面的铺垫，我第一次觉得架构设计竟然也能像数学推导一样，觉得这种思路很好

17 楼 unsid 2009-05-12  

那篇论文学术性很强,很多语言高度抽象,再加上翻译过程的语义损失,很难完全看懂
但是其在第五章才真正引入"表述性状态转移"这个"专门面向网络应用的架构风格"
这很让人怀疑这个论文的主要目的是引入一种新的架构风格还是强调架构风格及分析评估架构风格的重要性.

16 楼 sslaowan 2009-05-12  

unsid 写道

sslaowan 写道

unsid 写道

如果把谓语放在URI上怎么适应一个复杂的业务呢？
典型例子就是一个由任意多个选项组合成的复杂条件查询

给你看一个URI：http://www.baidu.com/s?q1=java&q2=&q3=&q4=&rn=10&lm=0&ct=0&ft=&q5=&q6=www.ibm.com&tn=baiduadv

这是百度的高级搜索
q1表示包含以下全部的关键词
q2表示包含以下的完整关键词
q3表示包含以下任意一个关键词
q4表示不包括以下关键词
rn表示选择搜索结果显示的条数
lm表示限定要搜索的网页的时间
ct表示搜索网页语言
ft表示搜索网页格式
q5表示查询关键词位于
q6表示限定要搜索指定的网站
最后的tn表示百度高级搜索

将来你要表达一个复杂一点的逻辑，需要一个很恐怖的uri才可以
另外我认为，REST与其说是一种新技术，倒不如说是一种呼吁
我觉得他是认为人们在开发系统中没有充分利用http原始语义或者URI本身的定位作用
而靠应用期去造轮子，其中某rest的忠实拥蹙认为“你如果用get提交一个删除服务器文件的请求是不可原谅的”
他们认为服务器行为完全可以定义在url中，而在服务器上少维护一个解析行为的过程

你再好好阅读一下Fielding博士的论文吧，关于REST API和RPC的区别，以及怎样通过操作和转移表述来完成作用于资源之上的动作，以及通过URI定位资源，而资源是一种映射。这几个概念非常重要，很显然很多REST的粉丝并不了解。另外就是从Web Service的角度去看这件事（多种客户端，以及考虑遗留系统整合以及开发给其他Partner的服务），建议阅读Restful web services一书。

其实用URI表达语义没那么恐怖，至少我的论文背景是一个大型集团级的生产和商务类项目，我觉得使用REST是合适的，简单的。

15 楼 unsid 2009-05-11  

然而，我除了认为“一目了然的路由过程”以外，没看出这么做有多大收获

14 楼 unsid 2009-05-11  

sslaowan 写道

unsid 写道

如果把谓语放在URI上怎么适应一个复杂的业务呢？
典型例子就是一个由任意多个选项组合成的复杂条件查询

给你看一个URI：http://www.baidu.com/s?q1=java&q2=&q3=&q4=&rn=10&lm=0&ct=0&ft=&q5=&q6=www.ibm.com&tn=baiduadv

这是百度的高级搜索
q1表示包含以下全部的关键词
q2表示包含以下的完整关键词
q3表示包含以下任意一个关键词
q4表示不包括以下关键词
rn表示选择搜索结果显示的条数
lm表示限定要搜索的网页的时间
ct表示搜索网页语言
ft表示搜索网页格式
q5表示查询关键词位于
q6表示限定要搜索指定的网站
最后的tn表示百度高级搜索

将来你要表达一个复杂一点的逻辑，需要一个很恐怖的uri才可以
另外我认为，REST与其说是一种新技术，倒不如说是一种呼吁
我觉得他是认为人们在开发系统中没有充分利用http原始语义或者URI本身的定位作用
而靠应用期去造轮子，其中某rest的忠实拥蹙认为“你如果用get提交一个删除服务器文件的请求是不可原谅的”
他们认为服务器行为完全可以定义在url中，而在服务器上少维护一个解析行为的过程

13 楼 whaosoft 2009-05-11  

rest 比servlet好用吗/????

12 楼 sslaowan 2009-05-11  

shiren1118 写道

sslaowan 写道

unsid 写道

另外，所谓“惯例优先”，到底有多少惯例可通用呢？
Martin Fowler对业务逻辑的定义是“业务逻辑就是没有逻辑”
/blog这个词很快就会被遗忘，然后为维护日益膨胀的“单词表”而困苦

实体是有限的，就像你建立的表是有限的，而业务逻辑比较多，而按照Fielding博士的论文，URI表示的是语义，因此好的URI应该可以很好的维护这种语义关系。我觉得，具体做法可以是用Kent的CRC卡，把上面的话直接变成URI。

理论是没啥问题，开发个原型，秀一下~~

嗯，正在做，我的毕设的一小部分

11 楼 shiren1118 2009-05-11  

sslaowan 写道

unsid 写道

另外，所谓“惯例优先”，到底有多少惯例可通用呢？
Martin Fowler对业务逻辑的定义是“业务逻辑就是没有逻辑”
/blog这个词很快就会被遗忘，然后为维护日益膨胀的“单词表”而困苦

实体是有限的，就像你建立的表是有限的，而业务逻辑比较多，而按照Fielding博士的论文，URI表示的是语义，因此好的URI应该可以很好的维护这种语义关系。我觉得，具体做法可以是用Kent的CRC卡，把上面的话直接变成URI。

理论是没啥问题，开发个原型，秀一下~~

10 楼 sslaowan 2009-05-11  

unsid 写道

另外，所谓“惯例优先”，到底有多少惯例可通用呢？
Martin Fowler对业务逻辑的定义是“业务逻辑就是没有逻辑”
/blog这个词很快就会被遗忘，然后为维护日益膨胀的“单词表”而困苦

实体是有限的，就像你建立的表是有限的，而业务逻辑比较多，而按照Fielding博士的论文，URI表示的是语义，因此好的URI应该可以很好的维护这种语义关系。我觉得，具体做法可以是用Kent的CRC卡，把上面的话直接变成URI。

9 楼 sslaowan 2009-05-11  

unsid 写道

如果把谓语放在URI上怎么适应一个复杂的业务呢？
典型例子就是一个由任意多个选项组合成的复杂条件查询

给你看一个URI：http://www.baidu.com/s?q1=java&q2=&q3=&q4=&rn=10&lm=0&ct=0&ft=&q5=&q6=www.ibm.com&tn=baiduadv

这是百度的高级搜索
q1表示包含以下全部的关键词
q2表示包含以下的完整关键词
q3表示包含以下任意一个关键词
q4表示不包括以下关键词
rn表示选择搜索结果显示的条数
lm表示限定要搜索的网页的时间
ct表示搜索网页语言
ft表示搜索网页格式
q5表示查询关键词位于
q6表示限定要搜索指定的网站
最后的tn表示百度高级搜索

8 楼 unsid 2009-05-11  

另外，所谓“惯例优先”，到底有多少惯例可通用呢？
Martin Fowler对业务逻辑的定义是“业务逻辑就是没有逻辑”
/blog这个词很快就会被遗忘，然后为维护日益膨胀的“单词表”而困苦

7 楼 unsid 2009-05-11  

如果把谓语放在URI上怎么适应一个复杂的业务呢？
典型例子就是一个由任意多个选项组合成的复杂条件查询

6 楼 treblesoftware 2009-05-11  

sslaowan 写道

treblesoftware 写道

sslaowan 写道

zozoh 写道

LZ 的意思简单的说就是：快速开发框架 就是个写好的jar包，加上一个代码生成工具。  达到的效果是，对于任何数据表的增删改查，只要一个命令就能生成相关代码。

用命令生成那是Rails的做法，我想的是不用命令，直接写URI就开始使用系统了。

这样我感觉反复生成的是相同的代码呀，这样一来我感觉直接用泛型封装相同的操作更加简洁。

所以这里生成的是继承自一个Base类的子类，方法继承了，可是属性你没办法啊，怎么泛型呢？

不好意思，没注意，你这是显示层，我看错了。

5 楼 unsid 2009-05-11  

啊哈

我的毕业设计也准备写RESTFUL
如果我能自己决定的话

4 楼 sslaowan 2009-05-11  

treblesoftware 写道

sslaowan 写道

zozoh 写道

LZ 的意思简单的说就是：快速开发框架 就是个写好的jar包，加上一个代码生成工具。  达到的效果是，对于任何数据表的增删改查，只要一个命令就能生成相关代码。

用命令生成那是Rails的做法，我想的是不用命令，直接写URI就开始使用系统了。

这样我感觉反复生成的是相同的代码呀，这样一来我感觉直接用泛型封装相同的操作更加简洁。

所以这里生成的是继承自一个Base类的子类，方法继承了，可是属性你没办法啊，怎么泛型呢？

3 楼 treblesoftware 2009-05-11  

sslaowan 写道

zozoh 写道

LZ 的意思简单的说就是：快速开发框架 就是个写好的jar包，加上一个代码生成工具。  达到的效果是，对于任何数据表的增删改查，只要一个命令就能生成相关代码。

用命令生成那是Rails的做法，我想的是不用命令，直接写URI就开始使用系统了。

这样我感觉反复生成的是相同的代码呀，这样一来我感觉直接用泛型封装相同的操作更加简洁。

2 楼 sslaowan 2009-05-11  

zozoh 写道

LZ 的意思简单的说就是：快速开发框架 就是个写好的jar包，加上一个代码生成工具。  达到的效果是，对于任何数据表的增删改查，只要一个命令就能生成相关代码。

用命令生成那是Rails的做法，我想的是不用命令，直接写URI就开始使用系统了。

1 楼 zozoh 2009-05-11  

LZ 的意思简单的说就是：快速开发框架 就是个写好的jar包，加上一个代码生成工具。  达到的效果是，对于任何数据表的增删改查，只要一个命令就能生成相关代码。