RESTful Web 服务：教程

2023-01-09 08:26:21

RESTful Web 服务：教程

随着 REST 成为大多数 Web 和 Mobile 应用的默认选择，势必要对它的基本原理有所了解。

在它提出十多年后的今天，REST 已经成为最重要的 Web 应用技术之一。随着所有技术朝着 API 方向发展，它的重要性有可能持续快速地增长。每门主要编程语言现在已经包含构建 RESTful Web 服务的框架。同样地，Web 开发者和架构师对 REST 和 RESTful 服务有一个清晰的理解是很重要的。这篇教程解释了 REST 架构，然后研究使用它构建通用地基于API的任务的细节。

什么是 REST

REST 代表表述性状态转移（representational state transfer），它是一种网络化超媒体应用的架构风格。它主要是用于构建轻量级的、可维护的、可伸缩的 Web 服务。基于 REST 的服务被称为 RESTful 服务。REST 不依赖于任何协议，但是几乎每个 RESTful 服务使用 HTTP 作为底层协议。

RESTful 使用HTTP post（创建、更新）数据、读取数据、删除数据。使用HTTP实现CRUD（创建、读取、更新、删除）操作。

RESTful 服务特点：

每个系统都使用资源。这些资源可以是图片，视频文件，网页，商业信息，或者在基于计算机的系统中可以被代表的任何事物。服务的目的是提供一个窗口给客户端以便客户端能访问这些资源。服务架构师和开发人员想要这些服务变得易于实现、维护、扩展、伸缩。RESTful 架构允许这些，甚至更多。一般来说，RESTful 服务应该有下面的属性和特征，也就是我要详细描述的内容：

模型表示（Representations）
消息（Messages）
URIs
一致接口（Uniform interface）
（无状态）Stateless
资源之间的链接（Links between resources）
缓存（Caching）

模型表示（Representations）

RESTful 服务的焦点在资源上和怎么提供对资源的访问。资源很容易被认为和OOP中的对象一样。一个资源能由其他资源组成。当设计一个系统的时候，第一件要做的事情是定义资源和决定资源之间的关系。这有点像设计数据库的第一步。定义实体和关系。

一旦我们定义了资源，接下来我们需要找到一种用于在系统中表示这些资源的方法。你可以使用任何格式来表示资源。REST 对此没有限制。

例如，根据你的需求，你可以决定使用 JSON 或者 XML。如果你在构建 Web 服务，此服务用于 Web 页面中的 AJAX 调用，那 JSON 是很好地选择。 XML 可以用来表示比较复杂的资源。例如一个被称为“Person”的资源可以表示如下：

列表1：资源的JSON 表示。

{

    "ID": "1",

    "Name": "M Vaqqas",

    "Email": "m.vaqqas@gmail.com",

    "Country": "India"

}

列表2：资源的XML 表示。

<Person>

	<ID>1</ID>

	<Name>M Vaqqas</Name>

	<Email>m.vaqqas@gmail.com</Email>

	<Country>India</Country>

</Person>

实际上，你可以使用不止一种的格式并且决定使用其中哪一种用于依赖于客户端类型或一些请求参数的响应。无论使用哪个格式，好的模型表示（representation ）应该具有以下明显的特征：

客户端和服务端应该能够理解这种模型表示（representation ）的格式。
模型表示（representation ）应该能够完整的表示资源。如果需要表示部分资源，然后你需要考虑将资源分解成子资源。分割大资源到更小的资源同样允许你传递更小的表现。较小的模型表示（representation）意味着更少的时间来创建和传输。这也意味着更快的服务。
模型表示（representation）应该能够互相链接资源。可以通过替换 URI 或者是唯一 ID。

消息（Messages）

客户端和服务端经由消息相互沟通。客户端发送请求到服务器，服务器使用响应答复。除了实际的数据，这些信息也包含一些关于消息的元数据。对于设计 RESTful 服务了解 HTTP 1.1的请求格式和响应格式是很重要的。

HTTP 请求

图1中展示了HTTP请求格式。

图1：HTTP 请求格式

<VERB> GET, PUT, POST, DELETE, OPTIONS等等 HTTP 方法的一种。

<URI> 资源的URI。操作将在这个 URI 上执行。

<HTTP Version> HTTP 版本，通常是“HTTP v1.1”。

<Request Header> 包含 header 键值对集合的元数据。这些设置包含消息的信息和发送者像客户端的类型，客户端支持的格式，消息体的格式类型，响应的缓存设置，和许多信息。

<Request Body> 是实际的消息内容。在 RESTful 服务中，这就是消息中资源表示的位置。

在 HTML 消息中没有标签和标识标记区块的开始或结束。

列表三是简单的 POST 请求消息，这个请求想要插入一条新的 Person 资源。

列表3：简单 POST 请求

POST http://MyService/Person/

