OData C# (Wie es für Entwickler funktioniert)

Lass uns eine einfache OData-Modellklasse in einer ASP.NET Core-Anwendung erstellen. Im folgenden Code wird die unten stehende Klasse eine Liste von Diensten offenlegen, die mit der OData-Syntax abgefragt werden können.

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

Beschreibung des Codes

Die Service Klasse stellt eine grundlegende Datenstruktur in C# zur Verwaltung eines Dienstes dar. Sie enthält drei Eigenschaften: Id : Eine ganzzahlige Kennung des Dienstes. FirstName : Ein String, der den Vornamen des Dienstes repräsentiert. Price: Ein Dezimalwert, der den Preis des Dienstes angibt. Diese Klasse kann als Baustein für die Entwicklung komplexerer dienstbezogener Funktionen in .NET-Anwendungen verwendet werden. Wir können je nach Szenario auch Sammlungen oder Navigations-Eigenschaften verwenden.

Hier erfahren Sie, wie Sie in einer ASP.NET Core-Anwendung in Visual Studio einen OData-Controller einrichten, um eine Liste von Diensten über einen standardisierten OData-Endpunkt freizugeben. Das folgende Beispiel zeigt eine grundlegende Implementierung mit einer statischen Liste von Diensten und aktiviert OData-Abfragefunktionen in der 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);
    }
}

Beschreibung des Codes

Der bereitgestellte Code definiert einen ODataController namens ServiceController in einer ASP.NET Core-Anwendung, der das Abfragen und Verarbeiten von Daten mit dem OData-Protokoll ermöglicht. Er leitet Anfragen an odata/Service und stellt eine statische Liste von Service-Objekten bereit, darunter ein Laptop und ein Smartphone. Die Get-Methode, die mit [EnableQuery] versehen ist, ermöglicht es Clients, OData-Abfragen (Filtern, Sortieren, Pagieren) auf der Produktliste auszuführen und die Ergebnisse als IActionResult für HTTP GET-Anfragen zurückzugeben.

Registrieren von OData-Diensten in der Program.cs

Um OData in eine .NET 6-Anwendung zu integrieren, müssen wir die erforderlichen OData-Pakete installieren und konfigurieren. Dies beinhaltet die Definition des OData-Modells, das Einrichten der OData-Middleware und die Konfiguration von Diensten zur Unterstützung von OData-Funktionen wie Filtern, Sortieren und Erweitern.

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

Beschreibung des Codes

Dieser Code konfiguriert die OData-Unterstützung in einer .NET 6-Anwendung. Zunächst importiert er die erforderlichen Namensräume und erstellt eine WebApplicationBuilder-Instanz. Die GetEdmModel-Methode definiert das OData-Modell mithilfe des ODataConventionModelBuilder, der ein Entitätenset für Service-Entitäten spezifiziert. Die AddOData-Methode wird dann aufgerufen, um OData-Dienste zu konfigurieren, einschließlich der Aktivierung von Select, Filter, Order by, Count, Expand, und setzt einen maximalen Top-Wert von 20 für Abfrageergebnisse. Diese Einrichtung stellt sicher, dass die Anwendung OData-Abfragen effektiv handhaben kann.

Die AddOData()-Methode verwendet die GetEdmModel()-Methode, die das Datenmodell für die Abfrage abruft, das die Grundlage eines OData-Dienstes bildet. Dieser Dienst nutzt ein abstraktes Datenmodell, das als Entity Data Model (EDM) bekannt ist, um die exponierten Daten zu definieren. Die Klasse ODataConventionModelBuilder generiert ein EDM durch Standardbenennungen, was die Codeanforderungen minimiert. Alternativ können Entwickler die Klasse ODataModelBuilder verwenden, um mehr Kontrolle über das EDM zu haben.

Screenshot des Codes