武装你的WEBAPI-OData聚合查询

合集 - OData(13)

1.武装你的WEBAPI-OData入门2020-05-122.武装你的WEBAPI-OData便捷查询2020-05-133.武装你的WEBAPI-OData分页查询2020-05-184.武装你的WEBAPI-OData资源更新Delta2020-07-075.武装你的WEBAPI-OData使用Endpoint05-096.武装你的WEBAPI-OData之API版本管理05-057.武装你的WEBAPI-OData常见问题2021-02-02

8.武装你的WEBAPI-OData聚合查询03-27

9.武装你的WEBAPI-OData与DTO05-0810.OData WebAPI实践-OData与EDM05-1111.OData WebAPI实践-Non-EDM模式05-1212.OData WebAPI实践-兼容OData集合响应05-1513.OData WebAPI实践-与ABP vNext集成05-16

收起

本文属于OData系列

Introduction

ODATA v4提出了新的聚合查询功能，这对于ODATA的基本查询能力（$expand等）是一个非常大的补充。ODATA支持的聚合查询功能，可以对数据进行统计分析，例如求和、平均值、最大/最小值、分组等。

聚合查询是通过$apply关键字实现的。使用$apply关键字可以指定一系列的聚合操作，以对数据进行处理。

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

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

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

聚合查询示例

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

public class AttachDeviceType
    {
        /// 

        /// 
        /// 
        [Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        public int Id { get; set; }
        /// 

        /// 附加设备的类型
        /// 
        public string Name { get; set; }
        /// 

        /// 描述
        /// 
        public string Description { get; set; }
    }

   public abstract class AttachDeviceInfo
    {
        /// 

        /// 
        /// 
        [Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        public int Id { get; set; }
        [Required]
        public string AttachDeviceId { get; set; }
        public string Name { get; set; }
        /// 

        /// 附加设备的类型
        /// 
        public virtual AttachDeviceType AttachDeviceType { get; set; }
        public string? Description { get; set; }

        public virtual DeviceInfo DeviceInfo { get; set; }
    }

   public class DeviceInfo
    {
        /// 

        /// 
        /// 
        [Key]
        [MaxLength(200)]
        public string DeviceId { get; set; }
        /// 

        /// 地域位置的代码
        /// 
        public int? Adcode { get; set; }

        public virtual ICollection AttachDevices { get; set; }
    }

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

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

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

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

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

换一个思路，我们使用每一个实体对象的属性作为统计对象。

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

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

[

    {

        "deviceInfo": {

            "adcode": 110105

        },

        "NumTypes": 1,

        "NumDevices": 1,

        "NumAttachDevices": 2

    },

    {

        "deviceInfo": {

            "adcode": 110108

        },

        "NumTypes": 1,

        "NumDevices": 1,

        "NumAttachDevices": 1

    }
]

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

/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发送的请求一致。
更新：经过调查，默认的空格-》+，/-》%2f等转义不会影响到OData的正常识别，正常使用即可。

总结

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