Host: MyService

Content-Type: text/xml; charset=utf-8

Content-Length: 123

<?xml version="1.0" encoding="utf-8"?>

<Person>

  <ID>1</ID>

  <Name>M Vaqqas</Name>

  <Email>m.vaqqas@gmail.com</Email>

  <Country>India</Country>

</Person>

列表4：GET 请求

GET http://www.w3.org/Protocols/rfc2616/rfc2616.html HTTP/1.1

Host: www.w3.org

Accept: text/html,application/xhtml+xml,application/xml; …

User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 …

Accept-Encoding: gzip,deflate,sdch

Accept-Language: en-US,en;q=0.8,hi;q=0.6

HTTP Response

图2展示了 HTTP 响应的格式：

图2：HTTP 响应格式。

服务器返回 <response code>，<response code>包含请求的状态。<response code>通常是三位数字的HTTP状态码（3-digit HTTP status code）。

<Response Header> 包含关于响应消息的元数据和设置。

<Response Body> 包含如果请求成功的模型表示（representation）。

列表5是我从清单三的请求中得到的真实响应。

列表5：真实的 GET 请求的响应。

HTTP/1.1 200 OK

Date: Sat, 23 Aug 2014 18:31:04 GMT

Server: Apache/2

Last-Modified: Wed, 01 Sep 2004 13:24:52 GMT

Accept-Ranges: bytes

Content-Length: 32859

Cache-Control: max-age=21600, must-revalidate

Expires: Sun, 24 Aug 2014 00:31:04 GMT

Content-Type: text/html; charset=iso-8859-1

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns='http://www.w3.org/1999/xhtml'>

<head><title>Hypertext Transfer Protocol -- HTTP/1.1</title></head>

<body>

...

响应码 200 OK 表示一切正常，并且消息体包含我请求的有效的模型表示（representation）。在这个例子中，模型表示（representation）是 HTML 文档，HTML 文档是通过在响应头中的 Content-Type 声明地。在这个消息中的 header 是不解自明地，但是我将会在接下来的文章中讨论他们中的一些。这有很多其他属性。你可以使用叫Fiddle的免费工具抓取调试这些HTTP请求和响应。

资源定位

REST 要求每个资源至少有一个 URI。 RESTful 服务使用人类可读的URIs层级目录来定位资源。URI 要做的工作是定义一个资源或资源集合。实际的操作由 HTTP 动作决定。URI 应该没有任何关于处理和动作的内容。这使我们能够调用相同的 URI 使用不同的 HTTP 动词来执行不同的操作。

假设我们有一个 person 的数据库并且我们希望通过服务器暴露给外部。Person 资源可以像下面这样被定位到：

http://MyService/Persons/1

此URL遵循格式：Protocol://ServiceName/ResourceType/ResourceID

对于构建良好的 URIs 这有些重要的推荐：

使用复数名词命名你的资源。
避免使用制造混乱的空格。使用_或者-代替。
URI 不区分大小写。为了更清晰我使用驼峰写法。你也可以使用全部小写的URIs。
你也能够有你自己的约定，但是要在整个服务保持一致。确保你的客户端都知道这个约定。你的客户端 URIs 程序构建将更简单如果它们知道你遵循的资源层级和URI约定。
好的 URI 是不会变更的。再决定服务的 URIs 之前要先思考思考。如果你需要改变资源的定位，不要放弃老的 URI。如果请求来自老的 URI，使用状态码300重定向客户端到新的location。
避免使用动词命名你的资源直到你的资源是一个实际地操作或过程。动词更加适合操作的命名。例如，RESTful 服务不应该有 http://MyService/FetcthPerson/1 或 http://MyService/DeletePerson?id=1 类似的 URI。

URI中的查询参数

前面的URI是用查询参数帮助构建的。

http://MyService/Persons?id=1

查询参数方法运行良好而且 REST 不会阻止你使用查询参数。然而，这种方式有一些劣势：

增加了复杂性，降低了可读性。如果你使用更多的参数问题会更加明显。
像Google这样的搜索引擎爬网程序和索引器忽略uri查询参数。如果你正在进行Web开发，这是你的Web服务一部分很大的劣势，导致搜索引擎屏蔽。

查询参数的基本目的是提供参数给需要的数据项的操作。例如，如果你想要模型表示（presentation）格式由客户端决定，你可以通过参数实现像下面这样。

http://MyService/Persons/1?format=xml&encoding=UTF8

或

http://MyService/Persons/1?format=json&encoding=UTF8

包含format和encoding参数的父子层级URI看上去逻辑上不正确因为它们没有这种关系。

http://MyService/Persons/1/json/UTF8

查询参数也允许可选参数。在URI中显然是不可能的。你仅仅应该在提供参数值给处理过程的时候使用。

统一接口

