java - 使用@PATCH 方法进行 Spring REST 部分更新

Question

我正在尝试根据以下内容实现 Manager 实体的部分更新:

实体

public class Manager {
    private int id;
    private String firstname;
    private String lastname;
    private String username;
    private String password;

    // getters and setters omitted
}

Controller 中的 SaveManager 方法

@RequestMapping(value = "/save", method = RequestMethod.PATCH)
public @ResponseBody void saveManager(@RequestBody Manager manager){
    managerService.saveManager(manager);
}

在 Dao impl 中保存对象管理器。

@Override
public void saveManager(Manager manager) {  
    sessionFactory.getCurrentSession().saveOrUpdate(manager);
}

当我保存对象时，用户名和密码已正确更改，但其他值为空。

所以我需要做的是更新用户名和密码并保留所有剩余数据。

Answer 1

如果您真正使用的是 PATCH，那么您应该使用 RequestMethod.PATCH，而不是 RequestMethod.POST。

您的补丁映射应该包含您可以用来检索要打补丁的 Manager 对象的 ID。此外，它应该只包含您要更改的字段。在您的示例中，您发送的是整个实体，因此您无法辨别实际发生变化的字段(空是指单独保留此字段还是实际将其值更改为空)。

也许这样的实现就是您所追求的？

@RequestMapping(value = "/manager/{id}", method = RequestMethod.PATCH)
public @ResponseBody void saveManager(@PathVariable Long id, @RequestBody Map<Object, Object> fields) {
    Manager manager = someServiceToLoadManager(id);
    // Map key is field name, v is value
    fields.forEach((k, v) -> {
       // use reflection to get field k on manager and set it to value v
        Field field = ReflectionUtils.findField(Manager.class, k);
        field.setAccessible(true);
        ReflectionUtils.setField(field, manager, v);
    });
    managerService.saveManager(manager);
}

更新

我想更新这篇文章，因为现在有一个项目可以简化修补过程。

Artifact 是

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

在 OP 中修补 Manager 对象的实现如下所示:

Controller

@Operation(summary = "Patch a Manager")
@PatchMapping("/{managerId}")
public Task patchManager(@PathVariable Long managerId, @RequestBody JsonPatch jsonPatch)
    throws JsonPatchException, JsonProcessingException {
    return managerService.patch(managerId, jsonPatch);
}

服务

public Manager patch(Long managerId, JsonPatch jsonPatch) throws JsonPatchException, JsonProcessingException {
    Manager manager = managerRepository.findById(managerId).orElseThrow(EntityNotFoundException::new);
    JsonNode patched = jsonPatch.apply(objectMapper.convertValue(manager, JsonNode.class));

    return managerRepository.save(objectMapper.treeToValue(patched, Manager.class));
}

补丁请求遵循 RFC 6092 中的规范，因此这是一个真正的 PATCH 实现。详情可查here