jsonpatch介绍

向右看齐 2021-06-22 15:38 589阅读 0赞

### 什么是JSON Patch？ ###

JSON Patch是一种用于描述对JSON文档所做的更改的格式（JSON Patch本身也是JSON结构）。当只更改了一部分时，可用于避免发送整个文档。可以与HTTP PATCH方法结合使用时，它允许以符合标准的方式对HTTP API进行部分更新。

JSON Patch是在IETF的[RFC 6902][]中指定的。如果了解过linux上的diff、patch，就非常容易理解JSON Patch了，前者是针对普通文本文件的，后者是指针对JSON结构。（前者更通用）

*  官网：[http://jsonpatch.com/][http_jsonpatch.com]
 *  github：[https://github.com/dharmafly/jsonpatch.com][https_github.com_dharmafly_jsonpatch.com]

看一个示例：

原始json：

{
      "baz": "qux",
      "foo": "bar"
    }

patch：

[
      { "op": "replace", "path": "/baz", "value": "boo" },
      { "op": "add", "path": "/hello", "value": ["world"] },
      { "op": "remove", "path": "/foo" }
    ]

结果：

{
      "baz": "boo",
      "hello": ["world"]
    }

### JSON Patch工作原理 ###

JSON Patch是一个包含了一系列补丁操作的JSON文件，JSON修补程序支持的修补程序操作为“add”，“remove”，“replace”，“move”，“copy”和“test”。按顺序应用这些操作：如果其中任何一个失败，则整个补丁操作应中止。

**1、JSON Pointer：**

JSON Pointer（[IETF RFC 6901][]）定义了一种字符串格式，用于标识JSON文档中的特定值。 JSON Patch中的所有操作都使用它来指定要操作的文档部分。

1）JSON Point是一串由“/”分隔的字符串，这些令牌要么指定对象中的键，要么指定数组的索引。例如，给定json：

{
      "biscuits": [
        { "name": "Digestive" },
        { "name": "Choco Leibniz" }
      ]
    }

*  /biscuits：指向了数组biscuits；
 *  /biscuits/1/name：指向了值"Choco Leibniz".

2）使用空字符串指向json的root节点，不能使用“/”，因为“/”指向了root节点下的一个“”key。

3）可以使用“-”指向数组的最后元素，例如：/biscuits/-

**2、Operations：**

在JSON Patch中包含了add、remove、replace、copy、move、test五种操作。

### JSON Patch 库 ###

目前JSON Patch支持多种开发语言。在使用前需要检查该库是否支持RFC版本的JSON Patch，因为与早期的草稿版本有所不同，并且在撰写本文时，并非所有库都已更新。

**JavaScript**

*  [jsonpatch.js][]
 *  [jsonpatch-js][]
 *  [jiff][]
 *  [Fast-JSON-Patch][]
 *  [JSON8 Patch][]
 *  [JSON Patch Utils][]

**Python**

*  [python-json-patch][]

**PHP**

*  [json-patch-php][]
 *  [php-jsonpatch/php-jsonpatch][php-jsonpatch_php-jsonpatch]
 *  [xp-forge/json-patch][xp-forge_json-patch]
 *  [JSONPatch][]
 *  [swaggest/json-diff][swaggest_json-diff]

**Ruby**

*  [json\_tools][json_tools]
 *  [json\_patch][json_patch]
 *  [hana][]

**Perl**

*  [perl-json-patch][]

**C**

*  [cJSON][] (JSON library in C, includes JSON Patch support in cJSON\_Utils)

**Java**

*  [zjsonpatch][] （推荐）
 *  [json-patch][]   （推荐）
 *  [bsonpatch][] (port of **zjsonpatch** that uses [BSON][] as document model)

**Scala**

*  [diffson][]

**C++**

*  [JSON for Modern C++][JSON for Modern C]
 *  [jsoncons][]

**C\#**

*  [Asp.Net Core JsonPatch][] (Microsoft official implementation)
 *  [Ramone][] (a framework for consuming REST services, includes a JSON Patch implementation)
 *  [JsonPatch][] (Adds JSON Patch support to ASP.NET Web API)
 *  [Starcounter][] (In-memory Application Engine, uses JSON Patch with OT for client-server sync)
 *  [Nancy.JsonPatch][] (Adds JSON Patch support to NancyFX)
 *  [Manatee.Json][] (JSON-everything, including JSON Patch)

**Go**

*  [json-patch][json-patch 1]
 *  [jsonpatch][]

**Haskell**

*  [Haskell-JSON-Patch][]

**Erlang**

*  [json-patch.erl][]

**Elm**

*  [norpan/elm-json-patch][norpan_elm-json-patch]

### 工具 ###

*  [JSON-Gui][]
 *  [json-patch-builder-online][] （推荐）
 *  [json-lab-patcher][]
 *  [JSONBuddy editor][]

### 应用 ###

通过JSON Patch可以获取两个json文档的diff信息，并且可以将这个diff信息作为patch应用到其中一个json文档中。例如：[https://www.thinbug.com/q/48436801][https_www.thinbug.com_q_48436801]

[RFC 6902]: http://tools.ietf.org/html/rfc6902
[http_jsonpatch.com]: http://jsonpatch.com/
[https_github.com_dharmafly_jsonpatch.com]: https://github.com/dharmafly/jsonpatch.com
[IETF RFC 6901]: http://tools.ietf.org/html/rfc6901
[jsonpatch.js]: http://jsonpatchjs.com/
[jsonpatch-js]: http://bruth.github.com/jsonpatch-js/
[jiff]: https://github.com/cujojs/jiff
[Fast-JSON-Patch]: https://github.com/Starcounter-Jack/Fast-JSON-Patch
[JSON8 Patch]: https://github.com/JSON8/patch
[JSON Patch Utils]: https://github.com/MarketsWorld/json-patch-utils
[python-json-patch]: https://github.com/stefankoegl/python-json-patch
[json-patch-php]: https://github.com/mikemccabe/json-patch-php
[php-jsonpatch_php-jsonpatch]: https://github.com/raphaelstolt/php-jsonpatch
[xp-forge_json-patch]: https://github.com/xp-forge/json-patch
[JSONPatch]: https://github.com/gamringer/JSONPatch
[swaggest_json-diff]: https://github.com/swaggest/json-diff
[json_tools]: https://github.com/jasnell/json-tools
[json_patch]: https://rubygems.org/gems/json_patch
[hana]: https://github.com/tenderlove/hana
[perl-json-patch]: https://github.com/zigorou/perl-json-patch
[cJSON]: https://github.com/DaveGamble/cJSON
[zjsonpatch]: https://github.com/flipkart-incubator/zjsonpatch
[json-patch]: https://github.com/fge/json-patch
[bsonpatch]: https://github.com/ebay/bsonpatch
[BSON]: https://en.wikipedia.org/wiki/BSON
[diffson]: https://github.com/gnieh/diffson
[JSON for Modern C]: https://github.com/nlohmann/json
[jsoncons]: https://github.com/danielaparker/jsoncons
[Asp.Net Core JsonPatch]: https://github.com/aspnet/JsonPatch
[Ramone]: https://github.com/JornWildt/Ramone
[JsonPatch]: https://github.com/myquay/JsonPatch
[Starcounter]: https://starcounter.io/
[Nancy.JsonPatch]: https://github.com/DSaunders/Nancy.JsonPatch
[Manatee.Json]: http://github.com/gregsdennis/Manatee.Json
[json-patch 1]: https://github.com/evanphx/json-patch
[jsonpatch]: https://github.com/mattbaird/jsonpatch
[Haskell-JSON-Patch]: https://github.com/GallagherCommaJack/Haskell-JSON-Patch
[json-patch.erl]: https://github.com/marianoguerra/json-patch.erl
[norpan_elm-json-patch]: http://package.elm-lang.org/packages/norpan/elm-json-patch/latest
[JSON-Gui]: https://json-gui.site/
[json-patch-builder-online]: https://json-patch-builder-online.github.io/
[json-lab-patcher]: http://helmet.kafuka.org/sbmods/json/#patcher
[JSONBuddy editor]: https://www.json-buddy.com/
[https_www.thinbug.com_q_48436801]: https://www.thinbug.com/q/48436801