REST api架构

最新推荐文章于 2024-06-23 13:56:24 发布

@航空母舰

最新推荐文章于 2024-06-23 13:56:24 发布

阅读量341

点赞数

分类专栏：设计模式文章标签： json php javascript ViewUI

本文链接：https://blog.csdn.net/hudeyong926/article/details/99540535

版权

设计模式专栏收录该内容

7 篇文章 0 订阅

订阅专栏

RESTful架构，就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。

REST优势

REST改善了用户接口跨多个平台的可移植性，并且通过简化服务器组件，改善了系统的可伸缩性。最为关键的是通过分离用户接口和数据存储这两个关注点，使得不同用户终端享受相同数据成为了可能。

1. 无状态性

无状态性是在客户－服务器约束的基础上添加的又一层规范。他要求通信必须在本质上是无状态的，即从客户到服务器的每个request都必须包含理解该request所必须的所有信息。这个规范改善了系统的可见性（无状态性使得客户端和服务器端不必保存对方的详细信息，服务器只需要处理当前 request，而不必了解所有的request历史），可靠性（无状态性减少了服务器从局部错误中恢复的任务量），可伸缩性（无状态性使得服务器端可以很容易的释放资源，因为服务器端不必在多个request中保存状态）。同时，这种规范的缺点也是显而易见得，由于不能将状态数据保存在服务器上的共享上下文中，因此增加了在一系列request中发送重复数据的开销，严重的降低了效率。

2. 缓存

为了改善无状态性带来的网络的低效性，我们填加了缓存约束。缓存约束允许隐式或显式地标记一个response中的数据，这样就赋予了客户端缓存 response数据的功能，这样就可以为以后的request共用缓存的数据，部分或全部的消除一部分交互，增加了网络的效率。但是用于客户端缓存了信息，也就同时增加了客户端与服务器数据不一致的可能，从而降低了可靠性。

B/S架构的优点是其部署非常方便，但在用户体验方面却不是很理想。为了改善这种情况，我们引入了REST. REST在原有的架构上增加了三个新规范：统一接口，分层系统和按需代码。

3. 统一接口

REST架构风格的核心特征就是强调组件之间有一个统一的接口，这表现在REST世界里，网络上所有的事物都被抽象为资源，而REST就是通过通用的链接器接口对资源进行操作。这样设计的好处是保证系统提供的服务都是解耦的，极大的简化了系统，从而改善了系统的交互性和可重用性。并且REST针对 Web的常见情况做了优化，使得REST接口被设计为可以高效的转移大粒度的超媒体数据，这也就导致了REST接口对其它的架构并不是最优的。

4. 分层系统

分层系统规则的加入提高了各种层次之间的独立性，为整个系统的复杂性设置了边界，通过封装遗留的服务，使新的服务器免受遗留客户端的影响，这也就提高了系统的可伸缩性。

5. 按需代码

REST允许对客户端功能进行扩展。比如，通过下载并执行applet或脚本形式的代码，来扩展客户端功能。但这在改善系统可扩展性的同时，也降低了可见性。所以它只是REST的一个可选的约束。

REST规范接口

每个资源都有对应的URI，不同的HTTP Method对应的对资源不同的操作，GET（读取资源信息）、POST（添加资源）、PUT（更新资源信息）、DELETE（删除资源）。几乎所有的计算机语言都可以通过HTTP协议同REST服务器通信。

GET /tickets # 获取ticket列表
GET /tickets/12 # 查看某个具体的ticket
POST /tickets # 新建一个ticket
PUT /tickets/12 # 更新ticket 12.
DELETE /tickets/12 #删除ticekt 12

如果关系依托于另外一个资源，Restful原则提供了很好的指导原则。让我们来看一个例子。SupportFu的一个ticket包含许多消息（message）。这些消息逻辑上与/tickets接入点的映射关系如下：

GET /tickets/12/messages - 获取ticket #12下的消息列表
GET /tickets/12/messages/5 - 获取ticket #12下的编号为5的消息
POST /tickets/12/messages - 为ticket #12创建一个新消息
PUT /tickets/12/messages/5 - 更新ticket #12下的编号为5的消息
PATCH /tickets/12/messages/5 - 部分更新ticket #12下的编号为5的消息
DELETE /tickets/12/messages/5 - 删除ticket #12下的编号为5的消息

结果过滤，排序和搜索

GET /tickets?sort=-priority - 获取票据列表，按优先级字段降序排序

场景：

A:http://www.nowamagic.net/articles
B:http://www.nowamagic.net/articles/{id}

A网址：GET方法：显示全部用户信息；同时有个POST方法，用来添加用户；

B网址：GET方法：显示当前用户信息；PUT方法：更新用户信息；DELETE方法：删除该用户信息。

注意RESTClient form的enctype属性x-www-form-urlencoded，form-data 是文件上传

最常见的一种设计错误，就是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

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

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

二、处理返回值。返回值要么是JSON格式，要么是XML格式。

PHP如何获取rest的HTTP的请求PUT或DELETE的数据

$method = $_SERVER['REQUEST_METHOD']; //请求
$rawbody = file_get_contents("php://input");
$form = json_decode($rawbody, true); //数据

前端 MVC 框架支持

在 AngularJS 中原生提供了 RESTful 的操作接口。也可以用Jquery的Ajax,浏览器支持不好

//注意：Jquery其它HTTP请求方法，如PUT和DELETE 也可以使用，但仅部分浏览器支持。
//getOne or delete
$.ajax({
    url:'/api/work/1',
    type:"GET", //DELETE
    success:function(data) {
      console.log(data);
    },
    error:function (xhr, ajaxOptions, thrownError){
      console.log(xhr.responseText);
    } 
  });

var postData = {
    "title": "title31",
    "author_id": "31",
    "content": "content31",
    "create_time": "2013-08-20 09:23:14"
};
//create or update
$.ajax({
    url:'/api/work',
    data:JSON.stringify(postData)
    type:"POST", //PUT
    success:function(data) {
        console.log(data);
    },
    error:function (xhr, ajaxOptions, thrownError){
        console.log(xhr.responseText);
    } 
});

sfsd