武装你的WEBAPI-OData聚合查询

宇宙稊米

本文属于OData系列
目录

• 武装你的WEBAPI-OData入门
  
• 武装你的WEBAPI-OData便捷查询
  
• 武装你的WEBAPI-OData分页查询
  
• 武装你的WEBAPI-OData资源更新Delta
  
• 武装你的WEBAPI-OData之EDM
  
• 武装你的WEBAPI-OData常见问题
  
• 武装你的WEBAPI-OData使用Endpoint
  
• 武装你的WEBAPI-OData聚合查询
  

ODATA v4提出了新的聚合查询功能，这对于ODATA的基本查询能力（$expand等）是一个非常大的补充。ODATA支持的聚合查询功能，可以对数据进行统计分析，例如求和、平均值、最大/最小值、分组等。
聚合查询是通过$apply关键字实现的。使用$apply关键字可以指定一系列的聚合操作，以对数据进行处理。

1. GET /odata/Products?$apply=groupby((Category), aggregate(Price with sum as TotalSales))

复制代码

该请求将返回按照产品类别（Category）分组的数据，并计算每个组的销售总额（TotalSales）。

需要注意，聚合查询出来的结果一般都不在EDM中注册，因此无法对结果应用更多ODATA查询，如果想解锁这个能力，请手动在EDM中注册这个类型。

聚合查询示例

ODATA的强大之处在于可以赋予前端更多的自主权，让他们自己获得自己需要的数据，通过聚合查询，我们可以实现非常多复杂的、以前只能在后端单独实现的查询。举例说明，我们有以下三个实体类。

1. public class AttachDeviceType
2.     {
3.         /// <summary>
4.         ///
5.         /// </summary>
6.         [Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
7.         public int Id { get; set; }
8.         /// <summary>
9.         /// 附加设备的类型
10.         /// </summary>
11.         public string Name { get; set; }
12.         /// <summary>
13.         /// 描述
14.         /// </summary>
15.         public string Description { get; set; }
16.     }

复制代码

1.    public abstract class AttachDeviceInfo
2.     {
3.         /// <summary>
4.         ///
5.         /// </summary>
6.         [Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
7.         public int Id { get; set; }
8.         [Required]
9.         public string AttachDeviceId { get; set; }
10.         public string Name { get; set; }
11.         /// <summary>
12.         /// 附加设备的类型
13.         /// </summary>
14.         public virtual AttachDeviceType AttachDeviceType { get; set; }
15.         public string? Description { get; set; }
17.         public virtual DeviceInfo DeviceInfo { get; set; }
18.     }

复制代码

1.    public class DeviceInfo
2.     {
3.         /// <summary>
4.         ///
5.         /// </summary>
6.         [Key]
7.         [MaxLength(200)]
8.         public string DeviceId { get; set; }
9.         /// <summary>
10.         /// 地域位置的代码
11.         /// </summary>
12.         public int? Adcode { get; set; }
14.         public virtual ICollection<AttachDeviceInfo> AttachDevices { get; set; }
15.     }

复制代码

以上三个类定义了主设备、附加设备与从属设备的类型，三者之间通过导航属性进行连接。假定我们需要按照地域位置代码进行分组查询，查询出每个地域的所有主设备的、附加设备的和不同的类型的数量。

1. /odata/DeviceInfos?$apply=groupby((Adcode), aggregate(AttachDevices/$count as NumAttachDevices, $count as NumDeviceInfos, AttachDevices/AttachDeviceType/$countdistinct as NumAttachDeviceTypes))

复制代码

或者我们使用以attachdevice作为目标

1. /odata/AttachDeviceInfo?$apply=groupby((DeviceInfo/Adcode), aggregate(
2.         $count as TotalDeviceInfo,
3.         attachdevices/$count as TotalAttachDevices,
4.         AttachDeviceType/$countdistinct as TotalAttachDeviceTypes))

复制代码

思路没有问题，但是实际执行会提示$count不是可用的aggregatebinder之类的错误(Binding OData QueryNode of kind 'Count' is not supported by 'AggregationBinder'.)。这是因为$count已经是OData进行查询得到的结果，这个结果不能在进行的聚合查询了。
换一个思路，我们使用每一个实体对象的属性作为统计对象。

1. odata/attachdeviceinfos?$apply=groupby((deviceinfo/Adcode), aggregate($count as NumAttachDevices, deviceinfo/deviceid with countdistinct as NumDevices, attachdevicetype/id with countdistinct as NumTypes))

复制代码

那么就可以得到正确的结果：

1. [
3.     {
5.         "deviceInfo": {
7.             "adcode": 110105
9.         },
11.         "NumTypes": 1,
13.         "NumDevices": 1,
15.         "NumAttachDevices": 2
17.     },
19.     {
21.         "deviceInfo": {
23.             "adcode": 110108
25.         },
27.         "NumTypes": 1,
29.         "NumDevices": 1,
31.         "NumAttachDevices": 1
33.     }
34. ]

复制代码

当然，我们还可以组合使用filter查询：

1. /odata/attachdeviceinfos?$apply=filter(deviceinfo/Adcode eq 110105)/groupby((deviceinfo/Adcode), aggregate($count as NumAttachDevices, deviceinfo/deviceid with countdistinct as NumDevices, attachdevicetype/id with countdistinct as NumTypes))

复制代码

注意：在AXIOS中，前端发送如/之类的特殊字符会自动进行转移，导致查询请求失败，请前端搜索禁止AXIOS自动转移的方法，以保证发送的请求同POSTMAN发送的请求一致。

总结

使用聚合查询可以方便将原来需要后端单独编程的分类、统计等操作简化，给予了前端非常大的自由度，同时减少了后端的接口数量。需要注意的是，很多操作在聚合查询中语法可能有一些变化，请一定参阅ODATA的OASIS标准的文档。

来源:https://www.cnblogs.com/podolski/archive/2023/03/27/17261079.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！