REST风格的应用程序实现

以前就是觉得 /category/product/pid

这样的地址非常的漂亮，但是那只是表象罢了，了解深入以后，发现必须有一个客户端的Ajax Engine和Server端的服务配合，才能实现一个REST风格的应用，下面就是我的实验。

问题？

要对外提供哪些服务。服务器端的服务可能会被众多的浏览器请求，也可能被第三方应用程序所调用，所以需要从总体上来考虑这个对外的“应用程序接口”（API），尽量保持接口的稳定性。REST是一种风格，并且形成了自己的规则，构建这样的应用，应尽量遵循REST的原则。

 

以一个足球服务为例，众多的观众会要求观看比赛的记录，上传新比赛记录，更新比赛记录，更正现有的比赛或者删除比赛等等。像这样描述的话，我们需要提供众多不同的服务，并且最终会倒在维护一致性的工作上。那么应该怎么做呢，考虑一下客户可能的请求方式：

GET方式请求一个新建比赛服务：

http://example.com/newMatch?id=995&bluebaggers=150&redlegs=60

POST或PUT方式请求一个新建比赛服务：

http://example.com/newMatch

附加的XML为：

<match id="995">

    <score team="bluebaggers">150</score>

    <score team="redlegs">60</score>

</match>

CGI风格的POST或PUT请求：

http://example.com/newMatch

请求体：

id=995&bluebaggers=150&redlegs=60

或者一个维护服务的GET请求：

http://example.com/matchMaintenance/command=newMatch&id=995&bluebaggers=150&redlegs=60

或者POST请求

http://example.com/matchMaintenance/command=newMatch

<match id="995"><score team="bluebaggers">150</score><score team="redlegs">60</score></match>

以此类推，可以有很多这样的功能。有些人觉得这并不是什么问题，对越来越多的请求，我们只要建立服务，然后给出相应的说明就可以了。但是，他还是存在缺点的。

也许我们会假设访问只是来自脚本，那么这种情况可能会简单一点。但实际上，还有很多的因素会涉及到，例如网页浏览器（会存在后撤和刷新按钮的问题）、Web服务器（可能会有缓存和编译问题）、网络路由和缓存问题、应对爬虫的骚扰、一些个人站点对网站内容的抓取。如果我们考虑这些不同的请求，我们的程序就可以表现的更健壮。

理想的情况下，一个服务应该有自我说明的能力。如果一个服务建立在一种约定俗成的条件下，那么大家就很容易适应并且进行后续的开发。

REST就是考虑了这些因素，可以使用RESTful API来实现上面的服务。

 

RESTful 原则介绍

REST的主要原则有：

用URL表示资源。资源就像商业实体一样，是我们希望作为API实体呈现的一部分。通常是一个名词，每个资源都用一个独一无二的URL来表示。

HTTP方法表示操作。REST充分利用了HTTP的方法，特别是GET、POST、PUT和DELETE。注意XMLHttpRequest对象实现了全部的方法，具体可以参看W3C HTTP 1.1 Specification。

也就是说，客户端的任何请求都包含一个URL和一个HTTP方法。回到上面的例子中，比赛显然是一个实体，那么对于一个特定比赛的请求就表示为：

 http://example.com/matches/995

 

这种方式是清晰明了的，也许和精确命名的方式有所区别，但是只要遵循这种形式，我们就能很快的进行GET、DELETE、UPDATE和新建操作。

RESTful的原则：

1、URL表示资源

2、HTTP方法表示操作

3、GET只是用来请求操作，GET操作永远都不应该修改服务器的状态。但是这个也要具体情况进行分析，例如一个页面中的计数器，每次访问的时候确实引起了服务器数据的改变，但是在商业上来说，这并不是一个很重要的改变，所以仍然可以接收使用GET的方式来修改数据。

一个案例，使用GET方式修改数据遭受损失的案例

Witness the the debacle caused by the Google Accelerator interacting with non-RESTful services in mid-2005. The accelerator jumps ahead of the user and prefetches each link in case they should click on it (a non-Ajaxian example of Predictive Fetch). The problem came when users logged into non-RESTful applications likeBackpack. Because Backpack deletes items using GET calls, the accelerator - in its eagerness to activate each GET query - ended up deleting personal data. This could happen with regular search engine crawlers too, though the issue doesn't tend to come up because they don't have access to personal accounts.

4、服务应该是无状态的

在有状态的会话中，服务器可以记录之前的信息。而RESTful风格中是不应该让服务器记录状态的，只有这样服务器才具备可扩展性。当然，我们可以在客户端使用cookie，而且只能用在客户端向服务器发送请求的时候。

5、服务应当是“幂等”的

“幂等”表示可以发送消息给服务，然后可以再次毫不费力的发送同样的消息给服务。例如，发送一个“删除第995场比赛”的消息，可以发送一次，也可以连续发送十次，最后的结果都会保持一致。当然，RESTful的GET请求通常是幂等的，因为基本上不会改变服务器的状态。注意：POST请求不能被定义为“幂等”，特别是在创建新资源的时候，一次请求创建一个资源，多次请求会创建多个资源。

