restful 简单理解

本文深入浅出地介绍了RESTful架构的基本概念,包括其起源、核心原则及如何正确设计RESTful API,同时澄清了一些常见的设计误区。

越来越多的人开始意识到,网站即软件,而且是一种新型的软件。

这种"互联网软件"采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时(high latency)、高并发等特点。

网站开发,完全可以采用软件开发的模式。但是传统上,软件和网络是两个不同的领域,很少有交集;软件开发主要针对单机环境,网络则主要研究系统之间的通信。互联网的兴起,使得这两个领域开始融合,现在我们必须考虑,如何开发在互联网环境中使用的软件。

图片2.jpg

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

 

但是,到底什么是RESTful架构,并不是一个容易说清楚的问题。

  REST究竟是什么?因为REST的内涵非常丰富,所以很难用一两句话解释清楚这个问题。

下面,我就谈谈我理解的RESTful架构。

一、起源

    REST这个词,是Roy Thomas Fielding在他2000年的博士论文中提出的。


 Fielding将他对互联网软件的架构原则,定名为 REST,即Representational State Transfer的缩写。我对这个词组的翻译是"表现层状态转化"。


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


图片1.jpg

Fielding是一个非常重要的人,他是HTTP协议(1.0版和1.1版)的主要设计者、Apache服务器软件的作者之一、Apache基金会的第一任主席。所以,他的这篇论文一经发表,就引起了关注,并且立即对互联网开发产生了深远的影响。

他这样介绍论文的写作目的:

"本文研究计算机科学两大前沿----软件和网络----的交叉点。长期以来,软件研究主要关注软件设计的分类、设计方法的演化,很少客观地评估不同的设计选择对系统行为的影响。而相反地,网络研究主要关注系统之间通信行为的细节、如何改进特定通信机制的表现,常常忽视了一个事实,那就是改变应用程序的互动风格比改变互动协议,对整体表现有更大的影响。我这篇文章的写作目的,就是想在符合架构原理的前提下,理解和评估以网络为基础的应用软件的架构设计,得到一个功能强、性能好、适宜通信的架构。"

二、名称

要理解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用来删除资源。

六、综述

