anjia / blog

博客,积累与沉淀
106 stars 4 forks source link

REST 规范 #82

Open anjia opened 4 years ago

anjia commented 4 years ago

REST 是一种架构风格的指导规范,并非具体技术的实现
不是框架,不是技术,不是设计思想,是一种混合式“架构风格”

网站即软件

如何开发在互联网环境中使用的软件?RESTful 架构就是一种互联网软件架构,它是以网络为基础的应用软件的架构设计。

起源

Roy Thomas Fielding 在他 2000 年的博士论文中提到:

我这篇文章的写作目的,就是想在符合架构原理的前提下,理解和评估以网络为基础的应用软件的架构设计,得到一个功能强、性能好、适宜通信的架构。

他对互联网软件的架构原则,定名为 REST,即 Representational State Transfer(表现层状态转化)(省略了主语“资源” Resources)

如果一个架构符合 REST 原则,则就称它为 RESTful 架构。

Resources 资源

所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。

所谓"上网",就是与互联网上一系列的"资源"互动,调用它的URI。

Representation 表现层

"资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。

URI只代表资源的实体,不代表它的形式。 比如,文本可以用txt格式表现,也可以用HTML格式、XML格式、JSON格式表现,甚至可以采用二进制格式;图片可以用JPG格式表现,也可以用PNG格式表现。

URI只代表资源的实体,不代表它的形式。严格地说,有些网址最后的".html"后缀名是不必要的,因为这个后缀名表示格式,属于"表现层"范畴,而URI应该只代表"资源"的位置。它的具体表现形式,应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是对"表现层"的描述。

HTTP Request Head 里的 Accept 和 Content-Type 字段描述了“表现层” URI 只标识“资源”的位置

State Transfer 状态转化

访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。

互联网通信协议HTTPs协议是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生"状态转化"(State Transfer)。而这种转化是建立在表现层之上的,所以就是"表现层状态转化"。

客户端用到的手段,只能是HTTP协议里四个表示操作方式的动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:

小结

REST 四个基本原则:

  1. 为每个资源设置 URI
  2. 无状态连接,服务器端不应保存过多上下文状态,即每个请求都是独立的
  3. 客户端通过四个 HTTP 动词,对服务器端资源进行操作,实现"表现层状态转化"
  4. 通过 JSON 进行数据传递

实现上述原则的架构即可称为 RESTFul 架构。

  1. 互联网环境下,任何应用的架构和 API 可以被快速理解
  2. 分布式环境下,任何请求都可以被发送到任意服务器
  3. 异构环境下,任何资源的访问和使用方式都统一

设计指南

  1. 域名
  2. 版本
  3. 路径:常常只有名词-且名词与数据库表名相对应-复数
  4. HTTP动词:操作资源的类型
    • GET: select
    • POST: create
    • PUT: update(客户端提供改变后的完整资源?)
    • PATCH: update(客户端提供改变的属性)
    • DELETE: delete
    • HEAD
    • OPTIONS
  5. 查询条件:即参数
    • ?limit=10&offset=10&pg=2&per_pg=10&sortby=name&order=desc&_id=1
  6. 状态码:完整见 Status Code Definitions
    • 1xx Informational
    • 2xx Successful
    • 3xx Redirection
    • 4xx Client Error
    • 5xx Server Error
  7. 错误信息
    • error: 'key'
  8. 返回结果对象
    • GET /collection:数组
    • GET /collection/resource:单个资源对象
    • POST /collection:新生成的资源对象
    • PUT /collection/resource:完整的资源对象
    • PATCH /collection/resource:完整的资源对象
    • DELETE /collection/resource:一个空文档
  9. Hypermedia API: HATEOAS

参考