當前位置：首頁 > 科技 > 軟件

REST API中的Patch請求大家都用錯了，這才是正確姿勢

來源：責編：時間：2024-09-10 09:46:33 83觀看

導讀環境：SpringBoot3.2.51. 簡介HTTP PATCH 方法它允許我們對 HTTP 資源進行部分更新。在篇文章，將帶你如何使用 HTTP PATCH 方法和 JSON Patch文檔格式對 RESTful 資源進行部分更新。HTTP PATCH 請求正文（Request Body）描述

環境：SpringBoot3.2.5

1. 簡介

HTTP PATCH 方法它允許我們對 HTTP 資源進行部分更新。

在篇文章，將帶你如何使用 HTTP PATCH 方法和 JSON Patch文檔格式對 RESTful 資源進行部分更新。

HTTP PATCH 請求正文（Request Body）描述了如何修改目標資源以生成新版本。簡而言之，JSON Patch 格式使用 "一系列操作 "來描述應如何修改目標資源。JSON Patch文檔是一個 JSON 對象數組。數組中的每個對象正好代表一個 JSON Patch操作。Request Body請求格式如下：

[  {    "op": "replace|add|remove|move|copy|test",    "path": "/xxx",    ["value": "value"],    ["from": "/yyy"]  },    ...]

op：具體的操作
path：資源路徑
value：變更值；根據操作op不同，決定是否有該屬性
from：資源路徑；根據操作op不同，決定是否有該屬性

接下來，通過具體的示例來了解 JSON Patch操作。

2. JSON Patch操作

接下來的所有操作都基于下面的資源進行：

{     "id": 1,    "telephone": "001-555-1234",    "favorites": ["Milk","Eggs"],    "communicationPreferences": {"post":true, "email":true}}

假設有上面的資源數據，下面將分別介紹基于該資源如何進行不同的操作。

2.1 add添加操作

添加操作為對象添加新值。此外，我們還可以用它來更新現有成員，并在指定索引處向數組中插入一個新值。

給favorities數據添加新值，并且插入到第一個位置。

請求Body

{  "op": "add",  "path": "/favorites/0",  "value": "Bread"}

結果

{  "id": "1",  "telephone": "001-555-1234",  "favorites": ["Bread","Milk","Eggs"],  "communicationPreferences": {"post":true, "email":true}}

2.2 remove刪除操作

不僅可以刪除指定屬性的值，如果是數組還可以刪除指定索引位置的元素。

刪除communicationPreferences屬性值

請求Body

{  "op": "remove",  "path": "/communicationPreferences"}

結果

{  "id": "1",  "telephone": "001-555-1234",  "favorites": ["Bread","Milk","Eggs"],  "communicationPreferences": null}

2.3 replace替換操作

將目標屬性值更新為一個新的值；

更新電話號碼；

請求Body

{  "op": "replace",  "path": "/telephone",  "value": "001-555-5678"}

結果

{   "id": "1",   "telephone": "001-555-5678",   "favorites": ["Bread","Milk","Eggs"],   "communicationPreferences": null}

2.4 move移動操作

移動操作會移除指定位置的值，并將其添加到目標位置。

移動favorities屬性第0號位置元素到最后一個位置。

請求Body

{  "op": "move",  "from": "/favorites/0",  "path": "/favorites/-"}

結果

{   "id": "1",   "telephone": "001-555-5678",   "favorites": ["Milk","Eggs","Bread"],   "communicationPreferences": null}

2.5 copy復制操作

復制操作將指定位置的值復制到目標位置。

將favorites屬性中的Milk復制一份到該屬性的最后位置。

請求Body

{  "op": "copy",  "from": "/favorites/0",  "path": "/favorites/-"}

結果

{   "id": "1",   "telephone": "001-555-5678",   "favorites": ["Milk","Eggs","Bread","Milk"],   "communicationPreferences": null}

2.6 test測試操作