6、拥抱超链接

7、服务应当自我说明

例如 http://example.com/match/995 请求了一个具体的比赛，但是 http://example.com/match 并没有对任何实体进行请求，因此，应当返回一些介绍信息。

8、服务约束数据格式。数据必须符合要求的格式

 

在PHP的程序中，想要实现这种REST风格的URL，仅仅依靠程序是不行的，还需要在服务器端配置rewrite规则，例如，对于一个REST风格的资源请求：

http://www.api.com/product/113

一般实现的脚本为

http://www.api.com/product.php?id=113

这个是基于QueryString的，也可以做一个统一的 index.php 入口，然后通过处理URI的方式实现，例如：

http://www.api.com/index.php/product/113

这样的URL，都可以通过rewrite来实现rest风格。总之，REST是一种程序设计的风格，为我们整理自己的应用设计提供了一个原则，在利用这些原则带来的遍历的同时，可以根据实际情况进行灵活的处理。

 

 

一、起源

REST这个词，是Roy Thomas Fielding在他2000年的博士论文中提出的。

 

Fielding是一个非常重要的人，他是HTTP协议（1.0版和1.1版）的主要设计者、Apache服务器软件的作者之一、Apache基金会的第一任主 席。所以，他的这篇论文一经发表，就引起了关注，并且立即对互联网开发产生了深远的影响。

他这样介绍论文的写作目的：

"本文研究计算机科学两大前沿----软件和网络----的交叉点。长期以来，软件研究主要关注软件设计的分类、设计方法的演化，很少客观地评估不同的设计选择对系统行为的影响。而相反地，网络研究主要关注系统之间通信行为的细节、如何改进特定通信机制的表现，常常忽视了一个事实，那就是改变应用程序的互动风格比改变互动协议，对整体表现有更大的影响。我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。"

(This dissertation explores a junction on the frontiers of two research disciplines in computer science: software and networking. Software research has long been concerned with the categorization of software designs and the development of design methodologies, but has rarely been able to objectively evaluate the impact of various design choices on system behavior. Networking research, in contrast, is focused on the details of generic communication behavior between systems and improving the performance of particular communication techniques, often ignoring the fact that changing the interaction style of an application can have more impact on performance than the communication protocols used for that interaction. My work is motivated by the desire to understand and evaluate the architectural design of network-based application software through principled use of architectural constraints, thereby obtaining the functional, performance, and social properties desired of an architecture. )

二、名称

Fielding将他对互联网软件的架构原则，定名为REST，即Representational State Transfer的缩写。我对这个词组的翻译是"表现层状态转化"。

如果一个架构符合REST原则，就称它为RESTful架构。

要理解RESTful架构，最好的方法就是去理解Representational State Transfer这个词组到底是什么意思，它的每一个词代表了什么涵义。如果你把这个名称搞懂了，也就不难体会REST是一种什么样的设计。

三、资源（Resources）

REST的名称"表现层状态转化"中，省略了主语。"表现层"其实指的是"资源"（Resources）的"表现层"。

所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。

所谓"上网"，就是与互联网上一系列的"资源"互动，调用它的URI。

四、表现层（Representation）

"资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的"表现层"（Representation）。

比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。

URI只代表资源的实体，不代表它的形式。严格地说，有些网址最后的".html"后缀名是不必要的，因为这个后缀名表示格式，属于"表现层"范畴，而URI应该只代表"资源"的位置。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。

五、状态转化（State Transfer）

访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。

互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。

客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

六、综述

综合上面的解释，我们总结一下什么是RESTful架构：

　　（1）每一个URI代表一种资源；

　　（2）客户端和服务器之间，传递这种资源的某种表现层；

　　（3）客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

七、误区

RESTful架构有一些典型的设计误区。

最常见的一种设计错误，就是URI包含动词。因为"资源"表示一种实体，所以应该是名词，URI不应该有动词，动词应该放在HTTP协议中。

举例来说，某个URI是/posts/show/1，其中show是动词，这个URI就设计错了，正确的写法应该是/posts/1，然后用GET方法表示show。

如果某些动作是HTTP动词表示不了的，你就应该把动作做成一种资源。比如网上汇款，从账户1向账户2汇款500元，错误的URI是：

　　POST /accounts/1/transfer/500/to/2

正确的写法是把动词transfer改成名词transaction，资源不能是动词，但是可以是一种服务：

　　POST /transaction HTTP/1.1
　　Host: 127.0.0.1
　　
　　from=1&to=2&amount=500.00

另一个设计误区，就是在URI中加入版本号：

　　http://www.example.com/app/1.0/foo

　　http://www.example.com/app/1.1/foo

　　http://www.example.com/app/2.0/foo

因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URI。版本号可以在HTTP请求头信息的Accept字段中进行区分（参见Versioning REST Services）：

　　Accept: vnd.example-com.foo+json; version=1.0

　　Accept: vnd.example-com.foo+json; version=1.1

　　Accept: vnd.example-com.foo+json; version=2.0

（完）