Question

根据我的知识：

PUT - 用其整个表示更新对象（替换）
PATCH - 仅使用给定字段更新对象（更新）

我使用Spring来实现一个非常简单的HTTP服务器。当用户想要更新他的数据时，他需要向某个端点发出HTTP PATCH（让我们说：api/user）。他的请求正文通过@RequestBody映射到DTO，如下所示：

class PatchUserRequest {
    @Email
    @Length(min = 5, max = 50)
    var email: String? = null

    @Length(max = 100)
    var name: String? = null
    ...
}

然后我使用此类的对象来更新（修补）用户对象：

fun patchWithRequest(userRequest: PatchUserRequest) {
    if (!userRequest.email.isNullOrEmpty()) {
        email = userRequest.email!!
    }
    if (!userRequest.name.isNullOrEmpty()) {
        name = userRequest.name
    }    
    ...
}

我的疑问是：如果客户（例如网络应用程序）想清除房产怎么办？我会忽略这样的改变。

我怎么知道，如果用户想要清除一个属性（他故意将我发送给我）或者他只是不想改变它？在这两种情况下，它都会在我的对象中为空。

我可以在这里看到两个选项：

同意客户的意见，如果他想删除一个属性，他应该给我一个空字符串（但是日期和其他非字符串类型呢？）
停止使用DTO映射并使用一个简单的地图，这将让我检查字段是否为空或根本没有给出。那么请求身体验证呢？我现在使用@Valid。

如何妥善处理此类案件，与REST和所有良好做法保持一致？

修改

可以说PATCH不应该在这样的示例中使用，我应该使用PUT来更新我的用户。但是模型更改怎么样（例如添加新属性）？每次用户更改后，我都必须对我的API（或单独的用户端点）进行版本控制。例如。我的api/v1/user端点接受PUT旧请求正文，api/v2/user端点接受PUT新请求正文。我想这不是解决方案而PATCH存在是有原因的。

Answer 1

TL; DR

patchy 是我提出的一个小型库，负责处理Spring中正确处理PATCH所需的主要样板代码，即：

class Request : PatchyRequest {
    @get:NotBlank
    val name:String? by { _changes }

    override var _changes = mapOf<String,Any?>()
}

@RestController
class PatchingCtrl {
    @RequestMapping("/", method = arrayOf(RequestMethod.PATCH))
    fun update(@Valid request: Request){
        request.applyChangesTo(entity)
    }
}

简单解决方案

由于PATCH请求表示要应用于资源的更改，我们需要明确地对其进行建模。

一种方法是使用普通的旧Map<String,Any?>，其中客户提交的每个key都代表对资源的相应属性的更改：

@RequestMapping("/entity/{id}", method = arrayOf(RequestMethod.PATCH))
fun update(@RequestBody changes:Map<String,Any?>, @PathVariable id:Long) {
    val entity = db.find<Entity>(id)
    changes.forEach { entry ->
        when(entry.key){
            "firstName" -> entity.firstName = entry.value?.toString() 
            "lastName" -> entity.lastName = entry.value?.toString() 
        }
    }
    db.save(entity)
}

上面很容易理解：

我们没有请求值的验证

通过在域层对象上引入验证注释，可以减轻上述问题。虽然这在简单的场景中非常方便，但是一旦我们引入conditional validation，根据域对象的状态或执行更改的主体的角色，它往往是不切实际的。更重要的是，在产品存在一段时间并引入新的验证规则之后，仍然允许实体在非用户编辑上下文中进行更新是很常见的。对于enforce invariants on the domain layer而言keep the validation at the edges似乎更实用。

在很多地方会非常相似

实际上这很容易解决，在80％的情况下，以下方法都可以解决：

fun Map<String,Any?>.applyTo(entity:Any) {
    val entityEditor = BeanWrapperImpl(entity)
    forEach { entry ->
        if(entityEditor.isWritableProperty(entry.key)){
            entityEditor.setPropertyValue(entry.key, entityEditor.convertForProperty(entry.value, entry.key))
        }
    }
}

验证请求

感谢delegated properties in Kotlin，围绕Map<String,Any?>构建包装非常容易：

class NameChangeRequest(val changes: Map<String, Any?> = mapOf()) {
    @get:NotBlank
    val firstName: String? by changes
    @get:NotBlank
    val lastName: String? by changes
}

使用Validator接口，我们可以过滤掉与请求中不存在的属性相关的错误，如下所示：

fun filterOutFieldErrorsNotPresentInTheRequest(target:Any, attributesFromRequest: Map<String, Any?>?, source: Errors): BeanPropertyBindingResult {
    val attributes = attributesFromRequest ?: emptyMap()
    return BeanPropertyBindingResult(target, source.objectName).apply {
        source.allErrors.forEach { e ->
            if (e is FieldError) {
                if (attributes.containsKey(e.field)) {
                    addError(e)
                }
            } else {
                addError(e)
            }
        }
    }
}

显然，我们可以使用HandlerMethodArgumentResolver简化开发，我在下面做了。

最简单的解决方案

我认为将上述内容包装到一个易于使用的库中是有意义的 - 看哪patchy。使用 patchy ，可以使用强类型请求输入模型以及声明性验证。您所要做的就是导入配置@Import(PatchyConfiguration::class)并在模型中实现PatchyRequest界面。

进一步阅读

