RESTful

最新推荐文章于 2024-06-25 16:45:24 发布
最新推荐文章于 2024-06-25 16:45:24 发布
阅读量228 收藏 7
点赞数 3
分类专栏： Java学习 文章标签： RESTful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42452628/article/details/89840347
版权

RESTful

什么是REStful

REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中，Roy Fielding是HTTP规范的主要编写者之一。 他在论文中提到：“我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。REST指的是一组架构约束条件和原则。” 如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。

REST本身并没有创造新的技术、组件或服务，而隐藏在RESTful背后的理念就是使用Web的现有特征和能力， 更好地使用现有Web标准中的一些准则和约束。虽然REST本身受Web技术的影响很深， 但是理论上REST架构风格并不是绑定在HTTP上，只不过目前HTTP是唯一与REST相关的实例。 所以我们这里描述的REST也是通过HTTP实现的REST。

理解RESTful

要理解RESTful架构，需要理解Representational State Transfer这个词组到底是什么意思，它的每一个词都有些什么涵义。

下面我们结合REST原则，围绕资源展开讨论，从资源的定义、获取、表述、关联、状态变迁等角度，列举一些关键概念并加以解释。

  • 资源与URI
  • 统一资源接口
  • 资源的表述
  • 资源的链接
  • 状态的转移

速知

restful的http方法：GET、HEAD、POST、PUT、DELETE、OPTIONS、TRACE、PATCH

  1. GET
    安全、幂等；
    用于获取资源；
    eg:获得所有user列表

  2. HEAD
    安全、幂等；
    与get方法类似，但不返回message body内容，仅仅是获得获取资源的部分信息（content-type、content-length）；
    restful框架中较少使用

  3. POST
    非安全、非幂等；
    用于创建子资源
    eg:新增一个数据库不存在的user

  4. PUT
    非安全、幂等；
    用于创建、更新资源；
    eg:修改某个数据库已经存在的user信息

  5. DELETE
    非安全、幂等；
    删除资源；
    eg:删除某个user

  6. OPTIONS
    安全、幂等；
    用于url验证，验证接口服务是否正常；

  7. TEACE
    安全、幂等；
    维基百科“回显服务器收到的请求，这样客户端可以看到（如果有）哪一些改变或者添加已经被中间服务器实现。”
    restful框架中较少使用

  8. PATCH
    非安全、幂等；
    用于创建、更新资源，于PUT类似，区别在于PATCH代表部分更新；
    后来提出的接口方法，使用时可能去要验证客户端和服务端是否支持；

2. 1 资源与URI

REST全称是表述性状态转移，那究竟指的是什么的表述? 其实指的就是资源。任何事物，只要有被引用到的必要，它就是一个资源。资源可以是实体(例如手机号码)，也可以只是一个抽象概念(例如价值) 。下面是一些资源的例子：

  • 某用户的手机号码
  • 某用户的个人信息
  • 最多用户订购的GPRS套餐
  • 两个产品之间的依赖关系
  • 某用户可以办理的优惠套餐
  • 某手机号码的潜在价值

要让一个资源可以被识别，需要有个唯一标识，在Web中这个唯一标识就是URI(Uniform Resource Identifier)。

URI既可以看成是资源的地址，也可以看成是资源的名称。如果某些信息没有使用URI来表示，那它就不能算是一个资源， 只能算是资源的一些信息而已。URI的设计应该遵循可寻址性原则，具有自描述性，需要在形式上给人以直觉上的关联。这里以github网站为例，给出一些还算不错的URI：

下面让我们来看看URI设计上的一些技巧:

  • 使用_或-来让URI可读性更好

曾经Web上的URI都是冰冷的数字或者无意义的字符串，但现在越来越多的网站使用_或-来分隔一些单词，让URI看上去更为人性化。 例如国内比较出名的开源中国社区，它上面的新闻地址就采用这种风格， 如http://www.oschina.net/news/38119/oschina-translate-reward-plan。

  • 使用/来表示资源的层级关系

例如上述/git/git/commit/e3af72cdafab5993d18fae056f87e1d675913d08就表示了一个多级的资源， 指的是git用户的git项目的某次提交记录，又例如/orders/2012/10可以用来表示2012年10月的订单记录。

  • 使用?用来过滤资源

