武装你的WEBAPI-OData聚合查询

WEBAPI,OData,武装 · 浏览次数 : 434

小编点评

**聚合查询简介** ODATA 4提供了新的聚合查询功能,可以对数据进行统计分析。聚合查询可以通过 `$apply`关键字实现,该关键字可以指定一系列聚合操作,以对数据进行处理。 **聚合查询示例** 以下示例展示如何使用 `$apply`关键字实现聚合查询: ```odata GET /odata/Products?$apply=groupby((Category), aggregate(Price with sum as TotalSales)) ``` 该请求将返回按照产品类别(Category)分组的数据,并计算每个组的销售总额(TotalSales)。 **聚合查询的优点** *赋予前端更多的自主权,让他们自己获得自己需要的数据。 * 可以实现非常多复杂的、以前只能在后端单独实现的查询。 * 可以使用多种聚合函数,以进行复杂的分析。 **注意** * 聚合查询出来的结果一般不会在 EDM 中注册,因此无法对结果应用更多ODATA 查询。 * 为了解锁聚合查询能力,请手动在 EDM 中注册该类型。

正文

本文属于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
    {
        /// <summary>
        /// 
        /// </summary>
        [Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        public int Id { get; set; }
        /// <summary>
        /// 附加设备的类型
        /// </summary>
        public string Name { get; set; }
        /// <summary>
        /// 描述
        /// </summary>
        public string Description { get; set; }
    }
   public abstract class AttachDeviceInfo
    {
        /// <summary>
        /// 
        /// </summary>
        [Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        public int Id { get; set; }
        [Required]
        public string AttachDeviceId { get; set; }
        public string Name { get; set; }
        /// <summary>
        /// 附加设备的类型
        /// </summary>
        public virtual AttachDeviceType AttachDeviceType { get; set; }
        public string? Description { get; set; }

        public virtual DeviceInfo DeviceInfo { get; set; }
    }
   public class DeviceInfo
    {
        /// <summary>
        /// 
        /// </summary>
        [Key]
        [MaxLength(200)]
        public string DeviceId { get; set; }
        /// <summary>
        /// 地域位置的代码
        /// </summary>
        public int? Adcode { get; set; }

        public virtual ICollection<AttachDeviceInfo> 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标准的文档

与武装你的WEBAPI-OData聚合查询相似的内容:

武装你的WEBAPI-OData聚合查询

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

武装你的WEBAPI-OData之API版本管理

本文属于OData系列 Intro 对外提供WEBAPI时,如果遇上了版本升级,那么控制WEBAPI的版本也是非常必要的。OData官方提供了版本控制以及管理的解决方案,我个人是实践体会是不好用,好在社区提供了对应的nuget包,与.NET主版本同步更新。 介绍 ASP.NET API Versio

武装你的WEBAPI-OData与DTO

本文属于OData系列文章 Intro 前面写了很多有关OData使用的文章,很多读者会有疑问,直接将实体对象暴露给最终用户会不会有风险?$expand在默认配置的情况下,数据会不会有泄露风险? 答案是肯定的,由于OData的特性,提供给我们便捷同时也会带来一些风险。很多地方推荐使用DTO模式来隔离

武装你的WEBAPI-OData使用Endpoint

本文属于 OData 系列文章 Introduction 更新: 由于新版的 OData 已经默认使用了 endpoint 模式(Microsoft.AspNetCore.OData 8.0.0),不再需要额外配置,本文已经过时(asp.net core 3.1)。 最近看 OData 的 devb

颜值经济下,车企的必备武器

摘要:对于买车的你,除了性价比,“颜价比”占多少呢? 新消费需求的冲击 时代赋予新时代年轻人丰富多彩的物质世界,他们受到互联网、即时通讯、智能手机等科技产物的影响很大,这个群体在消费方面既感性又理性,正在逐渐成为消费的主力军。 根据《2020年中国消费者调查报告》,二线及以下城市“年轻购物达人”仅占

DTT第7期直播回顾 | 低代码应用构建流程和适用场景,与你想的一样吗?

摘要:本期直播主题是《揭秘华为云低代码技术微认证》,向开发者们讲述低代码的发展历程,介绍华为低代码平台应用魔方AppCube的开发能力,解读华为低代码的认证和学习体系 本期直播详解 本期直播主题是《揭秘华为云低代码技术微认证》,华为云PaaS服务产品部资深专家董鑫武向开发者们讲述低代码的发展历程,介

[转帖]调优"四剑客"的实战演练,福尔摩斯•K带你轻松优化性能

前言 天下武功,唯快不破。在侦探的世界中,破案效率永远是衡量一名侦探能力的不二法门。作为推理界冉冉升起的新星,大侦探福尔摩斯·K凭借着冷静的头脑、严谨的思维,为我们展现了一场场华丽而热血的推理盛宴。 接下来,我们不仅仅是看客,还将追随福尔摩斯·K的脚步,体验一场身临其境的冒险。一起寻访产生数据库性能

前端远程办公系列 —— 整体介绍

整体介绍 前言 有些公司需要你有远程办公的经验 远程办公是某些公司和组织的一种工作方式。比如公司运作以天津为根据地,还有一些团队在武汉,忙不过来时还有外包 本系列就以前端工程师的视角,以一个真实的场景来说一下这个事情。会说遇到了什么问题、如何协作、用到什么新工具,什么技术... 背景 张三,一直从事

超快的 Python 包管理工具「GitHub 热点速览」

天下武功,无坚不破,唯快不破! 要想赢得程序员的欢心,工具的速度至关重要。仅需这一优势,即可使其在众多竞争对手中脱颖而出,迅速赢得开发者的偏爱。以这款号称下一代极速 Python 包管理工具——uv 为例,它的核心竞争力在于「快」和「丝滑替代」。自年初开源以来,不到半年便实现了 Star 数破万的壮

比赛获奖的武林秘籍:07 一文速通电子设计大赛,电子人必看的获奖秘籍

本文主要介绍了全国大学生电子设计大赛的含义、比赛形式、组队技巧,结合自身经历讲解了备赛指南,同时对往年题目进行了分析和总结。