使用 @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);
}

Answer 2

有了这个，您可以修补您的更改

1. Autowire `ObjectMapper` in controller;

2. @PatchMapping("/manager/{id}")
    ResponseEntity<?> saveManager(@RequestBody Map<String, String> manager) {
        Manager toBePatchedManager = objectMapper.convertValue(manager, Manager.class);
        managerService.patch(toBePatchedManager);
    }

3. Create new method `patch` in `ManagerService`

4. Autowire `NullAwareBeanUtilsBean` in `ManagerService`

5. public void patch(Manager toBePatched) {
        Optional<Manager> optionalManager = managerRepository.findOne(toBePatched.getId());
        if (optionalManager.isPresent()) {
            Manager fromDb = optionalManager.get();
            // bean utils will copy non null values from toBePatched to fromDb manager.
            beanUtils.copyProperties(fromDb, toBePatched);
            updateManager(fromDb);
        }
    }

您必须扩展 BeanUtilsBean 以实现复制非空值行为。

public class NullAwareBeanUtilsBean extends BeanUtilsBean {

    @Override
    public void copyProperty(Object dest, String name, Object value)
            throws IllegalAccessException, InvocationTargetException {
        if (value == null)
            return;
        super.copyProperty(dest, name, value);
    }
}

最后，将 NullAwareBeanUtilsBean 标记为 @Component

或

将NullAwareBeanUtilsBean注册为bean

@Bean
public NullAwareBeanUtilsBean nullAwareBeanUtilsBean() {
    return new NullAwareBeanUtilsBean();
}

Answer 3

首先，您需要知道您是在进行插入还是更新。插入很简单。更新时，使用 get() 检索实体。然后更新任何字段。在事务结束时，Hibernate 将刷新更改并提交。

Answer 4

您可以编写仅更新特定字段的自定义更新查询：

@Override
public void saveManager(Manager manager) {  
    Query query = sessionFactory.getCurrentSession().createQuery("update Manager set username = :username, password = :password where id = :id");
    query.setParameter("username", manager.getUsername());
    query.setParameter("password", manager.getPassword());
    query.setParameter("id", manager.getId());
    query.executeUpdate();
}

Answer 5

ObjectMapper.updateValue 提供了将实体部分映射到 dto 中的值所需的一切。 另外，您可以在此处使用两个：Map<String, Object> fields 或 String json，因此您的服务方法可能如下所示：

@Autowired
private ObjectMapper objectMapper;

@Override
@Transactional
public Foo save(long id, Map<String, Object> fields) throws JsonMappingException {
    Foo foo = fooRepository.findById(id)
    .orElseThrow(() -> new ResourceNotFoundException("Foo not found for this id: " + id));

    return objectMapper.updateValue(foo , fields);
}

作为第二个解决方案和对 Lane Maxwell 答案的补充，您可以使用 Reflection 仅映射已发送的值映射中存在的属性，因此您的服务方法可能如下所示：

@Override
@Transactional
public Foo save(long id, Map<String, Object> fields) {

    Foo foo = fooRepository.findById(id)
    .orElseThrow(() -> new ResourceNotFoundException("Foo not found for this id: " + id));

    fields.keySet()
            .forEach(k -> {
                Method method = ReflectionUtils.findMethod(LocationProduct.class, "set" + StringUtils.capitalize(k));
                if (method != null) {
                    ReflectionUtils.invokeMethod(method, foo, fields.get(k));
                }
            });
    return foo;
}

第二种解决方案允许您在映射过程中插入一些额外的业务逻辑，可能是转换或计算等。

与通过名称查找反射字段 Field field = ReflectionUtils.findField(Foo.class, k); 以及使其可访问不同，查找属性的设置器实际上调用了可能包含要执行的附加逻辑的设置器方法，并防止将值设置为私有属性。