如何使用 JSON Patch 增加价值?

Posted

技术标签:

【中文标题】如何使用 JSON Patch 增加价值?【英文标题】:How to increment value with JSON Patch? 【发布时间】:2020-05-01 13:20:54 【问题描述】:

我们需要通过 REST API 更新计数器,并且我们使用 JSON Patch 进行 PATCH 调用,所以它应该是这样的:

"op":"increment", "path":"/counter", "value": 1

问题是 JSON Patch 不支持这种类型的操作。 ADD 操作应该只适用于数组,因此最接近的解决方案是使用 REPLACE 操作来替换计数器值,但如果多个客户端同时尝试更新计数器,则可能会导致问题。

那么我们应该如何解决这个问题,添加像增量这样的自定义操作会有多大的错误?

【问题讨论】:

【参考方案1】:

问题是 JSON Patch 不支持这种类型的操作。 ADD 操作只适用于数组,因此最接近的解决方案是使用 REPLACE 操作来替换计数器值

replace 是正确答案。

如果多个客户端同时尝试更新计数器,可能会导致问题。

仔细查看test,它为您提供了描述前提条件所需的语义。实际上,您的文档变成了比较和交换的描述。

添加像增量这样的自定义操作会有多错?

一路走错。 RFC 6902 clearly states 操作集MUST NOT 被扩展

操作对象必须只有一个“op”成员,其值指示要执行的操作。它的值必须是“add”、“remove”、“replace”、“move”、“copy”或“test”之一;其他值是错误的。

当然,您可以定义一个包含所需运算符的新规范。但是您自己的虚荣补丁文档不会有那么多工具。

从更大的角度来看,如果您试图传达“增量”而不是“设置”,那么远程创作语义可能不是正确的选择——问题可能是试图告诉您您使用了错误的工具在你的手中。

【讨论】:

比较和交换如何工作?文件会是这样的吗? [ "op":"test","path":"counter","value":40, "op":"replace","path":"counter","value":41 ] 很像,是的。 添加不限于列表:““添加”操作执行以下功能之一,具体取决于目标位置引用的内容:如果目标位置指定数组索引,则为新值插入到数组中指定索引处。如果目标位置指定了一个尚不存在的对象成员,则向该对象添加一个新成员。如果目标位置指定一个确实存在的对象成员,则替换该成员的值。”来自 RFC。我了解对现有值进行的添加等同于替换。

以上是关于如何使用 JSON Patch 增加价值?的主要内容,如果未能解决你的问题,请参考以下文章

如何使用具有必填字段的 JSON 模式验证 http PATCH 数据

通过 PATCH 进行部分更新:如何解析 JSON 数据以进行 SQL 更新?

如何在文档库列中增加价值

如何从 appsettings.json 中获取价值

如何增加语义版本号?

如何使用 json 补丁更新集合