RESTFUL架构

时间 2020-08-10

原文原文链接

一、什么是REST：html

　　REST全称是Representational State Transfer，中文意思是表征性状态转移。它首次出如今2000年Roy Fielding的博士论文中，Roy Fielding是HTTP规范的主要编写者之一。他在论文中提到："我这篇文章的写做目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，获得一个功能强、性能好、适宜通讯的架构。REST指的是一组架构约束条件和原则。" 若是一个架构符合REST的约束条件和原则，咱们就称它为RESTful架构。java

　　REST自己并无创造新的技术、组件或服务，而隐藏在RESTful背后的理念就是使用Web的现有特征和能力，更好地使用现有Web标准中的一些准则和约束。虽然REST自己受Web技术的影响很深，可是理论上REST架构风格并非绑定在HTTP上，只不过目前HTTP是惟一与REST相关的实例。因此咱们这里描述的REST也是经过HTTP实现的REST。git

二、如何理解RESTful架构：github

要理解RESTful架构，须要理解Representational State Transfer这个词组究竟是什么意思，它的每个词都有些什么涵义。算法

下面咱们结合REST原则，围绕资源展开讨论，从资源的定义、获取、表述、关联、状态变迁等角度，列举一些关键概念并加以解释。数据库

资源与URI
统一资源接口
资源的表述
资源的连接
状态的转移

2.1资源与URIjson

　　REST全称是表述性状态转移，那究竟指的是什么的表述? 其实指的就是资源。任何事物，只要有被引用到的必要，它就是一个资源。资源能够是实体(例如手机号码)，也能够只是一个抽象概念(例如价值) 。下面是一些资源的例子：浏览器

某用户的手机号码
某用户的我的信息
最多用户订购的GPRS套餐
两个产品之间的依赖关系
某用户能够办理的优惠套餐
某手机号码的潜在价值

　　要让一个资源能够被识别，须要有个惟一标识，在Web中这个惟一标识就是URI(Uniform Resource Identifier)。缓存

　　URI既能够当作是资源的地址，也能够当作是资源的名称。若是某些信息没有使用URI来表示，那它就不能算是一个资源，只能算是资源的一些信息而已。URI的设计应该遵循可寻址性原则，具备自描述性，须要在形式上给人以直觉上的关联。这里以github网站为例，给出一些还算不错的URI：安全

https://github.com/git
https://github.com/git/git
https://github.com/git/git/blob/master/block-sha1/sha1.h
https://github.com/git/git/commit/e3af72cdafab5993d18fae056f87e1d675913d08
https://github.com/git/git/pulls
https://github.com/git/git/pulls?state=closed
https://github.com/git/git/compare/master…next

下面让咱们来看看URI设计上的一些技巧:

使用_或-来让URI可读性更好

曾经Web上的URI都是冰冷的数字或者无心义的字符串，但如今愈来愈多的网站使用_或-来分隔一些单词，让URI看上去更为人性化。例如国内比较出名的开源中国社区，它上面的新闻地址就采用这种风格，如http://www.oschina.net/news/38119/oschina-translate-reward-plan。

使用/来表示资源的层级关系

例如上述/git/git/commit/e3af72cdafab5993d18fae056f87e1d675913d08就表示了一个多级的资源，指的是git用户的git项目的某次提交记录，又例如/orders/2012/10能够用来表示2012年10月的订单记录。

使用?用来过滤资源

不少人只是把?简单的当作是参数的传递，很容易形成URI过于复杂、难以理解。能够把?用于对资源的过滤，例如/git/git/pulls用来表示git项目的全部推入请求，而/pulls?state=closed用来表示git项目中已经关闭的推入请求，这种URL一般对应的是一些特定条件的查询结果或算法运算结果。

,或;能够用来表示同级资源的关系

有时候咱们须要表示同级资源的关系时，可使用,或;来进行分割。例如哪天github能够比较某个文件在随意两次提交记录之间的差别，或许可使用/git/git /block-sha1/sha1.h/compare/e3af72cdafab5993d18fae056f87e1d675913d08;bd63e61bdf38e872d5215c07b264dcc16e4febca做为URI。不过，如今github是使用…来作这个事情的，例如/git/git/compare/master…next。

