restlet是一个java下的轻量级rest框架。通过拥抱rest(rest是一种web架构风格)它模糊了web站点和web服务之间的界限,从而帮助开发人员构建web。每一个主要的rest概念(rest concept)都有一个对应的java类。你的rest化的web设计和你的代码之间的映射是非常简单直接的。
为什么有必要创建另一种框架?难道servlet api还不够好用吗?
servlet aip在1998年发布,从那个时候起它的核心设计一直没有很大的变化。它是java ee的众多api中最成功的一个,但是它的几个设计缺陷和一些限制损害了它。举个例子,uri模式和它的处理者(handler)之间的映射是受限制的,而且其配置都集中在一个配置文件中。还有,它把socket流的控制直接交给了应用系统开发人员,servlet容器阻碍了我们充分nio特性对io操作进行优化。另一个主要就是servlet api鼓励应用开发者在应用或者用户会话级别直接将session状态保存于内存中,尽管这看上去不错,但它造成了servlet容器扩展性和高可用性的主要问题。为了克服这些问题,就必须实现复杂的、session复制、持久化机制。这导致了可扩展性必然成为灾难。
如何看待别的框架中对rest的支持(例如axis2,或者cxf/xfire)?
这些支持非常有效,但是作用非常有限。我的主要观点是设计这些项目是为了符合ws-*/soap stack,它们与rest世界并不非常契合。在rest世界里,定义了一个全新的范例:面向资源的设计,而非通过远程调用这样的范例。例如axis2仅仅支持get和post两种http方法,它需要远程方法的传递需要一个uri参数。这在rest中式不允许的,这种做法也不能被称之为rest化。xfire1.2不支持rest,但是它发布了一个项目用于将pojo映射到rest化的web服务。这有点类似最近发布的jsr-311,此jsr试图基于一套annotation和助手类标准化这种映射。
rest与http协议
rest架构是由roy thomas fielding博士在2000年首次提出的。他为我们描绘了开发基于的软件的蓝图。rest软件架构是一个抽象的概念,是一种为了实现这一互联网的超媒体分布式系统的行动指南。利用任何的都可以实现这种理念。而实现这一软件架构最著名的就是http协议。通常我们把rest也写作为rest/http,在实际中往往把rest理解为基于http的rest软件架构,或者更进一步把rest和http看作为等同的概念。今天,http是互联网上应用最广泛的计算机协议。http不是一个简单的运载数据的协议,而是一个具有丰富内涵的网络软件的协议。它不仅仅能够对于互联网资源进行唯一定位,而且还能告诉我们对于该资源进行怎样运作。这也是rest软件架构当中最重要的两个理念。而rest软件架构理念是真正理解http协议而形成的。有了rest软件架构理念出现,才使得软件业避免了对http协议的片面理解。只有正确的理论指导,才能避免在软件开发的实际工作过程中少走弯路。
rest与uri(资源定位)
rest软件架构之所以是一个超媒体系统,是因为它可以把网络上所有资源进行唯一的定位,不管你的文件是图片、文件word还是文件,也不管你的文件是txt文件格式、xml文件格式还是其它文本文件格式。它利用支持http的tcp/ip协议来确定互联网上的资源。
rest与crud原则
rest软件架构遵循了crud原则,该原则告诉我们对于资源(包括网络资源)只需要四种行为:创建(create)、获取(read)、更新(update)和销毁(delete)就可以完成对其操作和处理了。其实世界万物都是遵循这一规律:生、变、见、灭。所以计算机世界也不例外。这个原则是源自于我们对于数据库表的数据操作:insert(生)、select(见)、update(变)和delete(灭),所以有时候crud也写作为rudi,其中的i就是insert。这四个操作是一种原子操作,即一种无法再分的操作,通过它们可以构造复杂的操作过程,正如数学上四则运算是数字的最基本的运算一样。
rest与网络服务
尽管在java语言世界中网络服务目前是以soap技术为主,但是rest将是是网络服务的另一选择,并且是真正意义上的网络服务。基于rest思想的网络服务不久的将来也会成为是网络服务的主流技术。rest不仅仅把http作为自己的数据运输协议,而且也作为直接进行数据处理的工具。而当前的网络服务技术都需要使用其它手段来完成数据处理工作,它们完全独立于http协议来进行的,这样增加了大量的复杂软件架构设计工作。rest的思想充分利用了现有的http技术的网络能力。在德国电视台上曾经出现过一个这样的五十万欧元智力题:如何实现网络服务才能充分利用现有的http协议?该问题给出了四个答案:去问微软;wsdl2.0/soap1.2;ws-transfer;根本没有。这个问题告诉我们http并不是一个简单的数据传来传去的协议,而是一个聪明的会表现自己的协议,这也许是rest = representational state transfer的真正含义。实际上目前很多大公司已经采用了rest技术作为网络服务,如google、amazon等。在java语言中重要的两个以soap技术开始的网络服务框架xfire和axis也把rest作为自己的另一种选择。它们的新的项目分别是和。java语言也制定关于rest网络服务规范:jax-rs: java api for restful web services (jsr 311)。相信还会出现更多与rest相关的激动人心的信息。
rest与ajax技术
尽管ajax技术的出现才不到两年时间,但是ajax技术遵循了rest的一些重要原则。ajax技术充分利用了http来获取网络资源并且实现了http没有的对于异步数据进行传输的功能。ajax技术还使得软件更好地实现分布性功能,在一个企业内只要一个人下载了ajax引擎,其它企业内部的人员,就可以共享该资源了。ajax技术遵守rest准则的应用程序中简单和可伸缩的架构,凡是采用ajax技术的页面简洁而又丰富,一个页面表现了丰富多彩的形态。ajax技术还使用了一种不同于xml格式的json文件格式,这个意义在哪里呢?在rest软件架构下我们不能对于xml文件进行序列化处理,这样程序员必须要使用自己的xml绑定框架。而以序列化的javascript对象为基础的json已经获得了广泛认可,它被认为能以远比xml更好的方式来序列化和传输简单数据结构,而且它更简洁。这对rest是一个极大贡献和补充。当前的网络应用软件还违背了rest的“无状态”约束。rest服务器只知道自己的状态。rest不关心客户端的状态,客户端的状态自己来,这是ajax技术的应用之地。通过ajax技术,可以发挥有状态网络客户机的。而rest的服务器关心的是从所有网络客户端发送到服务器操作的顺序。这样使得互联网这样一个巨大的网络得到有序的管理。
rest与rails框架
ruby on rails框架(简称rails或者rails框架)是一个基于ruby语言的越来越流行的网络应用软件开发框架。它提供了关于rest最好的支持,也是当今应用rest最成功的一个软件开发框架。rails框架(从版本1.2.x起)成为了第一个引入rest作为核心思想的主流网络软件开发框架。在rails框架的充分利用了rest软件架构之后,人们更加坚信rest的重要性和必要性。rails利用rest软件架构思想对网络服务也提供了一流的支持。从最直观的角度看待rest,它是网络服务最理想的手段,但是rails框架把rest带到了网络应用软件开发框架。这是一次飞跃,让rest的思想从网络服务的应用提升到了网络应用软件开发。利用rest思想的simply_restful插件已经成为了rails框架的核心内容。
rest性
我们把现有基于soap的网络服务和基于rest/http网络服务作个比喻,前者是一种传统的寄信方式,而后者是现代网络的电子邮件方式。要是是寄信和电子邮件都有病毒存在的话,传统的寄信被送到对方就很危险,而电子邮件是开发的,电子邮件供应商比如google为我们检查了电子邮件是否有病毒。这里并不是说明soap网络服务消息包含义病毒,而是说明http是无法处理soap信息包究竟好不好,需要额外的软件工具这一问题,包括也用不上和管不了。
rest/http网络服务的信息包可以被防火墙理解和控制。你可以按照操作和链接进行过滤信息包,如你可以规定从外部来的只能读取(get操作)自己服务器的资源。这样对于系统管理员而言使得软件管理更为简单。rest的安全性还可以利用传输安全协议ssl/tls、基本和摘要式认证(basic und digest authentication)。除了这些rest自身的安全性功能外,还可以利用像基于信息的web services security(jsr 155)作为rest不错的补充。
restlet第一步:
这篇文章让你在10分钟内尝试简单的restlet框架。告诉你如何创建一个说“hello, world”的resource。
1.我需要什么?
2.“hello, world”应用
3.在servlet容器中运行
4.作为一个单独的java应用运行
5.结尾
1.我需要什么?
我们假设你已经有了一个可以马上使用的开发环境,并且你已经安装了jre1.5(或更高)。如果你还没有下载restlet,请选择最新的
2.“hello, world”程序
让我们从rest应用的核心---资源开始入手。下面的代码是这个程序涉及的唯一资源。拷贝/粘贴代码到“helloworldresource”类中。
java代码
01packagefirststeps;
02
03importorg.restlet.context;
04importorg.restlet.data.mediatype;
05importorg.restlet.data.request;
06importorg.restlet.data.response;
07importorg.restlet.resource.representation;
08importorg.restlet.resource.resource;
09importorg.restlet.resource.stringrepresentation;
10importorg.restlet.resource.variant;
11
12/**
13* resource which has only one representation.
14*
15*/
16publicclasshelloworldresourceextendsresource {
17
18publichelloworldresource(context context, request request,
19 response response) {
20super(context, request, response);
21
22// this representation has only one type of representation.
23 getvariants().add(newvariant(mediatype.text_plain));
24 }
25
26/**
27* returns a full representation for a given variant.
28*/
29 @override
30publicrepresentation getrepresentation(variant variant) {
31 representation representation =newstringrepresentation(
32 "hello, world", mediatype.text_plain);
33returnrepresentation;
34 }
35 }
然后创建应用例子。我们创建名为“firststepsapplication”的类并拷贝/粘贴下面的代码:
01packagefirststeps;
02
03importorg.restlet.application;
04importorg.restlet.context;
05importorg.restlet.restlet;
06importorg.restlet.router;
07
08publicclassfirststepsapplicationextendsapplication {
09
10publicfirststepsapplication(context parentcontext) {
11super(parentcontext);
12 }
13
14/**
15* creates a root restlet that will receive all incoming calls.
16*/
17 @override
18publicsynchronizedrestlet createroot() {
19// create a router restlet that routes each call to a
20// new instance of helloworldresource.
21 router router =newrouter(getcontext());
22
23// defines only one route
24 router.attachdefault(helloworldresource.class);
25
26returnrouter;
27 }
28 }
3.在servlet容器中运行
你可能更熟悉servlets,我们建议你在你喜欢的servlet容器里运行restlet应用。像往常一样创建一个新的servlet应用,把下面列出的jar包放入lib目录。
org.restlet.jar
com.noelios.restlet.jar
com.noelios.restlet.ext.servlet_2.4.jar
然后按下面的配置修改“web.xml”配置文件:
01
02id="webapp_id" version="2.4"
03 xmlns="
04 xmlns:xsi="
05 xsi:schemalocation="
06>
07first steps servlet
08
09
10org.restlet.application
11
12 firststeps.firststepsapplication
13
14
15
16
17
18restletservlet
19
20 com.noelios.restlet.ext.servlet.serverservlet
21
22
23
24
25
26restletservlet
27/*
28
29
最后,将程序打包成一个war文件,例如“firststepsservlet.war”,并部署到你的servlet容器里。启动servlet容器后,打开你喜欢的浏览器,输入url:“你的服务器名>:<端口号>/firststepsservlet”。服务器将很高兴地用“hello, world”欢迎你。
4.作为一个单独的java应用运行
restlet应用并不是只能运行在servlet容器里,也可以使用下面几个jar包所为一个独立应用运行:
org.restlet.jar
com.noelios.restlet.jar
com.noelios.restlet.ext.simple.jar
org.simpleframework.jar
如果你想要理解后面两个jar包的意义,你可以参考连接器()。
创建一个主类,拷贝/粘贴下面的代码。建立一个新的http服务器监听端口8182并委托所有的请求给“firststepsapplication”。
代码:
01packagefirststeps;
02importorg.restlet.component;
03importorg.restlet.data.protocol;
04
05publicclassfirststepsmain {
06
07publicstaticvoidmain(string[] args) {
08try{
09// create a new component.
10 component component =newcomponent();
11// add a new http server listening on port 8182.
12 component.getservers().add(protocol.http, 8182);
13
14// attach the sample application.
15 component.getdefaulthost().attach(
16newfirststepsapplication(component.getcontext()));
17
18// start the component.
19 component.start();
20 }catch(exception e) {
21// something is wrong.
22 e.printstacktrace();
23 }
24 }
25 }
启动main对象,打开你喜欢的浏览器,输入url:“”,服务器将高兴地用“hello, world”欢迎你。否则,确认classpath正确且没有其他应用占用8182端口。
restlet第二步:晋级篇
这里说明resource如何处理get,post,put和delete方法。
1.引言
2.示例程序
3.实现items resource
4.实现item resource
5.实现base resource
6.运行应用
7.客户端应用
8.总结
1. 引言
在开始开发前,我们需要简单介绍一下restlet框架的resource概念。rest告诉我们,resource根据uri进行辨认,同时能够有一种或多种表现(也被称作变量),用以响应方法调用。
在restlet框架中,服务器连接器(server connectors)收到的调用最终由resource的实例对象处理。一个resource负责声明支持的表现方式列表(variant对象的实例)和实现你想要支持的rest方法。
get依赖可更改的“variants”列表和“getrepresentation(variant)”方法。
post依赖“allowpost”方法和“post(representation)”方法。
delete依赖“allowput”方法和“put(representation)”方法。
delete依赖“allowdelete”方法和“delete()”方法。
还有,每一个到达的响应由一个专门的resource实例处理,你不需要操心这些方法的线程安全问题。
我们假设你已经读过“第一步”,并且有了一些元件和应用的概念。
2.示例程序
一个item列表用来管理创建,读取,更新,和删除活动,如一个典型的crud应用。一个item包含名字和描述。在简短的分析后,我们定义了两个资源:
items resource代表所有可用item的集合。
item resource代表一个单独的item。
现在,让我们定义用来标志item的resource uris。假设我们的应用运行在本机“localhost”并且监听8182端口:
:“items”resource uri。
:“item”resource uri,每个{itemname}代表一个item的名字。
下一步,定义每个resource允许访问的方法列表。
“items”resource响应get请求并以一个xml文档展示当前注册的所有item列表。另外,resource支持通过post请求创建新的item。提交的实体包含新的item的名字和描述,这些是以格式化的web表单方式提交的。如果resource成功创建新item,它返回一个“success - resource created”状态(http 201状态代码)并且告诉客户端新resource在哪里可以找到(http "location" header)。否则,它返回一个“client error”状态(http 404状态代码)和一个简单的错误信息。
“item”resource响应get请求并以一个xml文档来展示该resource的名字和描述。也可以通过put和delete请求更新和删除resource。
在描述两个resource对象前,首先编写应用的代码。为简化起见,注册的item列表做为应用的一个属性简单地保存到内存里,并不保存到一个真实的数据库。不管怎样,我们假设你想邀请你的朋友们同时测试这个应用。因为我们只有一个“firstresourceapplication”实例在运行,所以不得不考虑线程安全。这也就是为什么你会发现map对象items是不不可更改的,它是一个concurrenthashmap对象的实例。
代码:
01packagefirstresource;
02
03importjava.util.map;
04importjava.util.concurrent.concurrenthashmap;
05
06importorg.restlet.application;
07importorg.restlet.context;
08importorg.restlet.restlet;
09importorg.restlet.router;
10
11publicclassfirstresourceapplicationextendsapplication {
12
13 /** the list of items is persisted in memory. */
14 privatefinalmap items;
15
16 publicfirstresourceapplication(context parentcontext) {
17 super(parentcontext);
18 // we make sure that this attribute will support concurrent access.
19 items =newconcurrenthashmap();
20 }
21
22 /**
23 * creates a root restlet that will receive all incoming calls.
24 */
25 @override
26 publicsynchronizedrestlet createroot() {
27 // create a router restlet that defines routes.
28 router router =newrouter(getcontext());
29
30 // defines a route for the resource "list of items"
31 router.attach("/items", itemsresource.class);
32 // defines a route for the resource "item"
33 router.attach("/items/{itemname}", itemresource.class);
34
35 returnrouter;
36 }
37
38 /**
39 * returns the list of registered items.
40 *
41 * @return the list of registered items.
42 */
43 publicmap getitems() {
44 returnitems;
45 }
46 }
2. 实现items resource
让我们开始编写items resource。如上文所述,它允许get和post请求。post请求支持实现“post(representation)”方法赋予处理消息实体的权限。此外,资源通过“allowpost”方法来确定是否开启post支持。缺省情况下,资源是不可更改的,拒绝post、put和delete方法并返回“method not allowed”状态(http 405状态代码)。
同样,通过实现“represent(variant)”方法确定你可以接受get请求并根据指定的variant生成实体。在这个例子中,我们只生成“text/xml”这种形式。
代码:
001packagefirstresource;
002
003importjava.io.ioexception;
004importjava.util.collection;
005
006importorg.restlet.context;
007importorg.restlet.data.form;
008importorg.restlet.data.mediatype;
009importorg.restlet.data.request;
010importorg.restlet.data.response;
011importorg.restlet.data.status;
012importorg.restlet.resource.domrepresentation;
013importorg.restlet.resource.representation;
014importorg.restlet.resource.stringrepresentation;
015importorg.restlet.resource.variant;
016importorg.w3c.dom.document;
017importorg.w3c.dom.element;
018
019/**
020* resource that manages a list of items.
021*
022*/
023publicclassitemsresourceextendsbaseresource {
024
025 /** list of items. */
026 collection- items;
027
028 publicitemsresource(context context, request request, response response) {
029 super(context, request, response);
030
031 // get the items directly from the "persistence layer".
032 items = getitems().values();
033
034 // declare the kind of representations supported by this resource.
035 getvariants().add(newvariant(mediatype.text_xml));
036 }
037
038 @override
039 publicbooleanallowpost() {
040 returntrue;
041 }
042
043 /**
044 * returns a listing of all registered items.
045 */
046 @override
047 publicrepresentation getrepresentation(variant variant) {
048 // generate the right representation according to its media type.
049 if(mediatype.text_xml.equals(variant.getmediatype())) {
050 try{
051 domrepresentation representation =newdomrepresentation(
052 mediatype.text_xml);
053 // generate a dom document representing the list of
054 // items.
055 document d = representation.getdocument();
056 element r = d.createelement("items");
057 d.appendchild(r);
058 for(item item : items) {
059 element eltitem = d.createelement("item");
060
061 element eltname = d.createelement("name");
062 eltname.appendchild(d.createtextnode(item.getname()));
063 eltitem.appendchild(eltname);
064
065 element eltdescription = d.createelement("description");
066 eltdescription.appendchild(d.createtextnode(item
067 .getdescription()));
068 eltitem.appendchild(eltdescription);
069
070 r.appendchild(eltitem);
071 }
072 d.normalizedocument();
073
074 // returns the xml representation of this document.
075 returnrepresentation;
076 }catch(ioexception e) {
077 e.printstacktrace();
078 }
079 }
080
081 returnnull;
082 }
083
084 /**
085 * handle post requests: create a new item.
086 */
087 @override
088 publicvoidpost(representation entity) {
089 // parse the given representation and retrieve pairs of
090 // "name=value" tokens.
091 form. form. =newform(entity);
092 string itemname = form.getfirstvalue("name");
093 string itemdescription = form.getfirstvalue("description");
094
095 // check that the item is not already registered.
096 if(getitems().containskey(itemname)) {
097 generateerrorrepresentation(
098 "item " itemname " already exists.", "1", getresponse());
099 }else{
100 // register the new item
101 getitems().put(itemname,newitem(itemname, itemdescription));
102
103 // set the response's status and entity
104 getresponse().setstatus(status.success_created);
105 representation rep =newstringrepresentation("item created",
106 mediatype.text_plain);
107 // indicates where is located the new resource.
108 rep.setidentifier(getrequest().getresourceref().getidentifier()
109 "/" itemname);
110 getresponse().setentity(rep);
111 }
112 }
113
114 /**
115 * generate an xml representation of an error response.
116 *
117 * @param errormessage
118 * the error message.
119 * @param errorcode
120 * the error code.
121 */
122 privatevoidgenerateerrorrepresentation(string errormessage,
123 string errorcode, response response) {
124 // this is an error
本博客为学习交流用,凡未注明引用的均为本人作品,转载请注明出处,如有凯发k8网页登录的版权问题请及时通知。由于博客时间仓促,错误之处敬请谅解,有任何意见可给我留言,愿共同学习进步。