一、概括总结一下什么是RESTful架构:
(1)每一个URI代表一种资源;
(2)客户端和服务器之间,传递这种资源的某种表现层(Representation);
(3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。
二、名称
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用来删除资源。
六、返回状态码
错误码 | 描述 | 客户端解决方案 |
---|---|---|
400(Bad Request) | 当服务器由于语法错误无法解读请求时,返回该错误码。 | 查看错误表述的正文,了解问题的根本原因。 |
401(Unauthorized) | 当客户端无权访问资源,但在身份验证后可以获得访问权限时返回错误码。如果服务器就算是在身份验证后也不允许客户访问资源,那应该返回403(Forbidden)错误码。 返回该错误码时,应该包含一个带有身份验证方法的WWW-Authenticate头。通常使用的方法是Basic和Digest。 |
如果客户端是面向用户的,提示用户提供身份信息。其他情况下,获取必要的安全身份信息。用带有Authorization头的请求进行重试,其中包含了身份信息。 |
403(Forbidden) | 当服务器不让客户端获得资源的访问权限,就算通过身份验证也没用时,返回该错误码。 | 这个错误意味着禁止客户端用这个请求方法来访问资源,不要重复引起该错误的请求。 |
404(Not Found) | 当没有找到资源时返回该错误码。如有可能,在消息体中说明原因。 | 资源在服务器端已经不存在了。如果客户端保存了资源的数据,清楚数据或将其标记为已删除。 |
405(Not Allowed) | 当资源不允许使用某个HTTP方法时返回该错误码。返回一个Allow头,其中带有该资源的有效HTTP方法。 | 查看Allow头来寻找适用于该资源的方法,然后做适当的代码变更,只用那些方法来访问资源。 |
406(Not Acceptable) | 内容协商失败 | 调整Accept-*头 |
409(Conflict) | 当请求与资源的当前状态有冲突时返回该错误码,并包含一段正文解释原因。 | 查看PUT的表述正文中列出的冲突。 |
410(Gone) | 资源以前存在,但今后不会再存在,返回该错误码。 除非记录了被删除的资源,否则不能返回这个错误码。如果没有在服务器记录被删除的资源,应该用404(Not Found)取代。 |
将其等同于404(Not Found)。 |
412(Precondition Failed) | 条件请求失败 | HTTP 1.1允许客户端修改到期缓存、使用包含Cache-Control:no-Cache和Pragma:no-cache的无条件GET请求获取新鲜表述。之后进行后继处理。 |
413(Request Entity Too Large) | 当POST或PUT请求的消息体过大时返回该错误码。如有可能,在正文中说明允许哪些内容,提供一个备选方案。 | 在响应正文里寻找有效长度的提示。 |
414(Unsupported Media Type) | 当客户端用一种服务器不理解的格式来发送消息体时返回该错误。 | 在响应正文里了解请求支持的媒体类型。 |
500(Internal Server Error) | 由于某些实现上的问题,代码在服务器端失败时返回该错误码是最好的选择。 | 记录该错误日志,随后通知服务器开发者。 |
503(Service Unavailable) | 服务器在某个特定间隔或一段不确定的时间内无法完成请求时,返回该错误码。 抛出该错误的两个常见场合是后端服务器失败(例如数据库连接失败)或是客户端请求达到了某个服务器设定的频率上限。 如有可能,包含一个带日期或秒数的Retry-After响应头,用它的值来做提示。 |
如果响应中有Retry-After头,在到达时间之后进行重试。 |