RESTful应该有统一接口。HTTP 1.1 提供了一系列方法，被称为动作。在这其中比较重要的动作是：

<img src="//bbsmax.ikafan.com/static/L3Byb3h5L2h0dHBzL3BpYzEuemhpbWcuY29tLzA1OTQ3ZThkYmRmMGZmNDgxNTE5MTYyNGVmZDM4ZjIwX2IucG5n.jpg" data-rawwidth="664" data-rawheight="249" class="origin_image zh-lightbox-thumb" width="664" data-original="https://pic1.zhimg.com/05947e8dbdf0ff4815191624efd38f20_r.png"> RESTful Web 服务：教程

安全的操作是指对原始资源值不会产生影响的操作。列如，数学上的操作除以1就是安全的操作，因为无论多少次用1除一个数，原始数值都不会改变。幂等操作是指无论多少次执行都给出相同结果的操作。例如，数学上的乘以0就是幂等的，因为无论计算多少次结果都是零，结果都是一样的。类似的，一个安全的HTTP方法不会使服务器上的资源发生变化。一个幂等的HTTP方法无论执行多少次都会有相同的响应。把方法分类成安全和幂等的可以使客户端在不稳定的Web环境中再次触发相同的请求的结果变得更可预测。

在 Web 上 GET 可能是最流行的方法。它用来获取资源。

HEAD 仅返回响应头和空的响应体。这个方法可以用在你不需要全部的资源模型表示（representation）的时候。例如，HEAD 可以快速检测服务器上的资源是否存在。

OPTIONS 用于获取资源允许的操作。例如，思考下面的请求：

OPTIONS http://MyService/Persons/1 HTTP/1.1

HOST: MyService

在服务验证之后请求返回下面内容：

200 OK

Allow: HEAD, GET, PUT

第二行包含客户端可以使用的方法。

你应该仅仅出于它们的实际意义使用这些方法。例如：绝不要使用 GET 在服务器上创建或删除资源。如果你没这样做，将会扰乱你的客户端导致他们做出意外的操作。举例说明，然我们考虑下面的请求：

GET http://MyService/DeletePersons/1 HTTP/1.1

HOST: MyService

根据 HTTP 1.1 规范，GET 请求的目的是从服务器获取资源。但是它很容易实现一个删除 Person 的请求。这个请求也许运行的很棒，但是这不是RESTful 设计。换言之，使用 DELETE 方法来删除资源像下面这样：

DELETE http://MyService/Persons/1 HTTP/1.1

HOST: MyService

REST 建议统一接口，HTTP 提供了统一接口。然而，这由服务架构师和开发人员保持它的统一。

PUT 和 POST 的区别

对于这两个方法我提供了几乎相同的简短描述。这两个方法困扰着许多开发人员。所以让我们单独地讨论他们。

PUT 和 POST 的关键不同在于 PUT 是幂等的，而 POST 不是。

另一个不同，使用 PUT 你需要定义资源完整的 URI。这意味着客户端能构造资源的URI哪怕资源不存在于服务器上。客户端选择资源唯一的名字或 ID 是可能的。就像在服务器上创建一个用户需要客户端选择用户 ID。如果客户端不能猜测出资源完整的URI，你别无选择，只能使用 POST。

<img src="//bbsmax.ikafan.com/static/L3Byb3h5L2h0dHBzL3BpYzQuemhpbWcuY29tL2Y4YThiZDRjNThjZmQ3ZDUzZmIzYmE3ZjM2NmY2YzkzX2IucG5n.jpg" data-rawwidth="743" data-rawheight="179" class="origin_image zh-lightbox-thumb" width="743" data-original="https://pic4.zhimg.com/f8a8bd4c58cfd7d53fb3ba7f366f6c93_r.png"> RESTful Web 服务：教程

很明显，PUT 请求不会修改或创建超过一个资源，无论触发多少次（如果URI相同）。当资源存在时 PUT 和 POST 是没有区别的，都是更新已存在资源。第三个请求（POST http://MyService/Persons/）会在每次触发都创建资源。许多开发人员认为 REST 不允许 POST 被用于更新操作。然而，REST 并没有这样的限制。

无状态

RESTful 服务是无状态的并且不会为任何客户端保持状态。一个请求不应该依赖过去的请求，服务对待每个请求都是独立的。HTTP 是无状态协议的设计，你需要做一些额外的事情实现状态服务。使用当前的技术真的很容易实现状态服务。我们需要清楚的理解无状态和有状态设计以便我们避免误解。

无状态设计像这样：

Request1: GET http://MyService/Persons/1 HTTP/1.1

Request2: GET http://MyService/Persons/2 HTTP/1.1

每个请求都能被单独对待。

有状态设计，像这样：

Request1: GET http://MyService/Persons/1 HTTP/1.1

Request2: GET http://MyService/NextPerson HTTP/1.1

