如何在服务器上使用 OData $filter 结果

Question

我有一个正常工作的 OData 控制器，它支持所有正常的 get/put 等。

我要做的是从客户端传递一个普通的 odata $filter 字符串，在服务器上解析并执行过滤器，然后在生成的 IEnumerable 上运行一些代码。

我已经搞砸了 ODataQueryContext、ODataQueryOptions、FilterQueryOption 等，但没有真正得到任何地方。

有人有任何工作示例吗？

编辑：我已经添加了我的功能骨架，只需要填写空白

    public HttpResponseMessage GetJobs(string filter)
    {
        *** How to convert the filter into IQueryable<Job> ***
        var queryable = ?????    

        var settings = new ODataQuerySettings();
        var jobs = queryOptions.ApplyTo(querable, settings) as IQueryable<Job>;

        CsvSerializer csvSerializer = new CsvSerializer();
        string csv = csvSerializer.Serialise(jobs);
        string fileName = string.Format("{0} Jobs.csv", filter);
        return CreateCsvResponseMessage(csv, fileName);
    }

Answer 1

我最近遇到了一个我也需要这种功能的场景。这就是我想出的。

    private static IQueryable<T> ApplyODataFilter<T>(IQueryable<T> data, string filterString) where T : class
    {
        ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
        builder.EntitySet<T>(typeof(T).Name);

        ODataQueryContext context = new ODataQueryContext(builder.GetEdmModel(), typeof(T), new ODataPath());

        ODataQueryOptionParser queryOptionParser = new ODataQueryOptionParser(
            context.Model,
            context.ElementType,
            context.NavigationSource,
            new Dictionary<string, string> { { "$filter", filterString } });

        FilterQueryOption filter = new FilterQueryOption(filterString, context, queryOptionParser);

        IQueryable query2 = filter.ApplyTo(data, new ODataQuerySettings());
        return query2.Cast<T>();
    }

Answer 2

尝试使用 OData 代码生成器生成客户端代码。您可以关注以下博客： How to use OData Client Code Generator to generate client-side proxy class

对于过滤器，下面是一个例子：

var q2 = TestClientContext.CreateQuery<Type>("Accounts").Where(acct => acct.Birthday > new DateTimeOffset(new DateTime(2013, 10, 1)));

Answer 3

codeplex 中有一些示例代码来展示如何进行查询。

检查一下：

https://aspnet.codeplex.com/SourceControl/latest#Samples/WebApi/OData/v3/ODataQueryableSample/Program.cs

---

更新：

我给你的示例的控制器中有一些示例代码。

编写如下代码：

public IQueryable<Order> Get(ODataQueryOptions queryOptions)
{
    if (queryOptions.Filter != null)
    {
        var settings = new ODataQuerySettings();
        var filterResult = queryOptions.ApplyTo(OrderList.AsQueryable(), settings) as IQueryable<Order>;
        // Use the filter result here.
    }
}

---

更新 2： 您可以从 ODataQueryOptions 获取过滤器的原始字符串。

    public IQueryable<Order> Get(ODataQueryOptions queryOptions)
    {
        string filterString = queryOptions.Filter.RawValue;
        // Use the filterString
    }

---

更新 3：

（注意：ODataProperties 是静态类中的扩展方法 System.Web.Http.OData.Extensions.HttpRequestMessageExtensions）

        public HttpResponseMessage GetJobs(string filter)
        {
            var context = new ODataQueryContext(Request.ODataProperties().Model, typeof(Job));
            var filterQueryOption = new FilterQueryOption(filter, context);

            IQueryable<Job> queryable = GetAllJobs();
            var settings = new ODataQuerySettings();
            var jobs = filterQueryOption.ApplyTo(queryable, settings) as IQueryable<Job>;

            CsvSerializer csvSerializer = new CsvSerializer();
            string csv = csvSerializer.Serialise(jobs);
            string fileName = string.Format("{0} Jobs.csv", filter);
            return CreateCsvResponseMessage(csv, fileName);
        }