Answer 2

我遇到了同样的问题，所以这是我的经验/解决方案。

我建议你按原样实现补丁，所以如果

一个键的值为＆gt;值已设置
一个带有空字符串的键＆gt;设置空字符串
存在具有空值的键＆gt;该字段设置为null
缺少钥匙＆gt;该键的值未更改

如果你不这样做，你很快就会得到一个难以理解的api。

所以我会删除你的第一个选项

同意客户，如果他想删除一个属性，他应该给我一个空字符串（但是日期和其他非字符串类型呢？）

在我看来，第二种选择实际上是一个不错的选择。这也是我们所做的（有点）。

我不确定您是否可以使验证属性与此选项一起使用，但是，如果此验证不在您的域层上，那么又一次吗？这可能会从域中抛出异常，该异常由其余层处理并转换为错误请求。

这就是我们在一个应用程序中完成它的方式：

class PatchUserRequest {
  private boolean containsName = false;
  private String name;

  private boolean containsEmail = false;
  private String email;

  @Length(max = 100) // haven't tested this, but annotation is allowed on method, thus should work
  void setName(String name) {
    this.containsName = true;
    this.name = name;
  }

  boolean containsName() {
    return containsName;
  }

  String getName() {
    return name;
  }
}
...

json反序列化器将实例化PatchUserRequest，但它只会为存在的字段调用setter方法。所以缺少字段的contains boolean将保持为false。

在另一个应用程序中，我们使用相同的原则，但有点不同。（我更喜欢这个）

class PatchUserRequest {
  private static final String NAME_KEY = "name";

  private Map<String, ?> fields = new HashMap<>();;

  @Length(max = 100) // haven't tested this, but annotation is allowed on method, thus should work
  void setName(String name) {
    fields.put(NAME_KEY, name);
  }

  boolean containsName() {
    return fields.containsKey(NAME_KEY);
  }

  String getName() {
    return (String) fields.get(NAME_KEY);
  }
}
...

您也可以通过让PatchUserRequest扩展Map来实现相同目的。

另一种选择可能是编写自己的json反序列化器，但我自己还没试过。

可以说PATCH不应该在这样的例子中使用，我应该使用PUT来更新我的用户。

我不同意这一点。我也使用PATCH＆amp;按照你所说的相同方式：

PUT - 用其整个表示更新对象（替换）
PATCH - 仅使用给定字段更新对象（更新）

Answer 3

正如您所指出的，主要问题是我们没有多个类似null的值来区分显式和隐式空值。自从你标记了这个问题Kotlin后，我试图提出一个使用Delegated Properties和Property References的解决方案。一个重要的限制是它与Spring Boot透明地工作。

我们的想法是使用委托属性自动存储已明确设置为null的字段的信息。

首先定义委托：

class ExpNull<R, T>(private val explicitNulls: MutableSet<KProperty<*>>) {
    private var v: T? = null
    operator fun getValue(thisRef: R, property: KProperty<*>) = v
    operator fun setValue(thisRef: R, property: KProperty<*>, value: T) {
        if (value == null) explicitNulls += property
        else explicitNulls -= property
        v = value
    }
}

这类似于属性的代理，但在给定的MutableSet中存储null属性。

现在在DTO：

class User {
    val explicitNulls = mutableSetOf<KProperty<*>>() 
    var name: String? by ExpNull(explicitNulls)
}

用法是这样的：

@Test fun `test with missing field`() {
    val json = "{}"

    val user = ObjectMapper().readValue(json, User::class.java)
    assertTrue(user.name == null)
    assertTrue(user.explicitNulls.isEmpty())
}

@Test fun `test with explicit null`() {
    val json = "{\"name\": null}"

    val user = ObjectMapper().readValue(json, User::class.java)
    assertTrue(user.name == null)
    assertEquals(user.explicitNulls, setOf(User::name))
}

这是有效的，因为Jackson在第二种情况下明确调用了user.setName(null)并在第一种情况下省略了调用。

你当然可以更加花哨，并为你的DTO应该实现的接口添加一些方法。

interface ExpNullable {
    val explicitNulls: Set<KProperty<*>>

    fun isExplicitNull(property: KProperty<*>) = property in explicitNulls
}

这使user.isExplicitNull(User::name)的检查更好。

Answer 4

我在某些应用程序中所做的是创建一个OptionalInput类，它可以区分是否设置了值：

class OptionalInput<T> {

    private boolean _isSet = false

    @Valid
    private T value

    void set(T value) {
        this._isSet = true
        this.value = value
    }

    T get() {
        return this.value
    }

    boolean isSet() {
        return this._isSet
    }
}

然后在你的请求类中：

class PatchUserRequest {

    @OptionalInputLength(max = 100L)
    final OptionalInput<String> name = new OptionalInput<>()

    void setName(String name) {
        this.name.set(name)
    }
}

可以通过创建@OptionalInputLength来验证属性。

用法是：

void update(@Valid @RequestBody PatchUserRequest request) {
    if (request.name.isSet()) {
        // Do the stuff
    }
}

注意：代码是用groovy编写的，但您明白了。我已经将这种方法用于一些API，它似乎很好地完成了它的工作。

如何在基于Spring的强类型语言中正确地进行PATCH - 例如

4 个答案:

TL; DR

简单解决方案

验证请求

最简单的解决方案

进一步阅读