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 的 ServiceController，因此可以使用 OData 協定查詢和操作資料。 它將請求路由到 odata/Service，並提供 Service 物件的靜態列表，其中包括筆記型電腦和智慧型手機。 使用 Get 方法，並加上 [EnableQuery] 裝飾器，允許客戶端對產品清單執行 OData 查詢(篩選、排序、分頁)，並將結果作為 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 實例。 GetEdmModel 方法使用 ODataConventionModelBuilder 定義 OData 模型，該模型為 Service 實體指定實體集。 然後呼叫 AddOData 方法來配置 OData 服務，包括啟用 select、filter、order by、count、expand 以及將查詢結果的最大 top 值設為 20。 此設定可確保應用程式能夠有效地處理 OData 查詢。

AddOData() 方法呼叫了 GetEdmModel() 方法，該方法用於檢索查詢所使用的資料模型，從而構成 OData 服務的基礎。該服務利用稱為實體資料模型 (EDM) 的抽象資料模型來定義公開的資料。 ODataConventionModelBuilder 類別透過預設命名約定產生 EDM，從而最大限度地減少程式碼需求。 或者，開發人員可以使用 ODataModelBuilder 類別來更好地控制 EDM。

程式碼截圖