OData使用笔记

最新推荐文章于 2025-11-20 22:13:57 发布

原创最新推荐文章于 2025-11-20 22:13:57 发布 · 939 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java #协议栈

笔记专栏收录该内容

4 篇文章

订阅专栏

OData是一种开放协议，用于创建和消费查询和协作的RESTful API。它支持通过GET请求进行查询、分页、排序和过滤。例如，使用$offset和$limit进行分页，$filter进行条件查询（如eq, like, gt, lt），并用$orderby进行排序（asc或desc）。此外，查询结果可以返回JSON对象，包含items数组和可选的count属性以显示总数。

OData 协议

OData一个开放的协议以一种简单的规范方式来创建和消费可查询和可协作的RESTfulAPIS。

GET请求：查询，分页，排序在Request请求中以键值对的方式传递。

offset,$limit 完成分页查询

xxxxxx.com?$offset=0 => 偏移量为0。 xxxxxx.com?$limit=15 => 每页个数为15。 xxxxxx.com?$offset=0&$limit=15 => 偏移量为0，每页个数为15。

（1）操作符
2、$filter 完成条件查询
eq 表示『相等』； xxxxxx.com?$filter=age eq 10 => 查询age等于10的记录
like 表示『模糊查询』； xxxxxx.com?$filter=name like xxx => 查询对name进行模糊匹配的记录
gt 表示『大于』； xxxxxx.com?$filter=age gt 10 => 查询age大于10的记录
lt 表示『小于』；xxxxxx.com?$filter=age lt 10 => 查询age小于10的记录
（2）逻辑组合
and 表示『且』；xxxxxx.com?$filter=name like xxx and age eq 10 => 查询age等于10且对name进行模糊匹配的记录
or 表示『或』；xxxxxx.com?$filter=name like xxx or age eq 10 => 查询age等于10或对name进行模糊匹配的记录
总结：格式是单个条件=属性名操作符值；$fitler= 单个条件 [逻辑单个条件...]

3、$orderby 完成排序查询

desc 降序；xxxxxx.com?$orderby=createdAt desc => createdAt 字段倒序
asc 升序；xxxxxx.com?$orderby=updatedAt asc => updatedAt 字段增序
总结：格式是$orderby=属性名 asc|desc

4、返回结构
返回JSON对象，结构体如下：

默认情况，无count（总数）

{ "items":[ ...... ] }

需要count，则代码查询条件

$count=true；xxxxxx.com?$count=true

{ "items":[ ...... ], "count":10 }