很多人只是把?简单的当做是参数的传递，很容易造成URI过于复杂、难以理解。可以把?用于对资源的过滤， 例如/git/git/pulls用来表示git项目的所有推入请求，而/pulls?state=closed用来表示git项目中已经关闭的推入请求， 这种URL通常对应的是一些特定条件的查询结果或算法运算结果。

  • ,或;可以用来表示同级资源的关系

有时候我们需要表示同级资源的关系时，可以使用,或;来进行分割。例如哪天github可以比较某个文件在随意两次提交记录之间的差异，或许可以使用/git/git /block-sha1/sha1.h/compare/e3af72cdafab5993d18fae056f87e1d675913d08;bd63e61bdf38e872d5215c07b264dcc16e4febca作为URI。 不过，现在github是使用…来做这个事情的，例如/git/git/compare/master…next。

2. 2 统一资源接口

RESTful架构应该遵循统一接口原则，统一接口包含了一组受限的预定义的操作，不论什么样的资源，都是通过使用相同的接口进行资源的访问。接口应该使用标准的HTTP方法如GET，PUT和POST，并遵循这些方法的语义。

如果按照HTTP方法的语义来暴露资源，那么接口将会拥有安全性和幂等性的特性，例如GET和HEAD请求都是安全的， 无论请求多少次，都不会改变服务器状态。而GET、HEAD、PUT和DELETE请求都是幂等的，无论对资源操作多少次， 结果总是一样的，后面的请求并不会产生比第一次更多的影响。

下面列出了GET，DELETE，PUT和POST的典型用法:

GET

  • 安全且幂等
  • 获取表示
  • 变更时获取表示（缓存）
  • 200（OK） - 表示已在响应中发出
  • 204（无内容） - 资源有空表示
  • 301（Moved Permanently） - 资源的URI已被更新
  • 303（See Other） - 其他（如，负载均衡）
  • 304（not modified）- 资源未更改（缓存）
  • 400 （bad request）- 指代坏请求（如，参数错误）
  • 404 （not found）- 资源不存在
  • 406 （not acceptable）- 服务端不支持所需表示
  • 500 （internal server error）- 通用错误响应
  • 503 （Service Unavailable）- 服务端当前无法处理请求

POST

  • 不安全且不幂等
  • 使用服务端管理的（自动产生）的实例号创建资源
  • 创建子资源
  • 部分更新资源
  • 如果没有被修改，则不过更新资源（乐观锁）
  • 200（OK）- 如果现有资源已被更改
  • 201（created）- 如果新资源被创建
  • 202（accepted）- 已接受处理请求但尚未完成（异步处理）
  • 301（Moved Permanently）- 资源的URI被更新
  • 303（See Other）- 其他（如，负载均衡）
  • 400（bad request）- 指代坏请求
  • 404 （not found）- 资源不存在
  • 406 （not acceptable）- 服务端不支持所需表示
  • 409 （conflict）- 通用冲突
  • 412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）
  • 415 （unsupported media type）- 接受到的表示不受支持
  • 500 （internal server error）- 通用错误响应
  • 503 （Service Unavailable）- 服务当前无法处理请求

PUT

  • 不安全但幂等
  • 用客户端管理的实例号创建一个资源
  • 通过替换的方式更新资源
  • 如果未被修改，则更新资源（乐观锁）
  • 200 （OK）- 如果已存在资源被更改
  • 201 （created）- 如果新资源被创建
  • 301（Moved Permanently）- 资源的URI已更改
  • 303 （See Other）- 其他（如，负载均衡）
  • 400 （bad request）- 指代坏请求
  • 404 （not found）- 资源不存在
  • 406 （not acceptable）- 服务端不支持所需表示
  • 409 （conflict）- 通用冲突
  • 412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）
  • 415 （unsupported media type）- 接受到的表示不受支持
  • 500 （internal server error）- 通用错误响应
  • 503 （Service Unavailable）- 服务当前无法处理请求

DELETE

  • 不安全但幂等
  • 删除资源
  • 200 （OK）- 资源已被删除
  • 301 （Moved Permanently）- 资源的URI已更改
  • 303 （See Other）- 其他，如负载均衡
  • 400 （bad request）- 指代坏请求
  • 404 （not found）- 资源不存在
  • 409 （conflict）- 通用冲突
  • 500 （internal server error）- 通用错误响应
  • 503 （Service Unavailable）- 服务端当前无法处理请求

如果GET请求增加计数器，这是否违反安全性?

安全性不代表请求不产生副作用，例如像很多API开发平台，都对请求流量做限制。像github，就会限制没有认证的请求每小时只能请求60次。

