基于OData与Entity Framework的过提交/欠提交问题处理方案

在Web API开发中，区分数据库实体（Entity）和面向客户端的数据传输对象（DTO）是常规实践，示例代码如下：

public class Product  // 数据库实体
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string SerialNumber { get; set; }
    public string ReferenceNumber { get; set; }
    public DateTime RecordTimestamp { get; set; }
    public string InternalNumber { get; set; }
}

public class ProductDto  // 客户端DTO
{
    public string Name { get; set; }
    public string SerialNumber { get; set; }
    public string ReferenceNumber { get; set; }
} 

当前核心需求：GET查询时隐藏RecordTimestamp、InternalNumber这类系统相关字段，但POST等CRUD操作需要保留完整实体属性以支持业务逻辑。而常规OData控制器返回指向DbSet<T>的IQueryable<T>，由OData框架处理查询请求，由此带来两个问题：

• 能否通过属性（如模型绑定特性）实现GET/POST的字段区分？
• 是否需要为GET和POST分别创建独立模型？若创建独立模型，GET模型是否必须保留Key字段？

可行解决方案 #

1. 为GET和POST分别创建专用模型（推荐）

这种方式逻辑清晰，符合单一职责原则，是OData场景下的标准做法：

• 创建ProductReadDto（供GET接口使用）：必须包含Id字段（OData依赖Key属性构建关联关系、处理路由与查询），只保留需要暴露给客户端的字段：

  public class ProductReadDto
  {
      public int Id { get; set; }
      public string Name { get; set; }
      public string SerialNumber { get; set; }
      public string ReferenceNumber { get; set; }
  }
  

• 创建ProductCreateDto（供POST接口使用）：根据客户端提交需求定义字段，无需包含系统自动生成的字段（如Id、RecordTimestamp）：

  public class ProductCreateDto
  {
      public string Name { get; set; }
      public string SerialNumber { get; set; }
      public string ReferenceNumber { get; set; }
  }
  

• 控制器实现：
  • GET操作将数据库实体投影到ProductReadDto，可使用LINQ的Select方法或AutoMapper的ProjectTo（支持IQueryable，保证查询在数据库层面执行）：

    [EnableQuery]
    public IQueryable<ProductReadDto> Get()
    {
        return _context.Products.Select(p => new ProductReadDto
        {
            Id = p.Id,
            Name = p.Name,
            SerialNumber = p.SerialNumber,
            ReferenceNumber = p.ReferenceNumber
        });
    }
    

  • POST操作接收ProductCreateDto，映射为Product实体后保存：

    public async Task<IActionResult> Post([FromBody] ProductCreateDto dto)
    {
        var product = new Product
        {
            Name = dto.Name,
            SerialNumber = dto.SerialNumber,
            ReferenceNumber = dto.ReferenceNumber,
            RecordTimestamp = DateTime.UtcNow,
            InternalNumber = GenerateInternalNumber()
        };
        _context.Products.Add(product);
        await _context.SaveChangesAsync();
        return Created(product);
    }
    

• OData模型配置：为ProductReadDto指定Key属性（通过[Key]特性或模型构建器）：

  builder.EntitySet<ProductReadDto>("Products");
  builder.EntityType<ProductReadDto>().HasKey(p => p.Id);
  

2. 使用OData特性全局隐藏字段（仅适用于全接口隐藏场景）

如果某个字段在所有接口中都不需要暴露给客户端，可在实体类的对应属性上添加[IgnoreDataMember]特性：

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string SerialNumber { get; set; }
    public string ReferenceNumber { get; set; }
    [IgnoreDataMember]
    public DateTime RecordTimestamp { get; set; }
    [IgnoreDataMember]
    public string InternalNumber { get; set; }
}

但这种方式无法区分GET和POST场景，若POST需要使用该字段，此方法不适用。

3. 模型绑定过滤器（不推荐）

尝试通过自定义ActionFilter在序列化阶段移除不需要的字段，但OData的序列化依赖Edm模型定义，这种方式容易出现兼容性问题，且无法保证OData查询的正确性，因此不推荐。

总结 #

最可靠的方案是为GET和POST分别创建专用模型，既满足OData对Key属性的依赖，又能严格隔离不同接口的字段权限，同时保证代码的可维护性。

内容的提问来源于stack exchange，提问作者T.S.