爪哇中的 JSON 补丁请求验证

Question

在我的spring-boot服务中，我使用https://github.com/java-json-tools/json-patch用于处理PATCH请求。

一切似乎都很好，除了一种避免修改不可变字段的方法，如对象ID、creation_time等。我在Github上发现了一个类似的问题https://github.com/java-json-tools/json-patch/issues/21我找不到合适的例子。

这篇博客似乎给出了一些关于使用 node.js 中的解决方案验证 JSON 补丁请求的有趣解决方案。如果知道JAVA中已经存在类似的东西，那就太好了。

Answer 1

不是直接从客户机接收JsonPatch，而是定义一个DTO来处理验证，然后将DTO实例转换为JsonPatch。

假设您想要更新实例< code>User.class的用户，您可以定义一个DTO，例如:

public class UserDTO {

    @Email(message = "The provided email is invalid")
    private String username;

    @Size(min = 2, max = 10, message = "firstname should have at least 2 and a maximum of 10 characters")
    private String firstName;

    @Size(min = 2, max = 10, message = "firstname should have at least 2 and a maximum of 10 characters")
    private String lastName;

    @Override
    public String toString() {
        return new Gson().toJson(this);
    }

//getters and setters
}

自定义toString方法可确保未包含在更新请求中的字段不会预填充null值。

您的 PATCH 请求可以如下所示（为简单起见，我没有满足例外情况）

@PatchMapping("/{id}")
    ResponseEntity<Object> updateUser(@RequestBody @Valid UserDTO request,
                                      @PathVariable String id) throws ParseException, IOException, JsonPatchException {
        User oldUser = userRepository.findById(id);
        String detailsToUpdate = request.toString();
        User newUser = applyPatchToUser(detailsToUpdate, oldUser);
        userRepository.save(newUser);
        return userService.updateUser(request, id);
    }

以下方法返回在控制器中更新的补丁用户。

private User applyPatchToUser(String detailsToUpdate, User oldUser) throws IOException, JsonPatchException {
        ObjectMapper objectMapper = new ObjectMapper();
        // Parse the patch to JsonNode
        JsonNode patchNode = objectMapper.readTree(detailsToUpdate);
        // Create the patch
        JsonMergePatch patch = JsonMergePatch.fromJson(patchNode);
        // Convert the original object to JsonNode
        JsonNode originalObjNode = objectMapper.valueToTree(oldUser);
        // Apply the patch
        TreeNode patchedObjNode = patch.apply(originalObjNode);
        // Convert the patched node to an updated obj
        return objectMapper.treeToValue(patchedObjNode, User.class);
    }

Answer 2

在许多情况下，您可以只修补一个中间对象，该对象仅包含用户可以写入的字段。之后，您可以使用一些对象映射器或手动轻松地将中间对象映射到实体。

这样做的缺点是，如果您要求字段必须显式为空，您将不知道补丁对象是否将字段显式设置为null，或者它是否从未出现在补丁中。

你也可以滥用选项来做这件事，例如。

public class ProjectPatchDTO {

    private Optional<@NotBlank String> name;
    private Optional<String> description;
}

虽然Optionals不打算这样使用，但它是在维护输入类型的同时实现补丁操作的最直接的方法。当可选字段为空时，它从未从客户端传递。当可选项不存在时，这意味着客户端已将该值设置为null。