使用OData v4与EF构建API时忽略POST中JSON属性的问题

嗨，这个问题我太熟了！我之前在做类似的API时也踩过同样的坑——EF的[NotMapped]或者Ignore()配置只影响数据库映射，根本管不到OData的请求校验。OData是基于自己的EDM（实体数据模型）来校验请求体结构的，只要请求里有EDM模型没定义的属性，它就会抛出“不支持”的错误。

下面给你两种靠谱的解决方案，按需选择：

方案一：使用DTO（推荐，类型安全） #

这是最规范的做法，专门创建一个用于接收POST请求的传输对象，包含业务需要的所有属性（包括额外的extraProperty）：

1. 创建ItemCreateDto #

public class ItemCreateDto
{
    // 复制Item实体中需要接收的核心属性
    public string Name { get; set; }
    public int Quantity { get; set; }
    // 你的额外属性
    public string ExtraProperty { get; set; }
}

2. 把DTO注册到OData的EDM模型里 #

在构建EDM模型的方法中，把这个DTO也注册进去，让OData知道它是合法的请求类型：

public IEdmModel GetEdmModel()
{
    var builder = new ODataConventionModelBuilder();
    // 注册实体集（用于查询/返回）
    builder.EntitySet<Item>("Items");
    // 注册创建用的DTO（用于接收POST请求）
    builder.EntityType<ItemCreateDto>();
    return builder.GetEdmModel();
}

3. 修改控制器的POST方法 #

让方法接收ItemCreateDto，再把需要的属性映射到Item实体，同时你可以自由处理ExtraProperty：

[HttpPost]
public async Task<IActionResult> Post([FromBody] ItemCreateDto createDto)
{
    if (!ModelState.IsValid)
        return BadRequest(ModelState);

    // 处理extraProperty的逻辑（比如记录日志、调用其他服务等）
    if (!string.IsNullOrEmpty(createDto.ExtraProperty))
    {
        // do something with createDto.ExtraProperty
    }

    // 映射DTO到EF实体
    var item = new Item
    {
        Name = createDto.Name,
        Quantity = createDto.Quantity
        // 不需要映射ExtraProperty，因为EF已经用[NotMapped]/Ignore忽略它了
    };

    _context.Items.Add(item);
    await _context.SaveChangesAsync();

    return CreatedAtAction(nameof(GetItem), new { id = item.Id }, item);
}

方案二：直接在OData EDM模型中忽略额外属性 #

如果不想创建DTO，也可以在OData的模型构建中显式忽略Item实体上的extraProperty，这样OData就不会校验这个属性的存在：

public IEdmModel GetEdmModel()
{
    var builder = new ODataConventionModelBuilder();
    var itemEntity = builder.EntitySet<Item>("Items").EntityType;
    // 让OData忽略这个属性
    itemEntity.Ignore(t => t.ExtraProperty);
    return builder.GetEdmModel();
}

不过要注意：这种方式下，OData会自动丢弃请求体中的extraProperty，如果你需要在API中使用这个属性的值，这种方法就不适用了——还是方案一更灵活。

为什么之前的方法没用？ #

再啰嗦一句：EF的配置（[NotMapped]、Ignore()）是给EF Core看的，告诉它不要把这个属性映射到数据库字段；但OData的EDM模型是独立的，它只会根据你注册的模型来校验请求结构。你之前只配置了EF，没同步更新OData的模型，所以OData还是认为Item类型不包含extraProperty，自然就报错了。

内容的提问来源于stack exchange，提问作者Toodoo