ASP.. NET Web Api复杂查询参数

本文关键字:查询 参数 复杂 Api NET Web ASP | 更新日期: 2023-09-27 18:09:10

我有一个Web Api端点,目前是这样调用的:

http://api.example.com/scenes?creationDate=1440091949

我正在尝试支持更复杂的查询,如:

http://api.example.com/scenes?creationDate.lt=1440091949

注意.lt后缀。这将允许用户列出creationDate 小于 (lt)小于1440091949的所有场景。

为此,我必须创建自己的mapper函数,该函数将每个查询参数映射到查询模型的属性,并将每个查询操作(lt, gt, eq等)存储在操作字典中:

protected QueryData MapToQueryData(IEnumerable<KeyValuePair<string, string>> queryParameters)
{
     QueryData queryData = new QueryData();
     foreach(var queryParam in queryParameters)
     {
          string[] segments = queryParam.Key.Split('.'); // ["creationDate", "lt"]
          if(!segments.Any()) continue;
          PropertyInfo queryProperty = _reflection.Properties.GetProperty<QueryData>(segments.First()); // "CreationDate" Property
          if(queryProperty == null) continue;
          object value = _reflection.Conversion.ConvertTo(queryParam.Value, property.PropertyType); // Convert 1440091949 to long
          if(value == null) continue;
          _reflection.Properties.SetPropertyValue(queryData, property, value); // Set queryData.CreationDate = 1440091949
          if(segments.Length < 2) continue;
          PropertyInfo mapProperty = _reflection.Properties.GetPropertiesWithAttribute<QueryData, OperationMapAttribute>().FirstOrDefault(); // Identify Property annotated with [OperationMap]
          if(mapProperty == null) continue;
          Dictionary<string, string> operationMap = _reflection.Properties.GetPropertyValue(queryData, mapProperty) as Dictionary<string, string>(); // Get dictionary from Map property
          if(operationMap == null) continue;
          if(!operationMap.ContainsKey(property.Name))
                 operationMap.Add(property.Name, segments.Last()); // "creationDate" -> "lt"
          else
                 operationMap[property.Name] = segments.Last();
          _reflection.Properties.SetPropertyValue(queryData, mapProperty, operationMap); // Set Map property of QueryData to the updated dictionary
     }
     return queryData;
}

我知道存在ASP提供的自动映射。. NET Web Api,如果一个人决定使用[FromUri]属性,但这将工作,如果我有简单的查询参数,如creationDate=1440091949,但不会工作,如果我发送查询参数,如creationDate.lt=1440091949

在Web APi引擎中是否有内置的东西来处理这些类型的查询参数?我在很多web服务上看到过它们,所以它们在排序或执行复杂查询时非常常见。

ASP.. NET Web Api复杂查询参数

您是否尝试过使用类似于OData查询语法的东西?

http://blogs.msdn.com/b/martinkearn/archive/2015/03/10/using-odata-query-syntax-with-web-api.aspx

从前面提到的…

什么是OData查询语法?

OData查询语法是使用预定义语法查询RESTful api的标准方式,该语法允许调用客户端定义排序顺序、筛选参数和返回的数据页面。

完整的语法可以在OData Version 4.0 Part 2规范的第5节中找到,但这里有一些如何使用语法的快速示例:

  • …/主机/服务/产品?$filter=Name eq 'Milk':返回名称等于'Milk'的所有产品
  • …/主机/服务/产品?$filter=Name eq 'Milk' and Price lt 2.55:返回名称等于'Milk'且价格小于2.55的所有产品
  • …/host/service/Products?$top=10&$skip10:返回项目11>21。$top系统查询选项请求查询集合中包含在结果中的项数。$skip查询选项请求查询集合中要跳过且不包含在结果
  • 中的项的数量。
  • …/主机/服务/产品?$orderby=Name desc,Id:按名称降序返回所有按Id
  • 订购的产品
  • …/主机/服务/产品?$filter=Enabled eq true:返回Enabled字段(布尔值)为true的所有产品
  • …/主机/服务/产品?$过滤器= substringof("马丁",名称):返回Name字段包含文本Martin
  • 的所有产品

如何在ASP.net Web API中使用OData查询语法?

这就是事情变得非常棒的地方——改变一个常规的Web API控制器来支持OData查询语法是非常非常容易的——一旦你知道如何做到这一点,你就永远不会不去做!

如果我们假设我们从一个常规的Web API项目开始(File>新项目>ASP.net Web应用程序Web API),您首先需要添加一个支架控制器,您可以通过以下步骤来完成:

  1. 添加一个模型类(我使用典型的'Person'类Id,名字,姓氏,年龄等)
  2. 右键单击"controllers"文件夹>添加比;新脚手架项目>带有动作的Web API 2控制器,使用实体框架模型=人

注意:你不需要选择"Web API 2 OData Controller…"选项,您可以将查询语法添加到任何控制器

一旦你设置好了你的控制器,你应该得到一个简单的控制器,它有一个默认的GET动作,看起来有点像这样:
// GET: api/People
public IQueryable<Person> GetPeople()
{
    return db.People;
}

此操作将简单地返回数据库'People'表中的所有行,没有过滤、排序等功能。要添加完整的OData查询支持,您需要做一些更改:

  1. 通过nuget添加microsoft . asp.net . odata包…简单的流行在你的"包管理器控制台":Install-PackageMicrosoft.AspNet.Odata
  2. 添加using语句:using System.Web.OData;
  3. 在GetPeople动作中添加[EnableQueryAttribute]属性。
  4. 添加AsQueryable ();到返回行,看起来像这样:returndb.People.AsQueryable ();
你完成的代码看起来像这样:
// GET: api/People
[EnableQueryAttribute]
public IQueryable<Person> GetPeople()
{
    return db.People.AsQueryable();
}

这就是它的全部!…现在您已经完成了这个设置,您可以使用完整的OData语法来查询排序等,而无需任何额外的代码。

您可以将操作符放入参数值中:

http://api.example.com/scenes?creationDateTest=lt.1440091949

然后测试您为creatationdate参数获得的字符串的开头部分,看看它是否包含一个有效的操作符。只是要小心,我仍然会将实际值参数化。所以把它转换成

string cmd = "select .... from ... where creationdate < @creationDate";

和1440091949中的feed作为参数@creationDate。

我刚刚在我的一个web表单上尝试了这个,它工作得很好。无论如何,这些参数都是以字符串的形式得到的,所以它可以工作,而且它甚至不像一个拼凑的东西。我对任何闻起来像杂碎的东西都过于敏感。

PS:请注意我如何将查询字符串中的参数名称从creationDate更改为creationDateTest

如果你这样做,地球上的生命会灭亡吗?
http://api.example.com/scenes?cd=1440091949&cdop=lt&ep=45&epop=gt
http://api.example.com/scenes?cd=1440091949&cdop=gt&ep=45&epop=lt
http://api.example.com/scenes?cd=1440091949&cdop=eq&ep=45&epop=eq

在这种情况下不需要复杂的映射