OData C#（开发者用法）

让我们在 ASP.NET Core 应用中创建一个简单的 OData 模型类。 在以下代码中，下面的类将公开可以使用 OData 语法查询的服务列表。

public class Service
{
    public int Id { get; set; } 
    public string FirstName { get; set; }
    public decimal Price { get; set; }
}

public class Service
{
    public int Id { get; set; } 
    public string FirstName { get; set; }
    public decimal Price { get; set; }
}

代码描述

Service类表示一个C#中管理服务的基本数据结构。它包括三个属性：Id：服务的整数标识符。FirstName：表示与服务关联的名字的字符串。Price:：表示服务价格的十进制值。此类可用作创建更复杂服务相关功能的.NET开发基础。 我们还可以根据情况使用集合或导航属性。

以下是在 Visual Studio 的 ASP.NET Core 应用中设置一个 OData 控制器以通过标准化 OData 端点公开服务列表的方法。 以下示例演示了如何使用静态服务列表和在 Web API 中启用 OData 查询功能的基本实现：

using DemoOData.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.OData.Query;
using Microsoft.AspNetCore.OData.Routing.Controllers;

namespace DemoOData.Controllers
{
    [Route("odata/[controller]")]
    public class ServiceController : ODataController
    {
        private static readonly List<Service> Products = new List<Service>
        {
            new Service { Id = 1, FirstName = "Laptop", Price = 6239.9M },
            new Service { Id = 2, FirstName = "Smartphone", Price = 2585.9M }
        };

        [HttpGet]
        [EnableQuery]
        public IActionResult Get() => Ok(Products);
    }
}

using DemoOData.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.OData.Query;
using Microsoft.AspNetCore.OData.Routing.Controllers;

namespace DemoOData.Controllers
{
    [Route("odata/[controller]")]
    public class ServiceController : ODataController
    {
        private static readonly List<Service> Products = new List<Service>
        {
            new Service { Id = 1, FirstName = "Laptop", Price = 6239.9M },
            new Service { Id = 2, FirstName = "Smartphone", Price = 2585.9M }
        };

        [HttpGet]
        [EnableQuery]
        public IActionResult Get() => Ok(Products);
    }
}

代码描述

提供的代码在ASP.NET Core应用程序中定义了一个名为ODataController，使可以使用OData协议查询和操作数据。 它将请求路由到Service对象列表。 通过带有IActionResult返回以进行HTTP GET请求。

在 Program.cs 中注册 OData 服务

要将 OData 集成到 .NET 6 应用中，我们需要安装和配置必要的 OData 包。 这涉及定义 OData 模型、设置 OData 中间件和配置服务以支持诸如过滤、排序和展开的 OData 功能。

using DemoOData.Models;
using Microsoft.AspNetCore.OData;
using Microsoft.OData.Edm;
using Microsoft.OData.ModelBuilder;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    builder.EntitySet<Service>("Services");
    return builder.GetEdmModel();
}

builder.Services.AddControllers()
    .AddOData(options => options
        .AddRouteComponents("odata", GetEdmModel())
        .Select()
        .Filter()
        .OrderBy()
        .SetMaxTop(20)
        .Count()
        .Expand()
    );

using DemoOData.Models;
using Microsoft.AspNetCore.OData;
using Microsoft.OData.Edm;
using Microsoft.OData.ModelBuilder;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    builder.EntitySet<Service>("Services");
    return builder.GetEdmModel();
}

builder.Services.AddControllers()
    .AddOData(options => options
        .AddRouteComponents("odata", GetEdmModel())
        .Select()
        .Filter()
        .OrderBy()
        .SetMaxTop(20)
        .Count()
        .Expand()
    );

代码描述

此代码在 .NET 6 应用中配置 OData 支持。 首先，它导入必要的命名空间并创建一个WebApplicationBuilder实例。 Service实体的实体集。 然后调用AddOData方法来配置OData服务，包括启用选择、筛选、按顺序、计数、展开，并为查询结果设置最大top值为20。 这种设置确保应用能够有效处理 OData 查询。

GetEdmModel()方法来检索用于查询的数据模型，构成OData服务的基础。此服务利用称为实体数据模型（EDM）的抽象数据模型来定义暴露的数据。 ODataConventionModelBuilder类通过默认命名约定生成EDM，最小化代码需求。 或者，开发人员可以利用ODataModelBuilder类来获得对EDM的更大控制。

代码的屏幕截图