測試操作測試 "路徑 "上的值是否等于 "值"。

請求Body

{  "op": "test",   "path": "/telephone",  "value": "001-555-5678"}

注意：JSON Patch請求的Content-Type類型為：application/json-patch+json

接下來將實戰演示在Spring Boot中如何使用JSON Patch。

3. 實戰案例

3.1 引入依賴

<dependency>  <groupId>com.github.java-json-tools</groupId>  <artifactId>json-patch</artifactId>  <version>1.13</version></dependency>

該組件是RFC 6902（JSON Patch）和RFC 7386（JSON Merge Patch）的實現，其核心使用Jackson（2.2.x）。該組件的特性：

JSON Patch的序列化和JSON與Jackson Merge Patch實例
全面支持RFC 6902操作，包括測試
JSON“差異”(僅RFC 6902)與運算因子分解

接下來進入實踐代碼的編寫

3.2 定義實體類

public class Customer {  /**編號*/  private Long id ;  /**電話*/  private String telephone ;  /**收藏集*/  private List<String> favorites ;  /**通信首選項*/  private Map<String, Boolean> communicationPreferences ;  public Customer(Long id, String telephone, List<String> favorites,      Map<String, Boolean> communicationPreferences) {    this.id = id ;    this.telephone = telephone ;    this.favorites = favorites ;    this.communicationPreferences = communicationPreferences ;  }  // getters, setters}

定義異常類

public static class CustomerNotFoundException extends RuntimeException {}

當沒有資源時拋出該異常類

3.3 Service類

@Servicepublic static class CustomerService {  // 模擬靜態數據  private static List<Customer> DATAS = List    .of(new Customer(          1L, "188",           List.of("Milk", "Eggs"),           Map.of("phone", true, "email", true)));  // 根據ID查詢操作  public Optional<Customer> findCustomer(Long id) {    return DATAS.stream().filter(customer -> customer.getId() == id).findFirst();  }}

接下來就是關鍵的Controller接口的編寫了

3.4 Controller接口

@PatchMapping(path = "/{id}", consumes = "application/json-patch+json")public ResponseEntity<Customer> updateCustomer(@PathVariable Long id, @RequestBody JsonPatch patch) {  try {    // 查詢資源    Customer customer = customerService.findCustomer(id).orElseThrow(CustomerNotFoundException::new);    Customer customerPatched = applyPatchToCustomer(patch, customer);    return ResponseEntity.ok(customerPatched);  } catch (JsonPatchException | JsonProcessingException e) {    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();  } catch (CustomerNotFoundException e) {    return ResponseEntity.status(HttpStatus.NOT_FOUND).build();  }}// 將請求的操作轉換成真實的資源變更private Customer applyPatchToCustomer(JsonPatch patch, Customer targetCustomer)    throws JsonPatchException, JsonProcessingException {  ObjectMapper objectMapper = new ObjectMapper() ;  JsonNode patched = patch.apply(objectMapper.convertValue(targetCustomer, JsonNode.class));  return objectMapper.treeToValue(patched, Customer.class);}

在該接口中注意以下兩點：

consumes屬性設置為application/json-patch+json，也就是請求的Content-Type必須是該值。
請求body通過JsonPatch對象接收。

接下來進行測試：

圖片

請求Body中定義了2個操作，replace與add。最后返回的結果表明操作成功，數據得到了變更。

本文鏈接：http://www.tebozhan.com/showinfo-26-112718-0.htmlREST API中的Patch請求大家都用錯了，這才是正確姿勢

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。郵件：2376512515@qq.com

上一篇：聊聊 C# 中的ToString()數字格式化

下一篇： PHP 程序員學會了 Go 語言就能唬住面試官嗎？

標簽：

熱門焦點

7月安卓手機性能榜：紅魔8S Pro再奪榜首

7月份的手機市場風平浪靜，除了紅魔和努比亞帶來了兩款搭載驍龍8Gen2領先版處理器的新機之外，別的也想不到有什么新品了，這也正常，通常6月7月都是手機廠商修整的時間，進入8月份之
把LangChain跑起來的三個方法

使用LangChain開發LLM應用時，需要機器進行GLM部署，好多同學第一步就被勸退了，那么如何繞過這個步驟先學習LLM模型的應用，對Langchain進行快速上手？本片講解3個把LangChain跑起來
梁柱接棒兩年，騰訊音樂闖出新路子

文丨田靜出品丨牛刀財經（niudaocaijing）7月5日，企鵝FM發布官方公告稱由于業務調整，將于9月6日正式停止運營，這意味著騰訊音樂長音頻業務走向消亡。騰訊在長音頻領域還在摸索。為
小米MIX Fold 3下月亮相：今年唯一無短板的全能折疊屏

這段時間以來，包括三星、一加、榮耀等等有不少品牌旗下的最新折疊屏旗艦都有新的進展，其中榮耀、三星都已陸續發布了最新的折疊屏旗艦，尤其號榮耀Magi
8月見！小米MIX Fold 3獲得3C認證：支持67W快充

這段時間以來，包括三星、一加、榮耀等等有不少品牌旗下的最新折疊屏旗艦都得到了不少爆料，而小米新一代折疊屏旗艦——小米MIX Fold 3此前也屢屢被傳
華為Mate 60保護殼曝光：碩大后置相機模組凸起程度有驚喜

這段時間以來，關于華為新旗艦的爆料日漸密集。據此前多方爆料，今年華為將開始恢復一年雙旗艦戰略，除上半年推出的P60系列外，往年下半年的Mate系列也將
onebot M24巧系列一體機采用輕薄機身設計，現已在各平臺開售

onebot M24 巧系列一體機目前已在線上線下各平臺同步開售。onebot M24 巧系列采用一體化輕薄機身設計，最薄處為 10.15mm，擁有寶石紅、午夜藍、石墨綠、雅致
三翼鳥智能家居亮相電博會，讓用戶體驗更真實

2021電博會在青島國際會展中心開幕中，三翼鳥直接把“家”搬到了現場，成為了展會的一大看點。這也是三翼鳥繼9月9日發布了行業首個一站式定制智慧家平臺后的
電博會上海爾智家模擬500平大平層，還原生活空間沉浸式體驗

電博會為了更好地讓參展觀眾真正感受到智能家居的絕妙之處，海爾智家的程傳嶺先生同樣介紹了展會上海爾智家的模擬500平大平層，還原生活空間沉浸式體驗。程傳

AVt天堂网手机版,亚洲va久久久噜噜噜久久4399,天天综合亚洲色在线精品,亚洲一级Av无码毛片久久精品

REST API中的Patch請求大家都用錯了，這才是正確姿勢

1. 簡介

2. JSON Patch操作

2.1 add添加操作

請求Body

結果

2.2 remove刪除操作

2.3 replace替換操作

請求Body

結果

2.4 move移動操作

請求Body

結果

2.5 copy復制操作

請求Body

結果

2.6 test測試操作

請求Body

3. 實戰案例

3.1 引入依賴

3.2 定義實體類

定義異常類

3.3 Service類

3.4 Controller接口

7月安卓手機性能榜：紅魔8S Pro再奪榜首

把LangChain跑起來的三個方法

梁柱接棒兩年，騰訊音樂闖出新路子

小米MIX Fold 3下月亮相：今年唯一無短板的全能折疊屏

8月見！小米MIX Fold 3獲得3C認證：支持67W快充

華為Mate 60保護殼曝光：碩大后置相機模組凸起程度有驚喜

onebot M24巧系列一體機采用輕薄機身設計，現已在各平臺開售

三翼鳥智能家居亮相電博會，讓用戶體驗更真實

電博會上海爾智家模擬500平大平層，還原生活空間沉浸式體驗

最新推薦

猜你喜歡

熱門推薦

相關資訊