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

Bir ASP.NET Core uygulamasında basit bir OData model sınıfı yaratalım. Aşağıdaki kodda, aşağıdaki sınıf, OData sözdizimi kullanılarak sorgulanabilecek hizmetlerin listesi sağlayacaktır.

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#'ta bir hizmeti yönetmek için temel bir veri yapısını temsil eder. Üç özelliği içerir: Id: Hizmet için bir tamsayı tanımlayıcı. FirstName: Hizmetle ilişkilendirilmiş ilk adı temsil eden bir dize. Price: Hizmetin fiyatını belirten ondalık bir değer. Bu sınıf, .NET geliştirmede daha karmaşık hizmetle ilgili işlevsellikler oluşturmak için bir yapı taşı olarak kullanılabilir. Senaryoya bağlı olarak koleksiyon veya navigasyon özelliklerini de kullanabiliriz.

ASP.NET Core uygulamanızı Visual Studio'da merkezi OData uç noktası aracılığıyla hizmetler listesini açığa çıkarmak için bir OData denetleyicisini nasıl kuracağınız burada yer alıyor. Aşağıdaki örnek, statik bir hizmet listesi kullanarak temel bir uygulamayı ve Web API'de OData sorgulama işlevlerini etkinleştirmeyi göstermektedir.

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, bir ASP.NET Core uygulamasında, OData protokolünü kullanarak veri sorgulama ve manipülasyonunu etkinleştiren ODataController adlı bir ServiceController tanımlar. İstekleri odata/Service'ya yönlendirir ve bir dizüstü bilgisayar ve bir akıllı telefon içeren, statik bir Service listesi sunar. [EnableQuery] ile süslenmiş Get yöntemi, OData sorgularını (filtreleme, sıralama, sayfalama) Ürünler listesi üzerinde gerçekleştirmesine olanak tanır ve sonuçları HTTP GET istekleri için bir IActionResult olarak döner.

Program.cs'de OData Hizmetlerini Kaydedin

.NET 6 uygulamasina OData'yi entegre etmek icin gerekli OData paketlerini yükleyip yapılandırmamız gerekir. Bu, OData modelini tanımlamayı, OData ara katmanını kurmayı ve filtreleme, sıralama ve genişletme gibi OData özelliklerini desteklemek icin 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. İlk olarak, gerekli ad alanlarını içe aktarıp bir WebApplicationBuilder örneği oluşturur. GetEdmModel yöntemi, ODataConventionModelBuilder kullanarak OData modelini tanımlar ve Service varlıkları için bir varlık seti belirtir. AddOData yöntemi daha sonra OData hizmetlerini yapılandırmak için çağrılır ve sorgu sonuçları için seçme, filtre, sıralama, sayma, genişletme ve maksimum üst değer olarak 20 belirleme gibi seçenekleri etkinleştirir. Bu yapılandırma, uygulamanın OData sorguları ile etkili bir şekilde başa çıkmasını sağlar.

GetEdmModel() yöntemini kullanan AddOData() yöntemi, sorgulama için kullanılan veri modelini alır, bir OData hizmetinin temelini oluşturur. Bu hizmet, sunulan verileri tanımlamak için Varlık Veri Modeli (EDM) olarak bilinen soyut bir veri modeli kullanır. ODataConventionModelBuilder sınıfı, kod gereksinimlerini en aza indirerek varsayılan adlandırma kurallarıyla bir EDM üretir. Alternatif olarak, geliştiriciler EDM üzerinde daha fazla kontrol sağlamak için ODataModelBuilder sınıfını kullanabilir.

Kodun Ekran Görüntüsü