怎么在WebApiClient中使用JsonPatch實現局部更新

這篇文章給大家介紹怎么在WebApiClient中使用JsonPatch實現局部更新，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

json patch是為客戶端能夠局部更新服務端已存在的資源而設計的一種標準交互，在 RFC6902 里有詳細的介紹json patch，通俗來講有以下幾個要點：

1. 使用HTTP PATCH請求方法；

2. 請求body為描述多個opration的數據json內容；

3. 請求的Content-Type為application/json-patch+json；

以下為一個json patch請求的數據包：

PATCH /my/data HTTP/1.1
Host: example.org
Content-Length: 326
Content-Type: application/json-patch+json
If-Match: "abc123"

[
  { "op": "test", "path": "/a/b/c", "value": "foo" },
  { "op": "remove", "path": "/a/b/c" },
  { "op": "add", "path": "/a/b/c", "value": [ "foo", "bar" ] },
  { "op": "replace", "path": "/a/b/c", "value": 42 },
  { "op": "move", "from": "/a/b/c", "path": "/a/b/d" },
  { "op": "copy", "from": "/a/b/d", "path": "/a/b/e" }
]

op為操作的意思，分為以下幾種：

1. add 添加：{“op”: "add", "path": "/xxx", "value": "xxx"}，如果該屬性不存，那么就添加該屬性，如果屬性存在，就改變屬性的值。

2. remove 刪除：{“op”: "remove", "path": "/xxx"}，刪除某個屬性，或把它設為默認值（例如空值）。

3. replace 替換：{“op”: "replace", "path": "/xxx", "value": "xxx"}，改變屬性的值，也可以理解為先執行了刪除，然后進行添加。

4. copy 復制：{“op”: "copy", "from": "/xxx", "path": "/yyy"}，把某個屬性的值賦給目標屬性。

5. remove 移動：{“op”: "move", "from": "/xxx", "path": "/yyy"}，把源屬性的值賦值給目標屬性，并把源屬性刪除或設成默認值。

6. test測試：{“op”: "test", "path": "/xxx", "value": "xxx"}，測試目標屬性的值和指定的值是一樣的。

3. Asp.net mvc 接收JsonPatch

在 Asp.net mvc ，可以使用JsonPatchDocument類型來處理json patch內容，JsonPatchDocument可以將操作行為應用到目標實例里，得到操作之后的數據內容。

[HttpPatch]
public UserInfo Patch([FromBody] JsonPatchDocument<UserInfo> doc)
{
  var user = new UserInfo
  {
    Account = "_Account",
    Password = "_Password",
    Email = "_Email"
  };

  doc.ApplyTo(user);
  return user;
}

4. WebApiClient提交JsonPatch

在WebApiClient也提供一個JsonPatchDocument類型，該類型實現了IApiParameterable接口，在http請求之后，會執行BeforeRequestAsync方法，完成組裝body的多個opration的數據json內容，使用方法如下：

public interface IPatchApi : IHttpApi
{
  [HttpPatch("http://localhost:7171/api/userinfo")]
  Task<string> PatchAsync(JsonPatchDocument<UserInfo> doc);
}


var doc = new JsonPatchDocument<UserInfo>();
doc.Replace(item => item.Account, "laojiu");
doc.Replace(item => item.Email, "laojiu@qq.com");

var client = HttpApiClient.Create<IPatchApi>();
await client.PatchAsync(doc);

關于怎么在WebApiClient中使用JsonPatch實現局部更新就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。