RPC好,还是RESTful好?

Posted snakejia

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了RPC好,还是RESTful好?相关的知识,希望对你有一定的参考价值。

1. JSON-RPC

什么是JSON-RPC

JSON-RPC 2.0规范中定义

JSON-RPC是一个无状态且轻量级的远程过程调用(RPC)协议。本规范主要定义了一些数据结构及其相关的处理规则。它允许运行 
在基于socket,http等诸多不同消息传输环境的同一进程中。其使用JSON(RFC 4627)作为数据格式。

它为简单而生!

示例

// request
POST /work/addComment HTTP/1.1
HOST: api.example.com
Content-Type: application/json
{
   "work_id": 1,
   "conent":"Hello Yuan",
   "type":1
}

// response
{    
    "code":0,
    "msg":"success",
    "data":{}
}

2.Restful API

REST:REpresentational State Transfer = 直接翻译:表现层状态转移。这个中文直译经常出现在很多博客中。尼玛谁听得懂“表现层状态转移”?这是人话吗?【哥们,感同身受,这也是我最想说的话,憋了好久了。好多网上说的东西,说得好抽象,晦涩难懂。能不能具体点。】

首先,之所以晦涩是因为前面主语被去掉了,全称是 Resource Representational State Transfer:通俗来讲就是:资源在网络中以某种表现形式进行状态转移。

分解开来:

  • Resource:资源,即数据(前面说过网络的核心)。比如 newsfeed,friends等;
  • Representational:某种表现形式,比如用JSON,XML,JPEG等;
  • State Transfer:状态变化。通过HTTP动词实现。

http

GET /zoos:列出所有动物园
POST /zoos:新建一个动物园
GET /zoos/ID:获取某个指定动物园的信息
PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
DELETE /zoos/ID:删除某个动物园
GET /zoos/ID/animals:列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

filter

?limit=10:指定返回记录的数量
?offset=10:指定返回记录的开始位置。
?page=2&per_page=100:指定第几页,以及每页的记录数。
?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
?animal_type_id=1:指定筛选条件

code

200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
204 NO CONTENT - [DELETE]:用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

error

{
    error: "Invalid API key"
}

result

GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档

3.RPC好,还是RESTful好?

RESTful API浅谈

RESTful API 设计指南

RESTful API 设计最佳实践

大数据架构中使用JSON-RPC好,还是RESTful API好?

WEB开发中,使用JSON-RPC好,还是RESTful API好?

以上是关于RPC好,还是RESTful好?的主要内容,如果未能解决你的问题,请参考以下文章

“RPC好,还是RESTful好?”,这个问题不简单

面试:“RPC 好,还是 RESTful 好?” 不要选错了!

既然有 HTTP 请求,为什么还要用 RPC 调用?

在这种 SaaS 场景中,OAuth 是 RESTful API 的好选择吗?

RPC(Remote Procedure Call基于服务调用)和 RESTful(Representational State Transfer基于资源)通信协议异同?常见RPC和RESTful框架

RESTful API 设计约定