OData C# (Geliştiriciler İçin Nasıl Çalışır)

ASP.NET Core uygulamasında basit bir OData model sınıfı oluşturalım. Aşağıdaki kodda, bu sınıf OData sözdizimini kullanarak sorgulanabilecek bir hizmetler listesi sunar.

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

Kodun Açıklaması

Service sınıfı, C#'te bir servisi yönetmek için temel bir veri yapısı temsil eder. Üç özelliği içerir: Id: Servis için tamsayı bir tanımlayıcı. FirstName: Servisle ilgili adını temsil eden bir string. Price: Servisin fiyatını belirten ondalık bir değer. Bu sınıf, .NET geliştirmesinde daha karmaşık servis ile ilgili işlevsellikler oluşturmak için bir yapı taşı olarak kullanılabilir. Senaryoya bağlı olarak koleksiyon veya gezinme özelliklerini de kullanabiliriz.

Visual Studio'da ASP.NET Core uygulamasında standart bir OData uç noktası aracılığıyla hizmetler listesini sunmak için bir OData denetleyicisi nasıl kurabileceğinizi gösterir. Verilen örnek, statik bir hizmetler listesi kullanarak temel bir uygulamayı ve Web API'de OData sorgulama işlevlerini etkinleştirmeyi gösterir:

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

Kodun Açıklaması

Sağlanan kod, OData protokolünü kullanarak veri sorgulama ve değiştirme olanağı tanıyan bir ODataController adlı bir ASP.NET Core uygulamasında ServiceController tanımlar. Bu, talepleri odata/Service yönlendirir ve bir dizüstü bilgisayar ve bir akıllı telefon da dahil olmak üzere Service nesnelerinden oluşan statik bir liste sunar. Get yöntemi, [EnableQuery] ile dekore edilmiş olup, Müşterilere (filtreleme, sıralama, sayfalama) OData sorgularını Ürünler listesinde yürütme olanağı sağlar; sonuçları HTTP GET istekleri için bir IActionResult olarak geri döndürür.

Program.cs'de OData Hizmetlerini Kaydet

.NET 6 uygulamasına OData'yı entegre etmek için gereken OData paketlerini yüklememiz ve yapılandırmamız gerekir. Bu, OData modelini tanımlama, OData middleware'i kurma ve filtreleme, sıralama ve genişletme gibi OData özelliklerini destekleyecek hizmetleri yapılandırmayı içerir.

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

Kodun Açıklaması

Bu kod, bir .NET 6 uygulamasında OData desteğini yapılandırır. Öncelikle, gerekli ad alanlarını içe aktarır ve bir WebApplicationBuilder örneği oluşturur. GetEdmModel metodu, ODataConventionModelBuilder metoduyla OData modelini tanımlar; bu da Service varlıkları için bir varlık seti belirtir. AddOData metodu, belirli seçimi etkinleştirme, filtreleme, sıralama, sayma, genişletme ve sorgu sonuçları için maksimum 20'ye kadar bir top değeri ayarlama dahil OData servislerini yapılandırmak için çağrılır. Bu kurulum, uygulamanın OData sorgularını etkili bir şekilde ele alabilmesini sağlar.

AddOData() yöntemi, sorgulama için kullanılan veri modelini elde eden GetEdmModel() yöntemini kullanır; bu da bir OData servisi temeli oluşturur. Bu servis, açık veri tanımlamak için Varlık Veri Modeli (EDM) olarak bilinen soyut bir veri modeli kullanır. ODataConventionModelBuilder sınıfı, varsayılan isimlendirme kurallarıyla bir EDM oluşturur ve bu da kod gereksinimlerini en aza indirir. Alternatif olarak, geliştiriciler EDM üzerindeki daha fazla kontrol için ODataModelBuilder sınıfını kullanabilir.

Kodun Ekran Görüntüsü