理解 RESTful 架构.docx

1、理解 RESTful 架构理解RESTful架构越来越多的人开始意识到，网站即软件，而且是一种新型的软件。这种互联网软件采用客户端/服务器模式，建立在分布式体系上，通过互联网通信，具有高延时（highlatency）、高并发等特点。网站开发，完全可以采用软件开发的模式。但是传统上，软件和网络是两个不同的领域，很少有交集；软件开发主要针对单机环境，网络则主要研究系统之间的通信。互联网的兴起，使得这两个领域开始融合,现在我们必须考虑，如何开发在互联网环境中使用的软件。RESTful架构，就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。但是

2、，到底什么是RESTful架构，并不是一个容易说清楚的问题。下面，我就谈谈我理解的RESTful架构。一、起源REST这个词，是RoyThomasFielding在他2000年的博士论文中提出的。Fielding是一个非常重要的人，他是HTTP协议（1.0版和1.1版）的主要设计者、Apache服务器软件的作者之一、Apache基金会的第一任主席。所以，他的这篇论文一经发表，就引起了关注，并且立即对互联网开发产生了深远的影响。他这样介绍论文的写作目的：本文研究计算机科学两大前沿-软件和网络-的交叉点。长期以来，软件研究主要关注软件设计的分类、设计方法的演化，很少客观地评估不同的设计选择对系统行

3、为的影响。而相反地，网络研究主要关注系统之间通信行为的细节、如何改进特定通信机制的表现，常常忽视了一个事实，那就是改变应用程序的互动风格比改变互动协议，对整体表现有更大的影响。我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。(Thisdissertationexploresajunctiononthefrontiersoftworesearchdisciplinesincomputerscience:softwareandnetworking.Softwareresearchhaslongbeenconce

4、rnedwiththecategorizationofsoftwaredesignsandthedevelopmentofdesignmethodologies,buthasrarelybeenabletoobjectivelyevaluatetheimpactofvariousdesignchoicesonsystembehavior.Networkingresearch,incontrast,isfocusedonthedetailsofgenericcommunicationbehaviorbetweensystemsandimprovingtheperformanceofparticu

5、larcommunicationtechniques,oftenignoringthefactthatchangingtheinteractionstyleofanapplicationcanhavemoreimpactonperformancethanthecommunicationprotocolsusedforthatinteraction.Myworkismotivatedbythedesiretounderstandandevaluatethearchitecturaldesignofnetwork-basedapplicationsoftwarethroughprincipledu

6、seofarchitecturalconstraints,therebyobtainingthefunctional,performance,andsocialpropertiesdesiredofanarchitecture.)二、名称Fielding将他对互联网软件的架构原则，定名为REST，即RepresentationalStateTransfer的缩写。我对这个词组的翻译是表现层状态转化。如果一个架构符合REST原则，就称它为RESTful架构。要理解RESTful架构，最好的方法就是去理解RepresentationalStateTransfer这个词组到底是什么意思，它的每一个词

7、代表了什么涵义。如果你把这个名称搞懂了，也就不难体会REST是一种什么样的设计。三、资源（Resources）REST的名称表现层状态转化中，省略了主语。表现层其实指的是资源（Resources）的表现层。所谓资源，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。所谓上网，就是与互联网上一系列的资源互动，调用它的URI。四、表现层（Representatio

8、n）资源是一种信息实体，它可以有多种外在表现形式。我们把资源具体呈现出来的形式，叫做它的表现层（Representation）。比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。URI只代表资源的实体，不代表它的形式。严格地说，有些网址最后的.html后缀名是不必要的，因为这个后缀名表示格式，属于表现层范畴，而URI应该只代表资源的位置。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对表现层的描述。五、状态转化（StateT

9、ransfer）访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生状态转化（StateTransfer）。而这种转化是建立在表现层之上的，所以就是表现层状态转化。客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。GET用来获取资源；POST用来新建资源（也可以用于更新资源）；PUT用来更新资源；DELETE用来删除资源；六

10、、综述综合上面的解释，我们总结一下什么是RESTful架构：（1）每一个URI代表一种资源；（2）客户端和服务器之间，传递这种资源的某种表现层；（3）客户端通过四个HTTP动词，对服务器端资源进行操作，实现表现层状态转化。七、误区RESTful架构有一些典型的设计误区。最常见的一种设计错误，就是URI包含动词。因为资源表示一种实体，所以应该是名词，URI不应该有动词，动词应该放在HTTP协议中。举例来说，某个URI是/posts/show/1，其中show是动词，这个URI就设计错了，正确的写法应该是/posts/1，然后用GET方法表示show。如果某些动作是HTTP动词表示不了的，你就应该

