OData Unbound 函数发送和接收原始集合

Question

需要一个示例，说明如何将原始类型的集合传递给未绑定的函数/或操作，以及如何返回原始类型的集合。
例如整数列表或数组。
这是一个简单的例子。

List<int> GetEvenNumbers(List<int> numbers)
{
// loop through numbers collection and return a list of the even numbers
}

以下站点讨论了使用函数/动作，但没有解释传递/接收集合。

http://www.asp.net/web-api/overview/odata-support-in-aspnet-web-api/odata-v4/odata-actions-and-functions

https://aspnet.codeplex.com/sourcecontrol/latest#Samples/WebApi/OData/v4/

我什至在“Show Me How With Code”上发布了一条建议，但没有收到回复。
http://aspnet.uservoice.com/forums/228522-show-me-how-with-code/suggestions/6264729-odata-v4-passing-collection-as-parameter-to-unbou

这是我有的一些代码，但它似乎不起作用。

// in the controller
[HttpGet]
[ODataRoute("GetEvenNumbers(numbers={numbers})")]
public IHttpActionResult GetEvenNumbers(List<int> numbers)
{
    List<int> evenNumbers = new List<int>();
    foreach (var number in numbers)
    {
        if (number % 2 == 0)
        {
            evenNumbers.Add(number);
        }
    }
    return Ok(evenNumbers);
}

// in the WebApiConfig
var testCollectionFunction = builder.Function("GetEvenNumbers");
testCollectionFunction.CollectionParameter<int>("numbers");
testCollectionFunction.ReturnsCollection<int>();

在 WCF 中这很简单，但在 OData 中就不是那么简单了。

Answer 1

据我所知，webapi odata 不允许在 Functions 参数中进行集合。但是您可以使用 Actions 作为解决方法。

模型构建器：

        var testCollectionFunction = modelBuilder.Action("GetEvenNumbers");
        testCollectionFunction.CollectionParameter<int>("numbers");
        testCollectionFunction.ReturnsCollection<int>();

控制器：

    [HttpPost]
    [ODataRoute("GetEvenNumbers")]
    public IHttpActionResult GetEvenNumbers(ODataActionParameters parameter)
    {
        IEnumerable<int> numbers = parameter["numbers"] as IEnumerable<int>;
        List<int> evenNumbers = new List<int>();
        foreach (var number in numbers)
        {
            if (number % 2 == 0)
            {
                evenNumbers.Add(number);
            }
        }
        return Ok(evenNumbers);
    }

请求：

POST http://localhost:44221/odata/GetEvenNumbers HTTP/1.1
Host: localhost:44221
Connection: keep-alive
Content-Length: 17

{"numbers":[1,2]}

回复：

HTTP/1.1 200 OK
Content-Type: application/json; odata.metadata=full
OData-Version: 4.0
Content-Length: 109

{
  "@odata.context":"http://localhost:44221/odata/$metadata#Collection(Edm.Int32)","value":[
    2
  ]
}

Answer 2

所以我想提供和更新这篇文章。我正在使用 Web API 2.2 使用 OData v4。我能够将参数传递给未绑定的函数。

这是我的注册方法中的构建器代码。

ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet<Employee>("Employees");

//other stuff here
builder.Function("EmployeesWithParameters")
       .ReturnsCollectionFromEntitySet<Employee>("Employees")
       .CollectionParameter<string>("Ids");

这是我的控制器上的实际方法调用。

    [HttpGet]
    [ODataRoute("EmployeesWithParameters(Ids={Ids})")]
    public IQueryable<Employee> EmployeesWithParameters([FromODataUri]string[] Ids)
    {
        IQueryable<Employee> result = db.Employees.Where(p => Ids.Contains(p.EmployeeId) );

        return result; ;
    }

Answer 3

正如 Cyrus 的回答所说，OData 函数既可以返回集合，也可以将它们作为参数。

就我而言，我有一个名为“MostPopular”的函数，定义为：

        var mostPopFunc = svcHist.Collection.Function("MostPopular");
        mostPopFunc.Parameter<DateTime>("From");
        mostPopFunc.CollectionParameter<ServiceCodes>("ServiceCodes");
        mostPopFunc.CollectionParameter<int>("ServiceUnits");
        mostPopFunc.Parameter<string>("SearchCCL");
        mostPopFunc.Parameter<int>("ListLength").OptionalParameter = true;
        mostPopFunc.ReturnsCollection<ciExternalPartnerPopularResult.MarcIdPopularity>();

由于这个函数绑定到一个实体集，我不需要提供路由映射，函数声明被缩减为：

[HttpGet]
public async Task<IHttpActionResult> MostPopular([FromODataUri] DateTimeOffset from, [FromODataUri] IEnumerable<ServiceCodes> serviceCodes, 
                                                 [FromODataUri] IEnumerable<int> serviceUnits,
                                                 [FromODataUri] string searchCcl, [FromODataUri] int listLength = ListLengthDefault)
{ // ...
}

int 和其他简单类型不需要[FromODataUri] 装饰，但我并不在意它们。考虑到参数的数量，这个函数有点重，但我没时间想出一个更好的接口。

最后，要从 PostMan（或浏览器）调用它，GET 请求看起来像这样：

{{url}}/ServiceHistories/Default.MostPopular(From=2016-10-07T12:41:59Z,ServiceCodes=['OnLoan'],ServiceUnits=[6471,6473],SearchCCL='TI+SE=Harry',ListLength=10)

这迫使我修改我的 web.config 因为时间戳：

<system.web>
  <!-- This web service accepts datetimeoffset as a parameter and requires the ":" character to be supplied as part of the URL -->
  <httpRuntime targetFramework="4.5" requestPathInvalidCharacters="&lt;,&gt;,%,&amp;,\,?" />
</system.web>