2.二、统一资源接口

RESTful架构应该遵循统一接口原则，统一接口包含了一组受限的预约义的操做，不论什么样的资源，都是经过使用相同的接口进行资源的访问。接口应该使用标准的HTTP方法如GET，PUT和POST，并遵循这些方法的语义。

若是按照HTTP方法的语义来暴露资源，那么接口将会拥有安全性和幂等性的特性，例如GET和HEAD请求都是安全的，不管请求多少次，都不会改变服务器状态。而GET、HEAD、PUT和DELETE请求都是幂等的，不管对资源操做多少次，结果老是同样的，后面的请求并不会产生比第一次更多的影响。

下面列出了GET，DELETE，PUT和POST的典型用法:

get

安全且幂等
获取表示
变动时获取表示（缓存）

200（OK） - 表示已在响应中发出

204（无内容） - 资源有空表示
301（Moved Permanently） - 资源的URI已被更新
303（See Other） - 其余（如，负载均衡）
304（not modified）- 资源未更改（缓存）
400 （bad request）- 指代坏请求（如，参数错误）
404 （not found）- 资源不存在
406 （not acceptable）- 服务端不支持所需表示
500 （internal server error）- 通用错误响应
503 （Service Unavailable）- 服务端当前没法处理请求

post

不安全且不幂等
使用服务端管理的（自动产生）的实例号建立资源
建立子资源
部分更新资源
若是没有被修改，则不过更新资源（乐观锁）

200（OK）- 若是现有资源已被更改

201（created）- 若是新资源被建立
202（accepted）- 已接受处理请求但还没有完成（异步处理）
301（Moved Permanently）- 资源的URI被更新
303（See Other）- 其余（如，负载均衡）
400（bad request）- 指代坏请求
404 （not found）- 资源不存在
406 （not acceptable）- 服务端不支持所需表示
409 （conflict）- 通用冲突
412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）
415 （unsupported media type）- 接受到的表示不受支持
500 （internal server error）- 通用错误响应
503 （Service Unavailable）- 服务当前没法处理请求

put

不安全但幂等
用客户端管理的实例号建立一个资源
经过替换的方式更新资源
若是未被修改，则更新资源（乐观锁）

200 （OK）- 若是已存在资源被更改

201 （created）- 若是新资源被建立
301（Moved Permanently）- 资源的URI已更改
303 （See Other）- 其余（如，负载均衡）
400 （bad request）- 指代坏请求
404 （not found）- 资源不存在
406 （not acceptable）- 服务端不支持所需表示
409 （conflict）- 通用冲突
412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）
415 （unsupported media type）- 接受到的表示不受支持
500 （internal server error）- 通用错误响应
503 （Service Unavailable）- 服务当前没法处理请求

delete

不安全但幂等
删除资源

200 （OK）- 资源已被删除

301 （Moved Permanently）- 资源的URI已更改
303 （See Other）- 其余，如负载均衡
400 （bad request）- 指代坏请求
404 （not found）- 资源不存在
409 （conflict）- 通用冲突
500 （internal server error）- 通用错误响应
503 （Service Unavailable）- 服务端当前没法处理请求

下面咱们来看一些实践中常见的问题:

post和put用于建立资源时有什么区别?

post和put在建立资源的区别在于，所建立的资源的名称(URI)是否由客户端决定。例如为个人博文增长一个java的分类，生成的路径就是分类名/categories/java，那么就能够采用PUT方法。不过不少人直接把post、get、put、delete直接对应上CRUD，例如在一个典型的rails实现的RESTful应用中就是这么作的。

我认为，这是由于rails默认使用服务端生成的ID做为URI的缘故，而很多人就是经过rails实践REST的，因此很容易形成这种误解。

客户端不必定都支持这些HTTP方法吧?

的确有这种状况，特别是一些比较古老的基于浏览器的客户端，只能支持get和post两种方法。

