使用Delta<T>进行OData Patch无更新问题排查求助

1. 核对OData路由配置 #

• 确保Program.cs中正确启用OData并配置实体集，示例代码：

  builder.Services.AddControllers().AddOData(options =>
      options.Select().Filter().OrderBy().Expand().Count().SetMaxTop(100)
          .AddRouteComponents("odata", GetEdmModel()));
  
  static IEdmModel GetEdmModel()
  {
      ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
      builder.EntitySet<Customer>("Customers");
      return builder.GetEdmModel();
  }
  

• 控制器Patch方法需匹配OData路由规范，比如使用[ODataRoute("Customers({customerId})")]或[HttpPatch("odata/Customers({customerId})")]，保证请求路径与配置一致。

2. 检查Customer实体类属性 #

• 确认name属性为可读写，不能仅设置getter：

  public class Customer
  {
      public int CustomerId { get; set; }
      public string Name { get; set; } // 必须同时包含get和set访问器
  }
  

• 排查是否存在[ReadOnly(true)]这类限制注解；若请求Body用小写name、实体用大写Name，默认OData可自动映射，若自定义了序列化配置，需确保大小写匹配或开启忽略大小写。

3. 验证Patch方法参数绑定 #

• 控制器方法需用[FromBody]标记Delta参数，确保请求体正确绑定，示例代码：

  [HttpPatch("odata/Customers({customerId})")]
  public IActionResult Patch(int customerId, [FromBody] Delta<Customer> delta)
  {
      var customer = _dbContext.Customers.FirstOrDefault(c => c.CustomerId == customerId);
      if (customer == null) return NotFound();
      
      delta.Patch(customer);
      _dbContext.SaveChanges();
      return Ok(customer);
  }
  

• 不可省略[FromBody]，否则Delta无法读取请求体数据。

4. 确认请求Content-Type头 #

• 确保请求的Content-Type为application/json或application/json-patch+json，错误的媒体类型会导致OData无法正确解析请求体到Delta。

5. 排查版本兼容性 #

• 核对Microsoft.AspNetCore.OData v9.3.0与.NET 8的兼容情况，确保相关依赖包（如EntityFrameworkCore）版本与.NET 8匹配。

6. 调试绑定过程 #

• 可在控制器中添加代码验证请求体是否正常接收：

  var requestBody = await new StreamReader(Request.Body).ReadToEndAsync();
  // 查看requestBody是否为{"name": "XXX"}，确认请求数据到达服务器
  

• 若请求体正常但Delta的GetChangedPropertyNames()为空，检查是否修改了默认Json序列化配置，避免影响OData绑定，示例：

  builder.Services.AddControllers().AddJsonOptions(options =>
  {
      options.JsonSerializerOptions.PropertyNameCaseInsensitive = true;
      // 避免添加可能干扰OData的特殊序列化规则
  }).AddOData(...);
  

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