为了处理第二个请求，服务器需要记住客户端最后获取的 PersonID。换句话说，服务器需要记住当前状态————否则请求2无法处理。设计你的服务的方式是一个请求绝不要涉及前一个请求。无状态服务更容易集群，更容易维护，更容易伸缩。这样的服务提供了更好的响应时间，因为它们能容易的负载均衡。

资源之间的链接

资源模型表示（representation ）可以包含其他资源的链接就像 HTML 页面包含到其他页面的链接一样。被服务返回的模型表示（representations ）应该能驱动处理流就像网站的情况一样。当访问网站的时候，首先是索引页面，单击其中的一个链接跳转到另外一个页面等等。

让我们考虑下客户端请求一个包含许多其他资源的资源。替代输入所有资源，你可能会列出资源的链接。

例如，如果多个Person是Club的一部分，那么Club能像列表6中一样表示。

列表6：Club

<Club>

	<Name>Authors Club</Name>

	<Persons>

		<Person>

			<Name>M. Vaqqas</Name>

			<URI>http://MyService/Persons/1</URI>

		</Person>

		<Person>

			<Name>S. Allamaraju</Name>

			<URI>http://MyService/Persons/12</URI>

		</Person>

	</Persons>

</Club>

缓存

缓存是存贮生成结果的概念，使用存储结果替代在不久的将来重复的请求生成的结果。缓存可以在客户端、服务端或者他们之间的任何组件上完成，比如代理服务器。缓存是提升服务器性能的很棒的方法。但如果不妥善处理,会导致客户端使用失效的结果。

缓存可以由下面的HTTP头控制：

<img src="//bbsmax.ikafan.com/static/L3Byb3h5L2h0dHBzL3BpYzIuemhpbWcuY29tLzNlYTIxNzIzNjRiYzA3YzA2MThmNmYwYTY0MmNiMjVkX2IucG5n.jpg" data-rawwidth="553" data-rawheight="222" class="origin_image zh-lightbox-thumb" width="553" data-original="https://pic2.zhimg.com/3ea2172364bc07c0618f6f0a642cb25d_r.png"> RESTful Web 服务：教程

这些头部的值可以组合起来用在Cache-Control指令中来检查缓存结果是否有效。最通用的用于Cache-Control的指令如下：

<img src="//bbsmax.ikafan.com/static/L3Byb3h5L2h0dHBzL3BpYzIuemhpbWcuY29tLzMzNGE2NzM0NmQzNzI5MDUyZDQ1MGQ3ZGI4YWVkOWE5X2IucG5n.jpg" data-rawwidth="747" data-rawheight="439" class="origin_image zh-lightbox-thumb" width="747" data-original="https://pic2.zhimg.com/334a67346d3729052d450d7db8aed9a9_r.png"> RESTful Web 服务：教程

服务决定这些头和指令的值是根据资源的特性。

文档化 RESTful 服务

RESTful 服务不必包含用于帮助客户端发现它的文档。因为URIs、链接、统一接口，在运行时极其容易发现 RESTful 服务。客户端仅需要简单地知道服务的基础地址，并且从这个地址客户端通过遍历资源正在使用的链接就能发现服务。OPTION 方法能被有效地用在发现服务的处理过程中。

这不意味着 RESTful 服务一点也不需要文档化。没有理由不文档化你的服务。你应该为开发人员和客户端文档化每个资源和URI。你可以用任何格式构建你的文档，但是它应该包含足够关于资源、URIs、可用方法的信息，和其他需要访问你的服务使用的信息。下面的 table 是我的 MyService 的简单文档。这个简单短小的文档包含了 MyService 的各方面并且足够开发一个客户端。

Service Name：MyService

Address: http://MyService/

<img src="//bbsmax.ikafan.com/static/L3Byb3h5L2h0dHBzL3BpYzIuemhpbWcuY29tLzNlNzM0N2UyMmJhMTk0NmJjMmU3OTBiYmUxYTNmNDc1X2IucG5n.jpg" data-rawwidth="760" data-rawheight="348" class="origin_image zh-lightbox-thumb" width="760" data-original="https://pic2.zhimg.com/3e7347e22ba1946bc2e790bbe1a3f475_r.png"> RESTful Web 服务：教程

你也可以文档化每个资源的模型表示（representations ）并且提供一些简单的模型表示（representations ）。

结论

开发轻量级的 Web 服务 REST 是极好的方法，容易实现，维护、暴露开放。HTTP 提供了卓越的接口来实现 RESTful 服务，比如统一接口和缓存。然而，那要开发人员正确地实现和利用这些特性。如果我们对基础有了正确地理解，那么使用现有的技术比如Python、.net、java实现REST服务是很容的。我希望这篇文章为你开始开发你自己的RESTful服务提供了足够的信息。