综合上面的解释,我们总结一下什么是RESTful架构:

  (1)每一个URI代表一种资源;

  (2)客户端和服务器之间,传递这种资源的某种表现层;

  (3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。

七、 举个例子:

    Marcus是一个农民,他有4头猪,12只鸡和3头奶牛。他现在模拟一个REST API,而我是客户端。如果我想用REST来请求当前的农场状态,我仅会问:“State”Marcus会回答:“4头猪、12只鸡、3头奶牛


    这是REST最简单的一个例子。Marcus使用表征来传输农场状态。表征的句子很简单:“4头猪、12只鸡、3头奶牛


    再往下看,看我如何让MarcusREST方式添加2头奶牛?


    按照常理,可以会这样说Marcus,请在农场你再添加2头奶牛。难道这就是REST方式吗?难道就是通过这样的表征来传输状态的吗?不是的!这是一个远程过程调用,过程是给农场添加2头奶牛。


    Marcus很愤怒地响应到:“400Bad Request”,你到底是什么意思?


    所以,让我们重新来一次。我们怎样做到REST方式呢?该怎样重新表征呢?它应该是4头猪、12只鸡、3头奶牛。好,让我们再次重新表征……


    我:“Marcus……4头猪、12只鸡、5奶牛!

    Marcus好的

    我:“Marcus,现在是什么状态?

    Marcus“4头猪、12只鸡、5头奶牛

    我:好!


    看到了吗?就这样简单。

restful就是满足以下约束

使用客户/服务器模型。

     客户和服务器之间通过一个统一的接口来互相通讯。

 

 层次化的系统。

    在一个REST系统中,客户端并不会固定地与一个服务器打交道。

 

 无状态。

    在一个REST系统中,服务端并不会保存有关客户的任何状态。也就是说,客户端自身负责用户状态的维持,并在每次发送请求时都需要提供足够的信息。


可缓存。

    REST系统需要能够恰当地缓存请求,以尽量减少服务端和客户端之间的信息传输,以提高性能。

 

统一的接口。

    一个REST系统需要使用一个统一的接口来完成子系统之间以及服务与用户之间的交互。这使得REST系统中的各个子系统可以独自完成演化。


如果一个系统满足了上面所列出的五条约束,那么该系统就被称为是RESTful的。

、误区

RESTful架构有一些典型的设计误区。

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

  http://www.example.com/app/2.0/foo

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

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

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

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

(完)


RESTful API 是一种基于 REST(Representational State Transfer)架构风格设计的网络接口。REST 是一种用于分布式超媒体系统的架构风格,通常用于 Web 服务的设计和实现。它强调资源的可寻址性、无状态交互和统一接口,使得系统具有良好的可扩展性和可维护性[^1]。 ### 资源的可寻址性 在 RESTful 架构中,资源是核心概念。每个资源都有一个唯一的标识符(URI),客户端可以通过该 URI 访问资源。资源的标识符通常是 URL,例如 `https://api.example.com/users/1` 表示一个用户资源。这种设计使得资源可以通过标准的 HTTP 方法进行操作,如 GET、POST、PUT 和 DELETE。 ### 无状态交互 RESTful API 的另一个重要特性是无状态交互。每个请求都包含客户端需要的所有信息,服务器不会保存任何客户端的状态。这意味着每个请求都是独立的,服务器不需要依赖之前的请求来处理当前请求。这种设计提高了系统的可扩展性和可靠性[^1]。 ### 统一接口 RESTful API 使用统一的接口来简化客户端和服务器之间的交互。HTTP 协议提供了多种方法(如 GET、POST、PUT 和 DELETE)来操作资源。这些方法对应的操作分别是获取资源、创建资源、更新资源和删除资源。通过使用这些标准方法,客户端可以更容易地理解和使用 API。 ### 资源的表示 在 RESTful 架构中,资源的表示可以是多种格式,如 JSON、XML 或 HTML。客户端可以通过请求头中的 `Accept` 字段指定所需的格式,而服务器则通过响应头中的 `Content-Type` 字段返回相应的格式。这种灵活性使得 RESTful API 可以适应不同的客户端需求。 ### 示例代码 以下是一个简单RESTful API 示例,展示了如何使用 Python 的 Flask 框架创建一个基本的用户管理 API: ```python from flask import Flask, jsonify, request app = Flask(__name__) # 模拟用户数据 users = [ {'id': 1, 'name': 'Alice'}, {'id': 2, 'name': 'Bob'} ] # 获取所有用户 @app.route('/users', methods=['GET']) def get_users(): return jsonify(users) # 获取单个用户 @app.route('/users/<int:user_id>', methods=['GET']) def get_user(user_id): user = next((user for user in users if user['id'] == user_id), None) if user: return jsonify(user) else: return jsonify({'error': 'User not found'}), 404 # 创建新用户 @app.route('/users', methods=['POST']) def create_user(): new_user = request.get_json() users.append(new_user) return jsonify(new_user), 201 # 更新用户 @app.route('/users/<int:user_id>', methods=['PUT']) def update_user(user_id): updated_user = request.get_json() for user in users: if user['id'] == user_id: user.update(updated_user) return jsonify(user) return jsonify({'error': 'User not found'}), 404 # 删除用户 @app.route('/users/<int:user_id>', methods=['DELETE']) def delete_user(user_id): global users users = [user for user in users if user['id'] != user_id] return jsonify({'message': 'User deleted'}) if __name__ == '__main__': app.run(debug=True) ``` ### 相关问题 1. 如何在 RESTful API 中实现身份验证和授权? 2. RESTful API 和 SOAP API 有什么区别? 3. 如何测试 RESTful API 的功能和性能? 4. 如何设计 RESTful API 的错误处理机制? 5. 如何使用 Swagger 或其他工具文档化 RESTful API?
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值