返回含实体POCO的OData自定义函数序列化失败问题

你的问题核心是同一POCO既要作为带[Key]的实体支持IQueryable控制器，又要在自定义函数中作为可序列化的复杂类型属性，而旧版OData（7.8.2）不允许同一类型同时被标记为EntityType和ComplexType。不需要完全重复POCO，有以下两种可行的变通方案：

方案1：投影到无Key的包装DTO（推荐） #

• 保留原有带[Key]特性的ArJrnl/ApJrnl实体，确保常规IQueryable控制器正常工作。
• 创建一个仅用于自定义函数返回的包装类（比如OSA_JournalsResult），其中：
  • 保留GLTotals复杂类型集合属性
  • 添加无[Key]特性的ArDetailsDto/ApDetailsDto集合属性，结构与原实体一致但去掉[Key]
• 在自定义函数中，将原ArJrnl/ApJrnl实体通过LINQ投影转换为对应的DTO：

  var result = new OSA_JournalsResult
  {
      GLTotals = ..., // 原有复杂类型数据
      ArDetails = arJournals.Select(a => new ArDetailsDto 
      {
          // 映射原实体的属性
          Id = a.Id,
          Amount = a.Amount,
          // 其他属性...
      }).ToList(),
      ApDetails = apJournals.Select(a => new ApDetailsDto { ... }).ToList()
  };
  return result;
  

• 最后在OData模型中注册OSA_JournalsResult为ComplexType，这样所有属性都能正常序列化。

这个方案完全隔离了原有实体和自定义函数的返回类型，不需要修改任何现有业务代码，仅需新增少量DTO类，维护成本极低。

方案2：手动构建EDM模型，为自定义函数单独配置返回类型 #

• 保留原有ArJrnl/ApJrnl实体的[Key]特性，正常注册为EntityType以支持IQueryable控制器。
• 在构建OData EDM模型时，单独为自定义函数的返回类型创建一个ComplexType版本的OSA_Journals：

  var builder = new ODataConventionModelBuilder();
  // 注册原有实体控制器所需的EntityType
  builder.EntitySet<ArJrnl>("ArJrnl");
  builder.EntitySet<ApJrnl>("ApJrnl");
  
  // 为自定义函数创建专用的ComplexType
  var osaJournalsComplexType = builder.ComplexType<OSA_Journals>();
  // 手动将ArDetails/ApDetails标记为ComplexType集合，而非NavigationProperty
  osaJournalsComplexType.CollectionProperty<ArJrnl>(nameof(OSA_Journals.ArDetails));
  osaJournalsComplexType.CollectionProperty<ApJrnl>(nameof(OSA_Journals.ApDetails));
  osaJournalsComplexType.CollectionProperty<GLTotal>(nameof(OSA_Journals.GLTotals));
  
  // 注册自定义函数，指定返回上述ComplexType
  var function = builder.Function("GetOSAJournals");
  function.ReturnsCollection<OSA_Journals>();
  

• 注意：旧版OData可能需要额外处理序列化逻辑，确保自定义函数返回的对象使用ComplexType元数据而非EntityType，因此方案1更稳妥。

核心限制说明 #

OData 7.8.2遵循OData规范，一个类型只能被标记为EntityType（带Key）或ComplexType（无Key），无法同时兼具两种身份，这是无法直接绕过的底层约束，因此必须通过上述变通方案解决。

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