Spring REST 和 PATCH 方法

我正在使用 SpringBoot 和 Spring REST。 我想了解 HTTP PATCH 方法来更新我的模型的属性

有没有好的教程解释如何使其发挥作用？

• HTTP PATCH 方法和要发送的正文
• 控制器方法以及如何管理更新操作

我注意到许多提供的答案都是 JSON 修补或不完整的答案。以下是真实世界代码所需内容的完整说明和示例

首先，PATCH 是选择性 PUT。您可以使用它来更新对象或对象列表的任意数量的字段。在 PUT 中，您通常会发送带有任何更新的整个对象。

补丁/对象/7

{
   "objId":7,
   "objName": "New name"
}

放置/对象/7

{
   "objId":7,
   "objName": "New name",
   "objectUpdates": true,
   "objectStatus": "ongoing",
   "scoring": null,
   "objectChildren":[
       {
          "childId": 1
       },
     ............ 
}

这允许您在没有大量端点的情况下更新记录。例如，在上面，要更新评分，您需要 object/{id}/scoring，然后要更新名称，您需要 object/{id}/name。从字面上看，每个项目都有一个端点，或者您需要前端为每次更新发布整个对象。如果您有一个巨大的对象，这可能会占用大量不必要的网络时间或移动数据。该补丁让您拥有 1 个端点，该端点具有移动平台应使用的最小对象属性发送。

这是补丁在现实世界中的使用示例：

@ApiOperation(value = "Patch an existing claim with partial update")
@RequestMapping(value = CLAIMS_V1 + "/{claimId}", method = RequestMethod.PATCH)
ResponseEntity<Claim> patchClaim(@PathVariable Long claimId, @RequestBody Map<String, Object> fields) {

    // Sanitize and validate the data
    if (claimId <= 0 || fields == null || fields.isEmpty() || !fields.get("claimId").equals(claimId)){
        return new ResponseEntity<>(HttpStatus.BAD_REQUEST); // 400 Invalid claim object received or invalid id or id does not match object
    }

    Claim claim = claimService.get(claimId);

    // Does the object exist?
    if( claim == null){
        return new ResponseEntity<>(HttpStatus.NOT_FOUND); // 404 Claim object does not exist
    }

    // Remove id from request, we don't ever want to change the id.
    // This is not necessary, you can just do it to save time on the reflection
    // loop used below since we checked the id above
    fields.remove("claimId");

    fields.forEach((k, v) -> {
        // use reflection to get field k on object and set it to value v
        // Change Claim.class to whatver your object is: Object.class
        Field field = ReflectionUtils.findField(Claim.class, k); // find field in the object class
        field.setAccessible(true); 
        ReflectionUtils.setField(field, claim, v); // set given field for defined object to value V
    });

    claimService.saveOrUpdate(claim);
    return new ResponseEntity<>(claim, HttpStatus.OK);
}

上述内容可能会让某些人感到困惑，因为新开发人员通常不会像这样处理反射。基本上，无论您在主体中传递此函数，它都会使用给定 ID 找到关联的声明，然后仅更新您作为键值对传入的字段。

示例正文：

补丁/声明/7

{
   "claimId":7,
   "claimTypeId": 1,
   "claimStatus": null
}

上述代码会将claimTypeId 和claimStatus 更新为声明7 的给定值，而所有其他值保持不变。

所以回报会是这样的：

{
   "claimId": 7,
   "claimSrcAcctId": 12345678,
   "claimTypeId": 1,
   "claimDescription": "The vehicle is damaged beyond repair",
   "claimDateSubmitted": "2019-01-11 17:43:43",
   "claimStatus": null,
   "claimDateUpdated": "2019-04-09 13:43:07",
   "claimAcctAddress": "123 Sesame St, Charlotte, NC 28282",
   "claimContactName": "Steve Smith",
   "claimContactPhone": "777-555-1111",
   "claimContactEmail": "[email protected] /cdn-cgi/l/email-protection",
   "claimWitness": true,
   "claimWitnessFirstName": "Stan",
   "claimWitnessLastName": "Smith",
   "claimWitnessPhone": "777-777-7777",
   "claimDate": "2019-01-11 17:43:43",
   "claimDateEnd": "2019-01-11 12:43:43",
   "claimInvestigation": null,
   "scoring": null
}

正如您所看到的，完整的对象将返回，而不更改除您想要更改的数据之外的任何数据。我知道这里的解释有点重复，我只是想清楚地概述一下。