但客户端不是为了追求副作用而发出这些GET或HEAD请求的，产生副作用是服务端"自作主张"的。

另外，服务端在设计时，也不应该让副作用太大，因为客户端认为这些请求是不会产生副作用的。

  • 直接忽视缓存可取吗?

即使你按各个动词的原本意图来使用它们，你仍可以轻易禁止缓存机制。 最简单的做法就是在你的HTTP响应里增加这样一个报头： Cache-control: no-cache。 但是，同时你也对失去了高效的缓存与再验证的支持(使用Etag等机制)。

对于客户端来说，在为一个REST式服务实现程序客户端时，也应该充分利用现有的缓存机制，以免每次都重新获取表示。

  • 响应代码的处理有必要吗?

HTTP的响应代码可用于应付不同场合，正确使用这些状态代码意味着客户端与服务器可以在一个具备较丰富语义的层次上进行沟通。

例如，201（“Created”）响应代码表明已经创建了一个新的资源，其URI在Location响应报头里。

假如你不利用HTTP状态代码丰富的应用语义，那么你将错失提高重用性、增强互操作性和提升松耦合性的机会。

如果这些所谓的RESTful应用必须通过响应实体才能给出错误信息，那么SOAP就是这样的了，它就能够满足了。

3. 总结

现在广东XXX版本、XXX等项目中均使用传统的RPC、SOAP方式的Web服务，而移动南方基地XXXX项目的后台， 虽然采用了JSON格式进行交互，但还是属于RPC风格的。本文从资源的定义、获取、表述、关联、状态变迁等角度， 试图快速理解RESTful架构背后的概念。RESTful架构与传统的RPC、SOAP等方式在理念上有很大的不同，希望本文能对各位理解REST有所帮助。

详细内容可查看—>这 <—

