OData v4客户端自定义SubItemCount属性排序/过滤报错求助

问题场景 #

服务器端定义实体如下：

public partial class MyModel 
{
    public string ModelCode { get; set; }
    public virtual ICollection<MyModelSubItem> SubItems { get; set; } = new HashSet<MyModelSubItem>();
    [NotMapped]
    public IDictionary<string, object> DynamicProperties { get; set; }
}

public partial class MyModelSubItem
{
    public string SubItemCode { get; set; }
}

控制器代码：

[EnableQuery]
public IQueryable<MyModel> Get()
{
    return _myModelContext.GetAll();
}

客户端通过分部类扩展MyModel：

public partial class MyModel 
{
    public int SubItemCount => SubItems.Count;
}

当客户端发起包含该扩展属性的查询（请求地址：/odata/v1/MyModel?$filter=true&$orderby=SubItemCount%20desc）时，抛出异常：

System.ArgumentException: Static property requires null instance, non-static property requires non-null instance. (Parameter 'instance')

仅涉及该扩展属性的过滤/排序操作异常，其他非动态属性查询、动态属性的新增/修改操作均正常。当前使用OData v4及Unchase OData客户端代码生成器。

报错原因 #

1. 客户端定义的SubItemCount是本地计算属性，未在服务端的OData元数据中注册。服务端无法识别该属性，在反射解析查询条件时，因找不到对应属性定义，导致实例与属性的匹配逻辑抛出异常。
2. OData的$filter、$orderby等查询操作是在服务端执行的，必须依赖服务端元数据中存在的属性，客户端本地扩展的属性无法被服务端处理。

解决方法 #

方案1：服务端添加计算属性并注册到元数据 #

在服务端的MyModel类中添加SubItemCount计算属性，并确保它被纳入OData实体模型：

public partial class MyModel 
{
    public string ModelCode { get; set; }
    public virtual ICollection<MyModelSubItem> SubItems { get; set; } = new HashSet<MyModelSubItem>();
    [NotMapped]
    public IDictionary<string, object> DynamicProperties { get; set; }
    
    // 服务端新增计算属性，兼容SubItems为null的情况
    public int SubItemCount => SubItems?.Count ?? 0;
}

若OData模型构建器未自动识别该属性，需显式配置：

// 在OData模型配置代码中添加
builder.EntityType<MyModel>().Property(m => m.SubItemCount);

更新服务端后，重新生成客户端代码，即可直接使用该属性发起查询。

方案2：客户端本地处理排序/过滤 #

若无法修改服务端，可先将全量数据拉取到客户端，再本地执行过滤和排序：

// 拉取所有MyModel数据
var allModels = await myODataClient.MyModel.ExecuteAsync();
// 本地按SubItemCount降序排序
var sortedModels = allModels.OrderByDescending(m => m.SubItemCount).ToList();

注意：该方案仅适用于数据量较小的场景，大量数据会导致性能瓶颈。

方案3：使用OData原生集合计数语法 #

直接利用OData的$count扩展语法，无需自定义属性即可实现基于子项数量的排序/过滤：

• 按子项数量降序排序请求：/odata/v1/MyModel?$orderby=SubItems/$count desc
• 过滤子项数量大于0的条目：/odata/v1/MyModel?$filter=SubItems/$count gt 0
  该方案无需修改任何代码，直接借助OData原生功能实现需求。

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