11、把动作做成一种资源。比如网上汇款，从账户1向账户2汇款500元，错误的URI是：POST/accounts/1/transfer/500/to/2。正确的写法是把动词transfer改成名词transaction，资源不能是动词，但是可以是一种服务：POST/transactionHTTP/1.1Host:127.0.0.1from=1&to=2&amount=500.00另一个设计误区，就是在URI中加入版本号：因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URI。版本号可以在HTTP请求头信息的Accept字段中进行区分（参见VersioningRESTServic

12、es）：Accept:vnd.example-com.foo+json;version=1.0Accept:vnd.example-com.foo+json;version=1.1Accept:vnd.example-com.foo+json;version=2.0REST表述性状态转移（RepresentationalStateTransfer,REST），不是一种标准，而是一种软件架构风格。基于REST的服务与基于SOAP的服务相比，性能、效率和易用性上都更高，而SOAP协议非常的复杂和不透明。REST受到越来越多的Web服务供应商欢迎。目前大部分供应商，如yahoo、google、Ama

13、zon等都提供REST风格的服务。REST的主要原则是：1.网络上的所有事物都可被抽象为资源；2.每个资源都有一个唯一的资源标识符URI；3.使用标准方法操作资源；4.所有的操作都是无状态的；5.通过缓存来提高性能。REST是基于Http协议的，任何对资源的操作行为都是通过Http协议来实现。Http把对一个资源的操作限制在4个方法以内：GET、POST、PUT和DELETE，这正是对资源CRUD操作的实现。REST的资源表述形式可以是XML、HTML、JSON，或者其他任意的形式，这取决于服务提供商和消费服务的用户。但是REST不是万能的。操作无状态也会带来巨大的安全问题，如何授权和验证用户

14、？如果要求每次请求都包含完整的身份和验证信息，又如何避免信息泄漏？复杂的功能挑战架构的易用性，这就需要在性能与功能间权衡，究竟该用REST还是SOAP。WebHttpBindingWebHttpBinding允许开发人员通过HTTP请求（这些请求使用“PlainoldXML”(POX)样式消息，而不是使用基于SOAP的消息）来公开Web服务，可以很便利的实现REST。与其他绑定不同的是：必须使用WebHttpBehavior对服务的终结点进行配置。还要求使用WebGetAttribute或WebInvokeAttribute属性将各个服务操作映射到URI，同时定义调用和返回结果的消息格式。服务

15、契约先定义服务契约。参考网址：这里一共提供了4种访问方法GET,POST,PUT,DELETE.普通WCF服务契约不同的是，需要额外用WebGet或者WebInvoke指定REST访问的方式。另外还要指定消息包装样式和消息格式如:WebGet:用于声明GET请求WebInvoke:通过指定Method来声明POST,PUT,DELETE请求RequestFormat和ResponseFormat指定发送Request和接收Response所用的格式,这里只有2种格式XML和JSON,默认都是XMLUriTemplate:用来设定方法映射到的具体URL上,如GetAllUsers就映射到了Use

16、r/All目录下，这样在客户端就需要将HttpWebRequest的地址设置为http:/localhost:2899/Service1.svc/User/All.而对于GetUser的影射路径/User/Get/Name,客户端HttpWebRequest的地址就是http:/localhost:2899/Service1.svc/User/Get/tom。在客户端我们可以用c#直接发送httprequest来调用服务，或者jQuery来异步调用.这里我选择用silverlightapp来作为客户端,传输格式XML此处的silverlight版本是silverlight4下面是客户端代码Ma

17、inPage1namespaceSilverlightApplication123publicpartialclassMainPage:UserControl45privateconststringbasicUrl=http:/localhost:2899/Service1.svc/user/;67publicMainPage()89InitializeComponent();101112privatevoidbtnGet_Click(objectsender,RoutedEventArgse)1314stringgetUrl=basicUrl+all;15HttpWebRequestreq=

18、WebRequest.Create(getUrl)asHttpWebRequest;16req.Method=get;17req.BeginGetResponse(RequestGetUserCallBack,req);181920privatevoidRequestGetUserCallBack(IAsyncResultia)2122if(ia.IsCompleted)2324HttpWebResponseresponse=(HttpWebRequest)ia.AsyncState).EndGetResponse(ia)asHttpWebResponse;25StreamwebStream=

