WebApi Put如何从指定的属性中告诉未指定的属性设置为null？

Question

这里是场景。有一个 web api put 调用来更改 sql server 数据库中的对象。如果它们在 webapi 调用 json 中明确指定，我们只想更改数据库对象上的字段。例如：

{ "Name":"newName", "Colour":null }

这应该将“名称”字段更改为“newName”并将“颜色”字段更改为空。与这个json相反：

{ "Name":"newName" }

应该只更改名称字段，保持旧的颜色值不变。

使用 WebApi 检测属性是否通过的好方法是什么？

如果我这样定义我的方法：

[HttpPut]
[Route("/item/{id}")]
public void ChangeItem(int id, Item item)
{
    ...
}

item.Colour 在任何一种情况下都将为空。请注意，我在这里使用多种数据类型，示例中的属性Colour 可能是int、string、DateTime、Guid 等。

我知道我可以使用[FromBody] 属性获取原始 json，然后自己解析它，但似乎默认活页夹已经完成了大部分工作（包括验证），所以我很好奇我怎么能重用它，也能达到我想要的。最简单的方法是什么？

更新：

我想澄清一下，我的是一个“偶尔连接”的场景。也就是说，使用 API 的设备大部分时间都在网络覆盖范围之外，它们会不时使用 API 进行同步。

实际上，这意味着需要同步的大部分数据都聚合为零个或一个“推送更新到服务器”调用，然后是“从服务器获取最新状态”调用。在后端使用 Sql Server 和 EF 会导致多个不同（有时是不相关的）实体包含在单个 json 中。例如：

class TaskData
{ 
    public IList<User> AssignedUsers {get; set;} 
    public IList<Product> Products {get; set;} 
    public Task Task {get; set}
}

此外，用于为 GET 调用生成 json 的模型类与 EF 实体是分开的，因为数据库架构与 API 对象模型不完全匹配。

Answer 1

我最终为属性使用了动态代理，这样我就可以将JsonMediaTypeFormatter 编写的属性标记为“脏”。我使用了稍微修改过的yappi（实际上并不需要修改它，只是想 - 如果下面的代码与 yappi 示例/API 不完全匹配，请提及这一点）。我猜你可以使用你最喜欢的动态代理库。只是为了好玩，我尝试将其移植到 NProxy.Core 但这不起作用，因为出于某种原因 json.net 拒绝写入 NProxy.Core 生成的代理。

所以它是这样工作的。我们有一个这样的基类：

public class DirtyPropertiesBase
{
    ...

    // most of these come from Yappi
    public static class Create<TConcept> where TConcept : DirtyPropertiesBase
    {
        public static readonly Type Type =PropertyProxy.ConstructType<TConcept, PropertyMap<TConcept>>(new Type[0], true);
        public static Func<TConcept> New = Constructor.Compile<Func<TConcept>>(Type);
    }

    private readonly List<string> _dirtyList = new List<string>();

    protected void OnPropertyChanged(string name)
    {
        if (!_dirtyList.Contains(name))
        {
            _dirtyList.Add(name);
        }
    }
    public bool IsPropertyDirty(string name)
    {
        return _dirtyList.Contains(name);
    }

    ...
    // some more Yappi specific code that calls OnPropertyChanged
    // when a property setter is called
}

在代理实现中的某个地方，我们调用OnPropertyChanged，以便我们记住写入了哪些属性。

然后我们有我们的自定义JsonCreationConverter：

class MyJsonCreationConverter : JsonConverter
{
    private static readonly ConcurrentDictionary<Type, Func<DirtyPropertiesBase>> ContructorCache = new ConcurrentDictionary<Type, Func<DirtyPropertiesBase>>();
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotSupportedException("MyJsonCreationConverter should only be used while deserializing.");
    }
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
        {
            return null;
        }

        Func<DirtyPropertiesBase> constructor = ContructorCache.GetOrAdd(objectType, x =>
            (Func<DirtyPropertiesBase>)typeof(DirtyPropertiesBase.Create<>).MakeGenericType(objectType).GetField("New").GetValue(null));

        DirtyPropertiesBase value = constructor();
        serializer.Populate(reader, value);
        return value;
    }

    public override bool CanConvert(Type objectType)
    {
        return typeof (DirtyPropertiesBase).IsAssignableFrom(objectType);
    }
}

这里的想法是，当JsonMediaTypeFormatter 转换传入的 json 时，我们将初始的空对象替换为我们之前定义的代理。

我们像这样在 WebApiConfig.cs 中注册这个转换器

config.Formatters.JsonFormatter.SerializerSettings.Converters.Add(new MyJsonCreationConverter());

现在，当我们的模型由 json 填充，而不是从 DirtyPropertiesBase 派生的每个对象时，将有一个具有正确填充 _dirtyList 集合的代理。现在我们只需要将这些模型中的每一个映射回 EF 实体。这对AutoMapper 来说很简单。我们像这样注册每个模型：

Mapper.CreateMap<Model, Entity>().ForAllMembers(x => x.Condition(z => ((Model)z.Parent.SourceValue).IsPropertyDirty(z.MemberName)));

然后你就有了常用的映射代码：

Entity current = _db.Entity.Single(x => x.Id == Id);
Mapper.Map(update, current);
_db.SaveChanges();

这将确保只更新脏属性。

Answer 2

虽然为 OData 服务引入，但您可以尝试使用 System.Web.Http.OData.Delta<T>。这允许对实体进行部分更新。

查看this blog post，了解有关使用Delta<T> 的良好讨论。本质上，它归结为定义Put 和Patch 方法，例如：

public class MyController : ApiController
{
    // Other actions omitted…

    [AcceptVerbs("Patch")]
    public async Task<IHttpActionResult> Patch(int key, Delta<Item> model)
    {
        var entity = _items.FindAsync(o => o.Id == key);

        if (entity == null) {
            return NotFound();
        }

        model.Patch(entity);

        return StatusCode(HttpStatusCode.NoContent);
    }

    public async Task<IHttpActionResult> Put(int key, Delta<Item> model)
    {
        var entity = _items.FindAsync(o => o.Id == key);

        if (entity == null) {
            return NotFound();
        }

        model.Put(entity);

        return StatusCode(HttpStatusCode.NoContent);
    }
}

这里对Put 的请求将更新整个模型，而对Patch 的请求将仅更新模型的一部分（仅使用客户端传递的属性）。

Answer 3

这肯定是一个持久性问题，而不是模型绑定器问题。

您的 API 为给定属性提供了一个空值，因此活页夹正在兑现它。

也许在持久性中，您可以建议您使用哪个框架来忽略空条目（我假设您传递的是可为空的 int?s 而不仅仅是 int）

Answer 4

我用这个模式解决了这个问题。

public class ValuesController : ApiController
{
    public void Put(int id, [FromBody]Item value)
    {
        if (value.NameSpecified)
        {

        }
        else
        {

        }
    }
}

public class Item
{
    internal bool NameSpecified = false;
    private string name;
    public string Name
    {
        get { return name; }
        set
        {
            name = value;
            NameSpecified = true;
        }
    }
}