1. 文章目的

隨著 WebApiClient 的不斷完善，越來越多開發(fā)者選擇WebApiClient替換原生的HttpClient，本文將介紹使用WebApiClient來完成JsonPatch提交的新特性。

2. json patch介紹

在服務端WebApi開發(fā)的時候，如果設計一個更新登錄用戶的個人信息的接口，用戶能更新昵稱、密碼、生日、性別等N多個字段，但用戶在實際使用中，可能是更新其中的一個或不確定多個字段。開發(fā)者往往會為難：對于客戶端沒有更新到的字段，應該設置為什么值呢？一種是讓客戶端從服務器同步后再更新相關字段，一種是不更新的字段設置為null，服務器收到null的字段不更新，但這個還是有歧義（要更新為null的情況）。

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"}，改變屬性的值，也可以理解為先執(zhí)行了刪除，然后進行添加。
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請求之后，會執(zhí)行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);

5. 結束語

博主為WebApiClient庫的作者，本文向讀者介紹了JsonPatch的基本知識，以及如何在WebApiClient提交JsonPatch，歡迎大家給WebApiClient提建議。

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

最新評論