19、response.GetResponseStream();26StreamReadersr=newStreamReader(webStream);27stringxml=sr.ReadToEnd();28sr.Close();29webStream.Close();30response.Close();31323334privatevoidbtnPost_Click(objectsender,RoutedEventArgse)3536/stringxmlFile=post.xml;37/StreamReadersr=newStreamReader(xmlFile,System.Text.Enc

20、oding.UTF8);38/stringnewUser=sr.ReadToEnd();39/sr.Close();40stringnewUser=+41dafjijo43js4dwdqrq4;42bytedata=System.Text.UnicodeEncoding.UTF8.GetBytes(newUser);4344stringpost=basicUrl+create;45HttpWebRequestreq=WebRequest.Create(post)asHttpWebRequest;46req.Method=post;47req.ContentType=text/xml;48req

21、.ContentLength=data.Length;49req.BeginGetRequestStream(RequestCreateUserCallBack,newobjectreq,data);505152privatevoidRequestCreateUserCallBack(IAsyncResultia)5354if(ia.IsCompleted)5556objectobjlist=ia.AsyncStateasobject;57bytedata=objlist1asbyte;5859Streamstream=(HttpWebRequest)objlist0).EndGetReque

22、stStream(ia);60stream.Write(data,0,data.Length);61stream.Close();62(HttpWebRequest)objlist0).BeginGetResponse(NullCallBack,ia.AsyncState);63646566privatevoidbtnPut_Click(objectsender,RoutedEventArgse)6768stringnewUser=+69dafjijo43js4dwdqrq4;70bytedata=System.Text.UnicodeEncoding.UTF8.GetBytes(newUse

23、r);7172stringput=basicUrl+Update/+v-lk;73HttpWebRequestreq=WebRequest.CreateHttp(put);74req.Method=put;75req.ContentType=text/xml;76req.ContentLength=data.Length;77req.BeginGetRequestStream(RequestModifyUserCallBack,newobjectreq,data);787980privatevoidRequestModifyUserCallBack(IAsyncResultia)8182if(

24、ia.IsCompleted)8384objectobjlist=ia.AsyncStateasobject;85bytedata=objlist1asbyte;8687Streamstream=(HttpWebRequest)objlist0).EndGetRequestStream(ia);88stream.Write(data,0,data.Length);89stream.Close();90(HttpWebRequest)objlist0).BeginGetResponse(NullCallBack,ia.AsyncState);91929394privatevoidNullCall

25、Back(IAsyncResultia)9596979899privatevoidbtnDel_Click(objectsender,RoutedEventArgse)100101stringnewUser=+102dafjijo43js4dwdqrq4;103bytedata=System.Text.UnicodeEncoding.UTF8.GetBytes(newUser);104105stringdelete=basicUrl+Delete/+v-lk;106HttpWebRequestreq=WebRequest.CreateHttp(delete);107req.Method=del

26、ete;108req.ContentType=text/xml;109req.ContentLength=data.Length;110req.BeginGetRequestStream(RequestDeleteUserCallBack,newobjectreq,data);111112113privatevoidRequestDeleteUserCallBack(IAsyncResultia)114115if(ia.IsCompleted)116117objectobjlist=ia.AsyncStateasobject;118bytedata=objlist1asbyte;119120S

27、treamstream=(HttpWebRequest)objlist0).EndGetRequestStream(ia);121stream.Write(data,0,data.Length);122stream.Close();123(HttpWebRequest)objlist0).BeginGetResponse(NullCallBack,ia.AsyncState);124125126127这里的btnget,btnpost.分别对应rest里的get,post,put,delete请求.先简单说下Get:在GET请求中，请求发送顺序是createWebRequest-GetResp

28、onse-GetStream-ReadStream-DisplayXML由于silverlightsdk比较小所以在getresponse和getstream的时候需要用异步来解决.在GET请求中，注意URL一定要正确，如果不知道URL是什么的可以访问http:/localhost:2899/service1.svc/help来查看请求URL和发送数据的格式.当然要看到help必须在web,config中把helpEnable设为true在客户端我们可以用c#直接发送httprequest来调用服务，或者jQuery来异步调用.这里我选择用silverlightapp来作为客户端,传输格式XM

29、L此处的silverlight版本是silverlight4下面是客户端代码MainPage1namespaceSilverlightApplication123publicpartialclassMainPage:UserControl45privateconststringbasicUrl=http:/localhost:2899/Service1.svc/user/;67publicMainPage()89InitializeComponent();101112privatevoidbtnGet_Click(objectsender,RoutedEventArgse)1314stringgetUrl=basicUrl+all;15HttpWebRequestreq=WebRequest.Create(getUrl)asHttpWebReques