在实践上，客户端和服务端均可能须要作一些妥协。例如rails框架就支持经过隐藏参数_method=DELETE来传递真实的请求方法，而像Backbone这样的客户端MVC框架则容许传递_method传输和设置X-HTTP-Method-Override头来规避这个问题。

统一接口是否意味着不能扩展带特殊语义的方法?

统一接口并不阻止你扩展方法，只要方法对资源的操做有着具体的、可识别的语义便可，并可以保持整个接口的统一性。

像WebDAV就对HTTP方法进行了扩展，增长了LOCK、UPLOCK等方法。而github的API则支持使用PATCH方法来进行issue的更新，

例如：

PATCH /repos/:owner/:repo/issues/:number

2.三、资源的表述

　　上面提到，客户端经过HTTP方法能够获取资源，是吧? 不，确切的说，客户端获取的只是资源的表述而已。资源在外界的具体呈现，能够有多种表述(或成为表现、表示)形式，在客户端和服务端之间传送的也是资源的表述，而不是资源自己。例如文本资源能够采用html、xml、json等格式，图片可使用PNG或JPG展示出来。

资源的表述包括数据和描述数据的元数据，例如，HTTP头"Content-Type" 就是这样一个元数据属性。

那么客户端如何知道服务端提供哪一种表述形式呢?

答案是能够经过HTTP内容协商，客户端能够经过Accept头请求一种特定格式的表述，服务端则经过Content-Type告诉客户端资源的表述形式。

以github为例，请求某组织资源的json格式的表述形式:

假如github也可以支持xml格式的表述格式，那么结果就是这样的:

2.四、资源的连接

　　咱们知道REST是使用标准的HTTP方法来操做资源的，但仅仅所以就理解成带CURD的Web数据库架构就太过于简单了。

这种反模式忽略了一个核心概念："超媒体即应用状态引擎（hypermedia as the engine of application state）"。超媒体是什么?

当你浏览Web网页时，从一个链接跳到一个页面，再从另外一个链接跳到另一个页面，就是利用了超媒体的概念：把一个个把资源连接起来.

要达到这个目的，就要求在表述格式里边加入连接来引导客户端。在《RESTful Web Services》一书中，做者把这种具备连接的特性成为连通性。下面咱们具体来看一些例子。

下面展现的是github获取某个组织下的项目列表的请求，能够看到在响应头里边增长Link头告诉客户端怎么访问下一页和最后一页的记录。而在响应体里边，用url来连接项目全部者和项目地址。

又例以下面这个例子，建立订单后经过连接引导客户端如何去付款。

上面的例子展现了如何使用超媒体来加强资源的连通性。不少人在设计RESTful架构时，使用不少时间来寻找漂亮的URI，而忽略了超媒体。因此，应该多花一些时间来给资源的表述提供连接，而不是专一于"资源的CRUD"。

2.五、状态的转移

实际上，状态应该区分应用状态和资源状态，客户端负责维护应用状态，而服务端维护资源状态。

客户端与服务端的交互必须是无状态的，并在每一次请求中包含处理该请求所需的一切信息。

服务端不须要在请求间保留应用状态，只有在接受到实际请求的时候，服务端才会关注应用状态。

这种无状态通讯原则，使得服务端和中介可以理解独立的请求和响应。

在屡次请求中，同一客户端也再也不须要依赖于同一服务器，方便实现高可扩展和高可用性的服务端。

但有时候咱们会作出违反无状态通讯原则的设计，例如利用Cookie跟踪某个服务端会话状态，常见的像J2EE里边的JSESSIONID。

这意味着，浏览器随各次请求发出去的Cookie是被用于构建会话状态的。

固然，若是Cookie保存的是一些服务器不依赖于会话状态便可验证的信息（好比认证令牌），这样的Cookie也是符合REST原则的。

状态转移到这里已经很好理解了， "会话"状态不是做为资源状态保存在服务端的，而是被客户端做为应用状态进行跟踪的。客户端应用状态在服务端提供的超媒体的指引下发生变迁。服务端经过超媒体告诉客户端当前状态有哪些后续状态能够进入。

这些相似"下一页"之类的连接起的就是这种推动状态的做用——指引你如何从当前状态进入下一个可能的状态。