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

时间:2015-08-20 17:47:53

标签: c# asp.net asp.net-web-api

我有一个Web Api端点,目前这样称为:

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

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

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

请注意.lt后缀。这样,用户就可以列出creationDate 小于(lt)的所有场景,而不是1440091949

为此,我必须创建自己的映射器函数,它将每个查询参数映射到查询模型的属性,并将每个查询操作(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;
}

我知道如果有人决定使用[FromUri]属性,ASP.NET Web Api会提供自动映射,但如果我有简单的查询参数,例如creationDate=1440091949,那将会有效如果我发送查询参数,例如creationDate.lt=1440091949

,则无效

在Web APi引擎中是否内置了一些内容来处理这些类型的查询参数?我在很多Web服务上都看过它们,因此它们在订购或执行复杂查询时非常常见。

3 个答案:

答案 0 :(得分:5)

您是否尝试使用类似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节中找到,但这里有一些关于如何使用语法的简单示例:

  • ... / host / service / Products?$ filter =名称eq'Bilk':返回名称等于'Milk'的所有商品
  • ... / host / service / Products?$ filter =名称eq'Milk'和价格<2.55 :返回名称等于'Milk'且价格较低的所有商品比2.55
  • ... / host / service / Products?$ top = 10&amp; $ skip10 :返回商品11&gt; 21。 $ top系统查询选项请求查询的集合中的项目数包含在结果中。 $ skip查询选项请求查询集合中要跳过但未包含在结果中的项目数
  • ... / host / service / Products?$ orderby =名称desc,Id :按名称降序返回按名称排序的所有商品,然后按ID排序
  • ... / host / service / Products?$ filter = Enabled eq true :返回Enabled字段(布尔值)为true的所有产品
  • ... / host / service / Products?$ filter = substringof('Martin',Name): 返回Name字段包含文本Martin
  • 的所有产品

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

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

如果我们假设我们从常规Web API项目(文件&gt;新项目&gt; ASP.net Web应用程序&gt; Web API)开始,您首先需要添加一个脚手架控制器,您可以按照以下步骤操作:

  1. 添加一个模型类(我使用带有Id的典型'Person'类, 名字,姓氏,年龄等)
  2. 右键点击'controllers'文件夹&gt;添加&gt;新的脚手架项目&gt; Web API 2 Controller with actions,using Entity Framework&gt;型号= 人
  3. 注意:您无需选择“Web API 2 OData Controller ...”选项,您可以将查询语法添加到任何控制器

    一旦你设置了你的控制器,你应该得到一个简单的控制器,它有一个看起来像这样的默认GET动作:

    // GET: api/People
    public IQueryable<Person> GetPeople()
    {
        return db.People;
    }
    

    此操作将简单地返回数据库“人员”表中的所有行,无法进行过滤,排序等。要添加完整的OData查询支持,您需要进行一些更改:

    1. 通过nugget添加Microsoft.Aspnet.OData包...只需弹出即可 这进入你的'Package Manager Console':Install-Package Microsoft.AspNet.Odata
    2. 使用System.Web.OData;
    3. 添加此using语句
    4. 将[EnableQueryAttribute]属性添加到GetPeople操作中。
    5. 添加AsQueryable();到你的回程线所以它看起来像这样:返回 db.People.AsQueryable();
    6. 您完成的代码将如下所示:

      // GET: api/People
      [EnableQueryAttribute]
      public IQueryable<Person> GetPeople()
      {
          return db.People.AsQueryable();
      }
      

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

答案 1 :(得分:1)

您可以将运算符放入参数值:

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

然后测试您为creationDate参数获取的字符串的开头部分,以查看它是否包含有效的运算符。只是要小心,我仍然会参数化实际值。所以将其转换为

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

并输入1440091949作为参数@creationDate。

我只是在我的一个网络表单上试过这个,它运行正常。无论如何,你将这些参数作为字符串获取,因此它可以工作,甚至不像一个kludge。而且我对那些闻起来有点污垢的东西都过于敏感。

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

答案 2 :(得分:0)

如果你这样做,地球上的生命会结束吗?

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

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