mvc api odata 查询选项之 $inlinecount ,$format 选项
网上百度“odata 语法”会出来很多结果,其中有一项是比较一致的,那就是odata支持一下几种语法:
$filter 条件表达式 -- 对应sql语句的where条件查询,如:/Categories?$filter=name eq 'liumang'
$expand 包含属性和关系 -- 对应表的外键关系,如:/Categories?$expand=Products
$select 查询字段的列表 -- 对应sql语句select后面的字段,如:/Categories?$select=id,name
$count 查询数量 -- 根据当前查询条件返回的总记录数,如Categories表中有10条记录,则/Categories?count 或者 /Categories?count=true
(ps:这条我没有找到具体确切的用法,在AllowedQueryOptions 枚举中也没有列出这条选项)
$orderby 排序 -- 对应sql语句order by语句,如:/Categories?$orderby=id,name ,/Categories?$orderby=id,name desc(asc) ,/Categories?$orderby=id desc,name asc
$skip 当前查询跳过多少条数据,再返回查询结果,如:/Categories?$orderby=id&$skip=10,如果id是连续的话,那么返回从id=11之后的所有数据
$top 返回当前查询的前多少条数据,如/Categories?$top=10
skip 和top 一般是配合一起使用,用来做分页查询,如/Categories?$skip=10&$top=10 ,/Categories?$skip=20&$top=10 ,这样就可以做出一个pagesize 为10的分页查询了
$inlinecount 返回当前查询条件的所有记录数,如:/Categories?$inlinecount=allpages ,如果Categories有23条数据,则返回23
$skiptoken 例如游标或者书签的一个东西
$metadata 显示元数据
以上是在网上找到的相关资料,资料很齐全,很多都给出了案列,但是在我实际的使用中,却只有几项数据能够使用,其他的都不适用,我分析原因可能如下 :
1:我做的项目是集成在mvc和api里面的,而网上的很多例子大都是wcf的案列,我不太清楚是不是这个原因,因为wcf我只知道皮毛,没有深入
2:在程序集 System.Web.Http.OData.dll, v4.0.0.0 中有这样一段注释:
//
// 摘要:
// 获取或设置允许在查询内部使用的查询参数。默认值为所有查询选项,包括 $filter、$skip、$top、$orderby、$expand、$select、$inlineCount、$format
// 和 $skipToken。
//
// 返回结果:
// 返回 System.Web.Http.OData.Query.AllowedQueryOptions。
public AllowedQueryOptions AllowedQueryOptions { get; set; }
可以看出 AllowedQueryOptions 枚举和上面列出的还是有一些出入的
3:同样在程序集 System.Web.Http.OData.dll, v4.0.0.0 中还有这样一段注释:
namespace System.Web.Http.OData.Query // 摘要:
// 此项定义可用于执行查询撰写的复合 OData 查询选项。此项当前仅支持 $filter、$orderby、$top 和 $skip。
//
// 类型参数:
// TEntity:
[ODataQueryParameterBinding]
public class ODataQueryOptions<TEntity> : ODataQueryOptions
可以看出只支持四个选项,这和我在项目中的使用情况是一致的。
ps:让我疑惑的一点就是,odata 4.0里面是支持我上面列出的所有查询选项的,而在api 2.2发布的时候则是明确表示支持odata 4.0的,我不知道是什么原因导致我现在的项目中只支持四个选项.
说了这么多后,回到主题上面来,在项目中其实 $filter、$orderby、$top 和 $skip 四个选项是可以支持90%左右的查询功能的
其余10%的功能比如:分页查询时必须知道的总记录数、返回json字符串、外键关系等
下面说一下我在网上查到的关于$inlinecount ,$format的解决方法
$format
需要odata支持$format参数只需要一句语句即可
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
//添加下面这句代码即可支持$format查询选项,当然需要添加程序集 System.Net.Http.Formatting.dll
config.Formatters.JsonFormatter.AddQueryStringMapping("$format", "json", "application/json");
}
}
$inlinecount
这个也不需要太多复杂的操作,代码如下
public class testController : ApiController
{
testBLL DB = new testBLL();
public PageResult<dict> Get(ODataQueryOptions<dict> options)
{
int pageSize = 10;
ODataQuerySettings settings = new ODataQuerySettings()
{
PageSize = pageSize
}; IQueryable results = options.ApplyTo(DB.FindAll().AsQueryable(), settings); return new PageResult<dict>(
results as IEnumerable<dict>,
Request.GetNextPageLink(),
Request.GetInlineCount());
}
}
查询url : http://localhost:3812/api/test?$skip=20&$inlinecount=allpages
返回格式如下:
int pageSize = options.Top == null ? 10 : options.Top.Value;
在用户选择了记录数时,按照用户选择的设置,可以动态的返回下一页的记录,但是返回的NextPageLink的值却为null,当我去掉top参数时,返回是正常数据
下面是反编译了System.Web.Http.OData.dll之后的源代码 ,我想可能在请求发送过来,在设置参数的时候,判断了过top参数所导致的
public static Uri GetNextPageLink(this HttpRequestMessage request)
{
object obj2;
if (request == null)
{
throw Error.ArgumentNull("request");
}
if (request.get_Properties().TryGetValue("MS_NextPageLink", out obj2))
{
return (obj2 as Uri);
}
return null;
}
上面是$format 和 $inlinecount参数的设置方法,$expand 参数我查到相关资料后再整理。
mvc api odata 查询选项之 $inlinecount ,$format 选项的更多相关文章
- mvc api odata查询选项之 $inlinecount $format 选项(转)
出处:http://www.it165.net/pro/html/201505/40236.html 网上百度“odata 语法”会出来很多结果,其中有一项是比较一致的,那就是odata支持一下几种语 ...
- SharePoint REST API - OData查询操作
博客地址:http://blog.csdn.net/FoxDave 本篇主要讲述SharePoint REST中OData的查询操作.SharePoint REST服务支持很多OData查询字符串 ...
- MVC项目实践,在三层架构下实现SportsStore-09,ASP.NET MVC调用ASP.NET Web API的查询服务
ASP.NET Web API和WCF都体现了REST软件架构风格.在REST中,把一切数据视为资源,所以也是一种面向资源的架构风格.所有的资源都可以通过URI来唯一标识,通过对资源的HTTP操作(G ...
- 使用Dynamics 365 CE Web API查询数据加点料及选项集字段常用查询
微软动态CRM专家罗勇 ,回复336或者20190516可方便获取本文,同时可以在第一间得到我发布的最新博文信息,follow me. 紧接上文:配置Postman通过OAuth 2 implicit ...
- Dynamics 365 We API ODATA语法根据父记录查询子记录,根据子记录查询父记录(附上根据团队,队列名称查成员)
微软动态CRM专家罗勇 ,回复333或者20190508可方便获取本文,同时可以在第一间得到我发布的最新博文信息,follow me! 先举个N:N关系的例子.这里以根据团队的名称查找其所有团队成员的 ...
- 让Asp.Net WebAPI支持OData查询,排序,过滤。
让Asp.Net WebAPI支持OData后,就能支持在url中直接输入排序,过滤条件了. 一.创建Asp.Net WebAPI项目: 二.使用NuGet安装Asp.Net WebAPI 2.2和O ...
- vs2012 + web api + OData + EF + MYsql 开发及部署
先说下我的情况,b/s开发这块已经很久没有搞了,什么web api .MVC.OData都只是听过,没有实际开发过,因为最近要开发一个手机app的服务端,所以准备用这套框架来开发. 下面开始进入正题( ...
- vs2012 + web api + OData + EF + MYsql
vs2012 + web api + OData + EF + MYsql 开发及部署 先说下我的情况,b/s开发这块已经很久没有搞了,什么web api .MVC.OData都只是听过,没有实际开发 ...
- 让Asp.Net WebAPI支持OData查询,排序,过滤。(转)
出处:http://www.cnblogs.com/liuzhendong/p/4233380.html 让Asp.Net WebAPI支持OData后,就能支持在url中直接输入排序,过滤条件了. ...
随机推荐
- xsheell的下载安装初级使用
1)关于Xshell 网上更多的资料里提到的SSH客户端是putty,因为简单.开源.免费.但是也正是由于功能过于简单,所以在这里推荐大家使用Xshell. Xshell最初并不能免费使用,而且也没有 ...
- linearlayout 水平垂直居中
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools=&q ...
- Delphi VclSkin使用教程
1. TSkinData TSkinData 主要用于美化你的程序, 只要把TSkinData控件放下去,它就能自动美化所有窗体. 属性 Active: 使用或取消对程序的美化. DisableT ...
- 【转】从外行的视角尝试讲解为什么这回丰田栽了【全文完】【v1.01】
转自:http://club.tgfcer.com/thread-6817371-1-1.html [第一部分]背景简介 前几年闹得沸沸扬扬的丰田刹不住事件最近又有新进展.十月底俄克拉荷马的一次庭审 ...
- Visual Studio 2005 移植 - WINVER,warning C4996, error LINK1104
Visual Studio 2005 移植 - WINVER,warning C4996, error LINK1104 一.WINVER Compile result: WINVER not d ...
- LR之错误处理
1.脚本的健壮性 2.VuGen的处理机制 3.lr_continue_on_error函数 4.示例代码
- Chapter12:动态内存
智能指针——shared_ptr 为了更容易地使用动态内存,新的标准提供了智能指针来管理动态对象.智能指针的行为类似常规指针,重要的区别是它负责自动释放指向的对象. 智能指针的使用方式与普通指针类似. ...
- Excel的 OleDb 连接串的格式
Excel的 OleDb 连接串的格式(Provider=Microsoft.ACE.OLEDB)(2012-08-02 13:04:20) string strCon = "Provide ...
- (转载)OC学习篇之---Foundation框架中的NSString对象和NSMutableString对象
在之前的一篇文章中我们说到了Foundation框架中的NSObject对象,那么今天在在来继续看一下Foundation框架中的常用对象:NSString和NSMutableString. 在OC中 ...
- IOS平台设计规范
一.UI的控件概述: 1.框架UI的元素分为4类: A:栏:状态栏目和导航栏的结合体; B:内容视图:应用显示的内容信息,包括相关的交互行为,例如滚屏.插入.删除等操作进行排序; C:控制元素:产品行 ...