C# OData（開發者如何理解其工作原理）

讓我們在 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 應用程式中定義了一個名為ServiceController ODataController ，因此可以使用 OData 協定查詢和操作資料。 它將請求路由到odata/Service ，並提供Service物件的靜態列表，其中包括筆記型電腦和智慧型手機。 使用[EnableQuery]裝飾的Get方法允許客戶端對 Products 清單執行 OData 查詢（篩選、排序、分頁），並將結果作為 HTTP GET 請求的IActionResult傳回。

在 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 等功能，並將查詢結果的最大值設為 20。 此設定可確保應用程式能夠有效地處理 OData 查詢。

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

程式碼截圖

! OData C#（開發人員的使用方法）：圖 4 - Visual Studio 中的程式碼