如何防止 Json Patch Document .NET Core Web API 中的删除操作

Question

我在我的 Web API 项目中使用 .NET core 和 EF。

我想要一个补丁端点来更新一个实体。我发现这篇文章说

删除 与上述“添加”操作类似，删除 操作通常意味着您要从 对象或从数组中删除项目。但是因为你不能 实际上从 C# 中的对象中“删除”一个属性，实际上是什么 发生的是它会将值设置为默认值（T）。在某些情况下，如果 对象可以为空（或引用类型），它将被设置为 NULL。 但要小心，因为当用于值类型时，例如 int， 然后该值实际上被重置为“0”。

我不希望客户发送删除操作，这将重置他的一些字段或使用Add 操作添加新字段

所以在这里我想创建 PATCH 端点来更新人 FirstName 或 Age 仅使用 replace 操作。

我有一个Person 实体和UpdatePersonDTO，如下所示

public partial class Person
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public int Age { get; set; }
}

public partial class PersonDTO
{
    public string FirstName { get; set; }
    public int Age { get; set; }
}

这是我当前的代码

public async Task<Object> UpdatePerson(int id , JsonPatchDocument<PersonRequestDTO> patchDocument) {

var result = _dbContext.persons
   .Where(P => P.id == id).FirstOrDefault();


var personToPatch = _mapper.Map<PersonRequestDTO>(result);
patchDocument.ApplyTo(personToPatch);
_mapper.Map(personToPatch, result);

// rest of code and returning updated entitiy dto... 
}

现在实现这一目标的方法是什么？为什么我找不到类似的问题？ 我认为remove 操作非常关键，所以现在我觉得我实际上在这里遗漏了一些东西。

Answer 1

正如文章所说，Add 和 Remove 不能在 C# 中添加或删除属性，只能添加或删除数组项。 remove 相当于将属性设置为 null，或者如果它是值类型，则设置为默认值。

验证规则和属性可以检测到这一点。 JSON Patch example in the ASP.NET Core docs 正好展示了这种情况。稍作修改：

[HttpPatch]
public IActionResult JsonPatchWithModelState(
    int id,
    [FromBody] JsonPatchDocument<Person> patchDoc)
{
    if (patchDoc != null)
    {
        var person = _dbContext.persons
                         .Find(id)
                         .FirstOrDefault();

        patchDoc.ApplyTo(person, ModelState);

        if (!ModelState.IsValid)
        {
            return BadRequest(ModelState);
        }

        _dbContext.SaveChanges();
        return new ObjectResult(person);

    }
    else
    {
        return BadRequest(ModelState);
    }
}

向Person 类添加验证属性将确保它不能接受无效数据：

public partial class Person
{
    public int Id { get; set; }

    [Required]
    public string FirstName { get; set; }

    [Range(1,199)]
    public int Age { get; set; }
}

如果我们担心PATCH 可能会修改ID，并且该字段不是 数据库生成的，我们可以检查person.id 是否未更改：

if (!ModelState.IsValid || person.id!=id)
{
    if (person.id!=id)
    {
        ModelState.AddError("id","Not Editable");
    }
    return BadRequest(ModelState);
}