您好, 欢迎来到 !    登录 | 注册 | | 设为首页 | 收藏本站

在REST API实际场景中使用PUT与PATCH方法

在REST API实际场景中使用PUT与PATCH方法

:当我第一次花时间阅读有关REST的知识时,幂等性是一个难以理解的概念。正如我进一步的评论(以及Jason Hoetger的答案)所显示的那样,我在原始答案中仍然没有完全正确。一段时间以来,我一直拒绝广泛地更新此答案,以避免有效地Ja窃Jason,但现在我正在对其进行编辑,因为有人要求我(在评论中)。

阅读我的答案后,建议您也阅读JasonHoetger对这个问题的出色答案,我将尝试使我的答案更好,而不仅仅是从Jason那里窃取。

正如您在RFC 2616引用中所指出的那样,PUT被认为是幂等的。当您放置资源时,这两个假设起作用了:

您指的是实体,而不是集合。

您要提供的实体已完成( 整个 实体)。

让我们来看一个例子。

{ "username": "skwee357", "email": "skwee357@domain.com" }

如果/users按照建议将文档发布到,则您可能会找回诸如

## /users/1

{
    "username": "skwee357",
    "email": "skwee357@domain.com"
}

如果以后要修改此实体,请在PUT和PATCH之间选择。一个PUT可能看起来像这样:

PUT /users/1
{
    "username": "skwee357",
    "email": "skwee357@gmail.com"       // new email address
}

您可以使用PATCH完成相同的操作。可能看起来像这样:

PATCH /users/1
{
    "email": "skwee357@gmail.com"       // new email address
}

您会立即注意到两者之间的差异。PUT包含该用户的所有参数,但是PATCH仅包含正在修改的参数(email)。

使用PUT时,假定您正在发送完整实体,并且该完整实体 将替换 该URI上的任何现有实体。在上面的示例中,PUT和PATCH实现了相同的目标:它们都更改了该用户的电子邮件地址。但是PUT通过替换整个实体来处理它,而PATCH仅更新所提供的字段,而其他字段则不予处理。

由于PUT请求包含整个实体,因此,如果您反复发出相同的请求,则它应始终具有相同的结果(您发送的数据现在是该实体的整个数据)。因此,PUT是幂等的。

如果在PUT请求中使用上述PATCH数据,会发生什么情况?

GET /users/1
{
    "username": "skwee357",
    "email": "skwee357@domain.com"
}
PUT /users/1
{
    "email": "skwee357@gmail.com"       // new email address
}

GET /users/1
{
    "email": "skwee357@gmail.com"      // new email address... and nothing else!
}

(出于这个问题的目的,我假设服务器没有任何特定的必填字段,并且将允许这种情况发生……实际上可能并非如此。)

由于我们使用了PUT,但仅提供了email,因此这是该实体中唯一的东西。这导致数据丢失。

此示例仅出于说明目的-切勿实际执行此操作。这个PUT请求在技术上是幂等的,但这并不意味着它不是一个糟糕的主意。

在上面的示例中,PATCH 幂等的。您进行了更改,但是如果一次又一次地进行相同的更改,它将始终返回相同的结果:您已将电子邮件地址更改为新值。

GET /users/1
{
    "username": "skwee357",
    "email": "skwee357@domain.com"
}
PATCH /users/1
{
    "email": "skwee357@gmail.com"       // new email address
}

GET /users/1
{
    "username": "skwee357",
    "email": "skwee357@gmail.com"       // email address was changed
}
PATCH /users/1
{
    "email": "skwee357@gmail.com"       // new email address... again
}

GET /users/1
{
    "username": "skwee357",
    "email": "skwee357@gmail.com"       // nothing changed since last GET
}

我最初有一些我认为表现出非幂等的例子,但它们具有误导性/错误性。我将保留这些示例,但使用它们来说明另一件事:针对同一个实体的多个PATCH文档,修改不同的属性,不会使PATCH成为非幂等的。

假设过去有一段时间,添加一个用户。这是您开始的状态。

{
  "id": 1,
  "name": "Sam Kwee",
  "email": "skwee357@olddomain.com",
  "address": "123 Mockingbird Lane",
  "city": "New York",
  "state": "NY",
  "zip": "10001"
}

进行PATCH之后,您拥有一个修改的实体:

PATCH /users/1
{"email": "skwee357@newdomain.com"}

{
  "id": 1,
  "name": "Sam Kwee",
  "email": "skwee357@newdomain.com",    // the email changed, yay!
  "address": "123 Mockingbird Lane",
  "city": "New York",
  "state": "NY",
  "zip": "10001"
}

如果您随后重复应用PATCH,您将继续获得相同的结果:电子邮件已更改为新值。A进去,A出来,因此这是幂等的。

一个小时后,当您去煮咖啡并休息一会后,其他人就会带上他们自己的PATCH。看来邮局已经进行了一些更改。

PATCH /users/1
{"zip": "12345"}

{
  "id": 1,
  "name": "Sam Kwee",
  "email": "skwee357@newdomain.com",  // still the new email you set
  "address": "123 Mockingbird Lane",
  "city": "New York",
  "state": "NY",
  "zip": "12345"                      // and this change as well
}

由于邮局发出的此PATCH本身与电子邮件无关,因此,如果重复使用邮政编码,则也将得到相同的结果:邮政编码设置为新值。A进去,A出来,因此这 也是 幂等的。

第二天,您决定再次发送PATCH。

PATCH /users/1
{"email": "skwee357@newdomain.com"}

{
  "id": 1,
  "name": "Sam Kwee",
  "email": "skwee357@newdomain.com",
  "address": "123 Mockingbird Lane",
  "city": "New York",
  "state": "NY",
  "zip": "12345"
}

您的补丁程序具有与昨天相同的效果:它设置了电子邮件地址。A进去了,A出来了,因此这也是幂等的。

我想划出一个重要的区别(我原来的回答有误)。许多服务器将通过发送回您修改的新实体状态来响应您的REST请求(如果有)。因此,当您收到此 答复时 ,它与昨天 收到的 答复 有所不同,因为邮政编码不是您上次收到的邮政编码。但是,您的请求与邮递区号无关,仅与电子邮件有关。因此,您的PATCH文档仍然是幂等的- 您在PATCH中发送的电子邮件现在是实体上的电子邮件地址。

要对该问题进行全面处理,我再次请您参考JasonHoetger的回答。我只想保留它,因为老实说我认为我不能比他已经更好地回答这部分。

其他 2022/1/1 18:15:28 有630人围观

撰写回答


你尚未登录,登录后可以

和开发者交流问题的细节

关注并接收问题和回答的更新提醒

参与内容的编辑和改进,让解决方法与时俱进

请先登录

推荐问题


联系我
置顶