OData C# (jak to działa dla programistów)

Stwórzmy prostą klasę modelu OData w aplikacji ASP.NET Core. W poniższym kodzie klasa przedstawiona poniżej udostępni listę usług, które można wyszukiwać przy użyciu składni 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; }
}

Public Class Service
    Public Property Id As Integer
    Public Property FirstName As String
    Public Property Price As Decimal
End Class

Opis kodu

Klasa Service reprezentuje podstawową strukturę danych w języku C# służącą do zarządzania usługą. Zawiera trzy właściwości: Id: identyfikator usługi w postaci liczby całkowitej. FirstName: ciąg znaków reprezentujący imię powiązane z usługą. Price: wartość dziesiętna wskazująca cenę usługi. Klasa ta może służyć jako element składowy do tworzenia bardziej złożonych funkcji związanych z usługami w ramach programowania w środowisku .NET. W zależności od scenariusza możemy również wykorzystać właściwości kolekcji lub nawigacji.

Oto jak skonfigurować kontroler OData w aplikacji ASP.NET Core w Visual Studio, aby udostępnić listę usług za pośrednictwem standardowego punktu końcowego OData. Poniższy przykład ilustruje podstawową implementację wykorzystującą statyczną listę usług i umożliwiającą korzystanie z funkcji zapytań OData w Web API:

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);
    }
}

Imports DemoOData.Models
Imports Microsoft.AspNetCore.Mvc
Imports Microsoft.AspNetCore.OData.Query
Imports Microsoft.AspNetCore.OData.Routing.Controllers

Namespace DemoOData.Controllers
	<Route("odata/[controller]")>
	Public Class ServiceController
		Inherits ODataController

		Private Shared ReadOnly Products As New List(Of Service) From {
			New Service With {
				.Id = 1,
				.FirstName = "Laptop",
				.Price = 6239.9D
			},
			New Service With {
				.Id = 2,
				.FirstName = "Smartphone",
				.Price = 2585.9D
			}
		}

		<HttpGet>
		<EnableQuery>
		Public Function [Get]() As IActionResult
			Return Ok(Products)
		End Function
	End Class
End Namespace

Opis kodu

Podany kod definiuje ODataController o nazwie ServiceController w aplikacji .NET Core, umożliwiając wyszukiwanie i manipulowanie danymi przy użyciu protokołu OData. Przekierowuje żądania do odata/Service i udostępnia statyczną listę obiektów Service, w tym laptopa i smartfona. Metoda Get, ozdobiona [EnableQuery], pozwala klientom wykonywać zapytania OData (filtrowanie, sortowanie, stronicowanie) na liście produktów, zwracając wyniki jako IActionResult dla żądań HTTP GET.

Zarejestruj usługi OData w pliku Program.cs

Aby zintegrować OData z aplikacją .NET 6, musimy zainstalować i skonfigurować niezbędne pakiety OData. Obejmuje to zdefiniowanie modelu OData, skonfigurowanie oprogramowania pośredniczącego OData oraz skonfigurowanie usług w celu obsługi funkcji OData, takich jak filtrowanie, sortowanie i rozszerzanie.

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()
    );

Imports DemoOData.Models
Imports Microsoft.AspNetCore.OData
Imports Microsoft.OData.Edm
Imports Microsoft.OData.ModelBuilder

Private 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()

'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'static IEdmModel GetEdmModel()
'{
'	ODataConventionModelBuilder builder = New ODataConventionModelBuilder();
'	builder.EntitySet<Service>("Services");
'	Return builder.GetEdmModel();
'}

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

Opis kodu

Ten kod konfiguruje obsługę OData w aplikacji .NET 6. Najpierw importuje niezbędne przestrzenie nazw i tworzy instancję WebApplicationBuilder. Metoda GetEdmModel definiuje model OData przy użyciu ODataConventionModelBuilder, który określa zbiór encji dla encji Service. Następnie wywoływana jest metoda AddOData w celu skonfigurowania usług OData, w tym włączenia funkcji select, filter, order by, count, expand oraz ustawienia maksymalnej liczby wyników zapytania na 20. Taka konfiguracja zapewnia, że aplikacja może efektywnie obsługiwać zapytania OData.

Metoda AddOData() wykorzystuje metodę GetEdmModel(), która pobiera model danych używany do wysyłania zapytań, tworząc podstawę usługi OData. Usługa ta wykorzystuje abstrakcyjny model danych znany jako Entity Data Model (EDM) do definiowania udostępnianych danych. Klasa ODataConventionModelBuilder generuje EDM zgodnie z domyślnymi konwencjami nazewniczymi, minimalizując wymagania dotyczące kodu. Alternatywnie programiści mogą wykorzystać klasę ODataModelBuilder, aby uzyskać większą kontrolę nad EDM.

Zrzut ekranu z kodem