Elv!s
关注
专栏目录
什么是RESTful接口风格
weixin_44976692的博客
01-14 2万+
本文将为您介绍RESTful的基本概念、设计原则以及实际应用中的一些技巧。通过本文，我们深入了解了RESTful接口风格的基本概念、设计原则以及一些实际应用的技巧。如果有任何问题或建议，欢迎在评论区留言。RESTful接口应该是统一的，资源的标识、资源的操作方式等都应该符合一致的设计原则。使用HTTP状态码来表示请求的结果，例如200表示成功，404表示未找到资源等。URI应该简洁、直观，使用名词表示资源，使用HTTP方法表示对资源的操作。资源是RESTful设计的核心，每个资源都有一个唯一的标识符。
面试官：你连RESTful都不知道我怎么敢要你？
热门推荐
dotNet全栈开发
11-06 17万+
干货，2019 RESTful最贱实践
RESTful API
weixin_46591816的博客
03-08 843
RESTful API
RESTful api
qq_40407998的博客
10-28 2729
官网 https://restfulapi.cn/ REST 是 Representational State Transfer的缩写，如果一个架构符合REST原则，就称它为RESTful架构 使用原因：RESTful 架构可以充分的利用 HTTP 协议的各种功能，是 HTTP 协议的最佳实践 RESTful API 是一种软件架构风格、设计风格，可以让软件更加清晰，更简洁，更有层次，可维护性更好 API 请求 1. HTTP 动词 GET： 读取（Read） POST： 新建（Create） PUT
Flask-RESTful 分析
示例和笔记
04-01 993
这段代码定义了三个Flask-RESTful资源类，每个类都只有一个GET方法，但它们在返回响应时有所不同。# 导入Flask-RESTful的Resource类# 定义一个名为Todo1的资源类，继承自flask_restful.Resource# 定义GET方法，当客户端发送GET请求时会调用这个方法# 返回一个字典{'task': 'Hello world'}，HTTP响应码默认为200 OK# 定义一个名为Todo2的资源类，继承自flask_restful.Resource。
二、Restful介绍
weixin_44597347的博客
12-20 956
REST（英文：Representational State Transfer，又称具象状态传输）是Roy Thomas Fielding博士于2000年在他的博士论文 中提出来的一种万维网软件架构风格，目的是便于不同软件/程序在网络（例如互联网）中互相传递信息。REST 的核心是可编辑的资源及其集合，用符合 Atom 文档标准的 Feed 和 Entry 表示。每个资源或者集合有一个惟一的 URI。系统以资源为中心，构建并提供一系列的 Web 服务。
restful
最新发布
LIUMINGHUA111的博客
06-25 219
参考网址 RESTful 架构详解 RESTful 风格（详细介绍 + 案例实现） 什么是REST风格? 什么是RESTFUL?（一篇全读懂） 掌握RESTful API：从入门到精通，全面解析Web开发的基石！ 理解RESTful架构 RESTful API 设计指南 RESTful API 最佳实践 What is REST? What is a REST API What is a REST API — RedHat 正确甄别API、REST API、RESTful API和Web Service之
RESTful 详解
wl_1013的博客
07-15 4万+
1. 什么是REST　　REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中，Roy Fielding是HTTP规范的主要编写者之一。 他在论文中提到：“我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强...
restFul命名
weixin_42613018的博客
01-05 194
REST (Representational State Transfer) 是一种软件架构风格，用于构建分布式系统。RESTful 命名法是 REST 架构中的一个规范，用于命名 API 中的资源(resource)和操作(operation)。 RESTful 命名法的基本原则是： 资源(resource)的名称应该用复数形式，如 users、books、articles。 对资源进行操作时...
RESTful 简介
salahi的专栏
03-29 784
REST（Representational State Transfer）是一种通过 HTTP 协议进行通信的软件架构风格，常用于 Web 应用程序的设计和开发。RESTful 是遵循 REST 原则的 Web API 的称谓，它提供了一组定义良好的操作（如 GET、POST、PUT、DELETE 等），通过这些操作对资源（如文件、图像、视频等）进行管理。
Java Restful Web 源代码，Java Restful Web 源代码
10-14
Java Restful Web 源代码Java Restful Web 源代码Java Restful Web 源代码Java Restful Web 源代码Java Restful Web 源代码Java Restful Web 源代码Java Restful Web 源代码Java Restful Web 源代码Java Restful Web...
基于Flask的RESTful API实战代码：集成Flask-SQLAlchemy与MySQL
03-25
项目概述：本项目是一个基于Python语言的实战项目，使用了Flask框架构建RESTful API。它集成了Flask-SQLAlchemy作为ORM工具与MySQL数据库进行交互。项目共包含39个文件，其中主要的Python脚本文件有23个，辅助配置...
.NET 作为客户端调用WEBAPI RESTFUL服务端以及如何开发RESTFUL服务端用于客户端调用
09-23
本篇文章将详细探讨.NET作为客户端调用WebAPI RESTful服务端的方法，以及如何开发RESTFUL服务端以供客户端调用。 首先，让我们了解一下客户端如何使用.NET调用WebAPI RESTful服务端。这通常涉及以下几个步骤： 1. ...
谷歌浏览器restful请求插件
02-23
**谷歌浏览器RESTful请求插件** 谷歌浏览器RESTful请求插件是开发人员在进行Web API测试、调试和接口文档编写时的重要工具。它允许用户直接在浏览器中发起HTTP请求，包括GET、POST、PUT、DELETE等RESTful操作，极大...
restful:RESTful的Drupal最佳实践
05-03
RESTful的Drupal最佳实践 该模块允许使用安全性，性能和可用性的最佳实践，通过RESTful HTTP请求来操作Drupal。 概念 以下是RESTful和其他模块（例如RestW和服务实体）之间的区别： RESTful需要明确声明公开的API。...
JAVA8之妙用Optional解决判断Null为空的问题
Elv1s的笔记
05-06 3878
JAVA8之妙用Optional解决判断Null为空的问题 详细看—>这<—
计算年龄的方法
Elv1s的笔记
09-29 1461
/** * 根据年月日计算年龄,birthTimeString:"1997-11-14" * @param birthTimeString * @return */ public static int getAgeFromBirthDay(String birthTimeString) { LocalDate date = Loc...
思考:SET为什么不能重复
Elv1s的笔记
08-20 1335
java/util/Set.java:225 , set的add方法. /** * Adds the specified element to this set if it is not already present * (optional operation). More formally, adds the specified element * <...
通过反射把Map中的值赋给Object
Elv1s的笔记
05-13 1125
public static void main(String[] args) throws Exception { Map<Object, Object> map = Maps.newHashMap(); map.put("name", "jason"); map.put("age", 19); map.put("home...
SpringBoot 2.0 实现RESTful API教程
在Spring Boot 2.0中实现RESTful服务，首先需要正确配置项目的`pom.xml`文件。在给出的`pom.xml`片段中，可以看到项目依赖于Spring Boot的父项目，版本为2.0.0.RELEASE。此外，还引入了以下依赖： 1. Lombok库（`...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值