1. 概述
在本快速教程中，我们将研究HTTP PUT和PATCH动词之间的差异以及这两个操作的语义。
我们将使用Spring来实现支持这两种类型操作的两个REST端点，以便更好地理解它们的区别和正确的使用方法。
2. 什么时候用Put，什么时候用Patch？
让我们从一个简单的和稍微简单的语句开始。
当客户端需要完全替换现有资源时，他们可以使用PUT。当他们进行部分更新时，他们可以使用HTTP PATCH。
例如，在更新资源的单个字段时，发送完整的资源表示可能很麻烦并且会占用大量不必要的带宽。在这种情况下，PATCH的语义更有意义。
这里要考虑的另一个重要方面是幂等性。PUT是幂等的；PATCH可以是幂等的，但不是必须的。因此，根据我们正在实施的操作的语义，我们也可以根据这个特征选择一个或另一个。
3. 实现PUT和PATCH逻辑
假设我们要实现REST API来更新具有多个字段的HeavyResource：
public class HeavyResource {
private Integer id;
private String name;
private String address;
// ...
}
首先，我们需要使用PUT创建处理资源完整更新的端点：
@PutMapping("/heavyresource/{id}")
public ResponseEntity<?> saveResource(@RequestBody HeavyResource heavyResource, @PathVariable("id") String id) {
heavyResourceRepository.save(heavyResource, id);
return ResponseEntity.ok("resource saved");
}
这是更新资源的标准端点。
现在假设地址字段将经常由客户端更新。在这种情况下，我们不想发送具有所有字段的整个HeavyResource对象，但我们确实希望能够仅通过PATCH方法更新地址字段。
我们可以创建一个HeavyResourceAddressOnly DTO来表示地址字段的部分更新：
public class HeavyResourceAddressOnly {
private Integer id;
private String address;
// ...
}
接下来，我们可以利用PATCH方法发送部分更新：
@PatchMapping("/heavyresource/{id}")
public ResponseEntity<?> partialUpdateName(@RequestBody HeavyResourceAddressOnly partialUpdate, @PathVariable("id") String id) {
heavyResourceRepository.save(partialUpdate, id);
return ResponseEntity.ok("resource address updated");
}
有了这个更细化的DTO，我们可以只发送我们需要更新的字段，而无需发送整个HeavyResource的开销。
如果我们有大量这样的部分更新操作，我们也可以跳过为每个输出创建自定义DTO，而只使用一个映射：
@RequestMapping(value = "/heavyresource/{id}", method = RequestMethod.PATCH, consumes = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<?> partialUpdateGeneric(@RequestBody Map<String, Object> updates, @PathVariable("id") String id) {
heavyResourceRepository.save(updates, id);
return ResponseEntity.ok("resource updated");
}
该解决方案将使我们在实现API时更加灵活，但我们也确实失去了一些东西，例如验证。
4. 测试PUT和PATCH
最后，让我们为这两种HTTP方法编写测试。
首先，我们要通过PUT方法测试完整资源的更新：
mockMvc.perform(put("/heavyresource/1")
.contentType(MediaType.APPLICATION_JSON_VALUE)
.content(objectMapper.writeValueAsString(
new HeavyResource(1, "Tom", "Jackson", 12, "heaven street")))
).andExpect(status().isOk());
部分更新的执行是通过使用PATCH方法实现的：
mockMvc.perform(patch("/heavyrecource/1")
.contentType(MediaType.APPLICATION_JSON_VALUE)
.content(objectMapper.writeValueAsString(
new HeavyResourceAddressOnly(1, "5th avenue")))
).andExpect(status().isOk());
我们还可以为更通用的方法编写测试：
HashMap<String, Object> updates = new HashMap<>();
updates.put("address", "5th avenue");
mockMvc.perform(patch("/heavyresource/1")
.contentType(MediaType.APPLICATION_JSON_VALUE)
.content(objectMapper.writeValueAsString(updates))
).andExpect(status().isOk());
5. 处理带有空值的部分请求
当我们为PATCH方法编写实现时，我们需要指定一个合同，说明当我们将空值作为HeavyResourceAddressOnly中地址字段的值时如何处理情况。
假设客户端发送如下请求：
{
"id" : 1,
"address" : null
}
然后我们可以将其处理为将地址字段的值设置为null或通过将其视为无变化来忽略此类请求。
我们应该选择一种策略来处理null并在每个PATCH方法实现中坚持使用它。
6. 总结
在这篇快速文章中，我们重点了解了HTTP PATCH和PUT方法之间的区别。
我们实现了一个简单的Spring REST控制器，通过PUT方法更新资源，并使用PATCH进行部分更新。
与往常一样，本教程的完整源代码可在GitHub上获得。
Post Directory
