CQRS Pattern C# (Geliştiriciler için Nasıl Çalışır)

Adım 1: ASP.NET Uygulamanızı Kurun

1. Visual Studio'yu başlatın ve yeni bir proje oluşturmayı seçin.

2. 'ASP.NET Core Web Uygulaması' proje türünü arayın ve seçin. Sonraki'ye tıklayın.

   

3. Projenize bir ad verin ve konumunu ayarlayın. "Oluştur" a tıklayın.
4. ASP.NET Core için 'Web Uygulaması (Model-View-Controller)' şablonunu seçin. Gereksinimlerinize uygun .NET Core sürümünü hedeflediğinizden emin olun. "Oluştur" a tıklayın.

Adım 2

Sonraki adım olarak projenizi CQRS için organize etmek isteyeceksiniz. Bunu, kullanacakları komutları, sorguları ve ortak arayüzleri ayırmak için klasörler ekleyerek yapabilirsiniz. Çözüm Gezgini'nde projenize sağ tıklayın, 'Ekle'ye gidin, ardından 'Yeni Klasör' seçeneğini seçin. Üç klasör oluşturun: 'Commands', 'Queries', ve 'Interfaces'.

'Interfaces' klasörüne komutlar ve sorgular için arayüzler ekleyin. Bir komut için, bir komut alıp eylemi gerçekleştiren ICommandHandler arayüze sahip olabilirsiniz. Bir sorgu için, sorgu alıp veri döndüren IQueryHandler arayüzüne sahip olabilirsiniz.

Adım 3

Şimdi, bir komut ve sorgu ekleyerek gösterelim. Uygulamanız görevleri yönetiyorsa, bir görev eklemek (komut) ve görevleri geri almak (sorgu) isteyebilirsiniz.

'Interfaces' klasörüne iki arayüz ekleyin:

// Define interfaces for your handlers:
public interface ICommandHandler<TCommand>
{
    void Handle(TCommand command);
}

public interface IQueryHandler<TQuery, TResult>
{
    TResult Handle(TQuery query);
}

// Define interfaces for your handlers:
public interface ICommandHandler<TCommand>
{
    void Handle(TCommand command);
}

public interface IQueryHandler<TQuery, TResult>
{
    TResult Handle(TQuery query);
}

' Define interfaces for your handlers:
Public Interface ICommandHandler(Of TCommand)
	Sub Handle(ByVal command As TCommand)
End Interface

Public Interface IQueryHandler(Of TQuery, TResult)
	Function Handle(ByVal query As TQuery) As TResult
End Interface

'Commands' klasörüne görev detayları için özelliklere sahip AddItemCommand sınıfı ekleyin. Ayrıca, veritabanına bir görev ekleme mantığını içeren ICommandHandler uygulayan bir AddItemCommandHandler sınıfı ekleyin.

'Queries' klasörüne, bir görev talebini temsil eden GetTasksQuery sınıfı ekleyin. Veritabanından görevleri getirme mantığını içeren IQueryHandler uygulayan başka bir sınıf GetTasksQueryHandler ekleyin.

Basit bir örnek için, AddItemCommand sınıfınız şöyle görünebilir:

public class AddItemCommand
{
    public string Name { get; set; }
    public int Quantity { get; set; }

    // Constructor
    public AddItemCommand(string name, int quantity)
    {
        Name = name;
        Quantity = quantity;
    }
}

public class AddItemCommand
{
    public string Name { get; set; }
    public int Quantity { get; set; }

    // Constructor
    public AddItemCommand(string name, int quantity)
    {
        Name = name;
        Quantity = quantity;
    }
}

Public Class AddItemCommand
	Public Property Name() As String
	Public Property Quantity() As Integer

	' Constructor
	Public Sub New(ByVal name As String, ByVal quantity As Integer)
		Me.Name = name
		Me.Quantity = quantity
	End Sub
End Class

Ve AddItemCommandHandler:

public class AddItemCommandHandler : ICommandHandler<AddItemCommand>
{
    public void Handle(AddItemCommand command)
    {
        // Here, you'd add the item to your database, for example, to have employee data stored
        Console.WriteLine($"Adding item: {command.Name} with quantity {command.Quantity}");
        // Add database logic here
    }
}

public class AddItemCommandHandler : ICommandHandler<AddItemCommand>
{
    public void Handle(AddItemCommand command)
    {
        // Here, you'd add the item to your database, for example, to have employee data stored
        Console.WriteLine($"Adding item: {command.Name} with quantity {command.Quantity}");
        // Add database logic here
    }
}

Public Class AddItemCommandHandler
	Implements ICommandHandler(Of AddItemCommand)

	Public Sub Handle(ByVal command As AddItemCommand)
		' Here, you'd add the item to your database, for example, to have employee data stored
		Console.WriteLine($"Adding item: {command.Name} with quantity {command.Quantity}")
		' Add database logic here
	End Sub
End Class

Görevleri getirmek için olursa, GetItemsQuery hiçbir parametre gerektirmeden boş olabilir ve GetItemsQueryHandler şöyle görünebilir:

public class GetItemsQuery
{
    // This class might not need any properties, depending on your query
}

namespace CQRS_testing.Queries
{
    using CQRS_testing.Interfaces;

    public class GetItemsQueryHandler : IQueryHandler<GetItemsQuery, IEnumerable<string>>
    {
        public IEnumerable<string> Handle(GetItemsQuery query)
        {
            // Here, you'd fetch items from your database
            return new List<string> { "Item1", "Item2" };
        }
    }
}

public class GetItemsQuery
{
    // This class might not need any properties, depending on your query
}

namespace CQRS_testing.Queries
{
    using CQRS_testing.Interfaces;

    public class GetItemsQueryHandler : IQueryHandler<GetItemsQuery, IEnumerable<string>>
    {
        public IEnumerable<string> Handle(GetItemsQuery query)
        {
            // Here, you'd fetch items from your database
            return new List<string> { "Item1", "Item2" };
        }
    }
}

Imports CQRS_testing.Interfaces

Public Class GetItemsQuery
	' This class might not need any properties, depending on your query
End Class

Namespace CQRS_testing.Queries

	Public Class GetItemsQueryHandler
		Implements IQueryHandler(Of GetItemsQuery, IEnumerable(Of String))

		Public Function Handle(ByVal query As GetItemsQuery) As IEnumerable(Of String)
			' Here, you'd fetch items from your database
			Return New List(Of String) From {"Item1", "Item2"}
		End Function
	End Class
End Namespace

ASP.NET denetleyicilerinizde, komutları ve sorguları işlemek için bu işleyicileri kullanacaksınız. Bir görev eklemek için, denetleyici işlemi bir AddTaskCommand oluşturur, form verilerinden özelliklerini ayarlar ve ardından bir AddTaskCommandHandler örneğine ileterek işlemi yapar. Görevleri geri almak için, verileri almak ve görünüme iletmek için bir GetTasksQueryHandler çağırır.

Bir Denetleyicide Bağlantı Kurma

Komutlarınızı ve sorgularınızı kurarak, artık bunları denetleyicilerinizde kullanabilirsiniz. ItemsController sınıfında bunu nasıl yapabileceğiniz şöyle açıklanmıştır:

public class ItemsController : Controller
{
    private readonly ICommandHandler<AddItemCommand> _addItemHandler;
    private readonly IQueryHandler<GetItemsQuery, IEnumerable<string>> _getItemsHandler;

    // Constructor injection is correctly utilized here
    public ItemsController(ICommandHandler<AddItemCommand> addItemHandler, IQueryHandler<GetItemsQuery, IEnumerable<string>> getItemsHandler)
    {
        _addItemHandler = addItemHandler;
        _getItemsHandler = getItemsHandler;
    }

    public IActionResult Index()
    {
        // Use the injected _getItemsHandler instead of creating a new instance
        var query = new GetItemsQuery();
        var items = _getItemsHandler.Handle(query);
        return View(items);
    }

    [HttpPost]
    public IActionResult Add(string name, int quantity)
    {
        // Use the injected _addItemHandler instead of creating a new instance
        var command = new AddItemCommand(name, quantity);
        _addItemHandler.Handle(command);
        return RedirectToAction("Index");
    }
}

public class ItemsController : Controller
{
    private readonly ICommandHandler<AddItemCommand> _addItemHandler;
    private readonly IQueryHandler<GetItemsQuery, IEnumerable<string>> _getItemsHandler;

    // Constructor injection is correctly utilized here
    public ItemsController(ICommandHandler<AddItemCommand> addItemHandler, IQueryHandler<GetItemsQuery, IEnumerable<string>> getItemsHandler)
    {
        _addItemHandler = addItemHandler;
        _getItemsHandler = getItemsHandler;
    }

    public IActionResult Index()
    {
        // Use the injected _getItemsHandler instead of creating a new instance
        var query = new GetItemsQuery();
        var items = _getItemsHandler.Handle(query);
        return View(items);
    }

    [HttpPost]
    public IActionResult Add(string name, int quantity)
    {
        // Use the injected _addItemHandler instead of creating a new instance
        var command = new AddItemCommand(name, quantity);
        _addItemHandler.Handle(command);
        return RedirectToAction("Index");
    }
}

Public Class ItemsController
	Inherits Controller

	Private ReadOnly _addItemHandler As ICommandHandler(Of AddItemCommand)
	Private ReadOnly _getItemsHandler As IQueryHandler(Of GetItemsQuery, IEnumerable(Of String))

	' Constructor injection is correctly utilized here
	Public Sub New(ByVal addItemHandler As ICommandHandler(Of AddItemCommand), ByVal getItemsHandler As IQueryHandler(Of GetItemsQuery, IEnumerable(Of String)))
		_addItemHandler = addItemHandler
		_getItemsHandler = getItemsHandler
	End Sub

	Public Function Index() As IActionResult
		' Use the injected _getItemsHandler instead of creating a new instance
		Dim query = New GetItemsQuery()
		Dim items = _getItemsHandler.Handle(query)
		Return View(items)
	End Function

	<HttpPost>
	Public Function Add(ByVal name As String, ByVal quantity As Integer) As IActionResult
		' Use the injected _addItemHandler instead of creating a new instance
		Dim command = New AddItemCommand(name, quantity)
		_addItemHandler.Handle(command)
		Return RedirectToAction("Index")
	End Function
End Class

Her şeyi bağlamak için, özellikle ASP.NET Core'da bağımlılık enjeksiyonu (DI) kullanıyorsanız, bu durumda, komut ve sorgu işleyicilerinizi Startup.cs dosyasında DI konteynerine kaydetmeniz gerekir. Böylece, ASP.NET ihtiyaç duyulduğunda işleyici örneklerinizi sağlayabilir.

İşleyici kaydı için çok basit bir örnek:

builder.Services.AddTransient<ICommandHandler<AddItemCommand>, AddItemCommandHandler>();
builder.Services.AddTransient<IQueryHandler<GetItemsQuery, IEnumerable<string>>, GetItemsQueryHandler>();

builder.Services.AddTransient<ICommandHandler<AddItemCommand>, AddItemCommandHandler>();
builder.Services.AddTransient<IQueryHandler<GetItemsQuery, IEnumerable<string>>, GetItemsQueryHandler>();

builder.Services.AddTransient(Of ICommandHandler(Of AddItemCommand), AddItemCommandHandler)()
builder.Services.AddTransient(Of IQueryHandler(Of GetItemsQuery, IEnumerable(Of String)), GetItemsQueryHandler)()

CQRS'nin pratik uygulanmasında, yazma işlemleri için veri modeli ile okuma işlemleri için olan arasındaki ayrım temeldir ve mimarinin çeşitli ve optimize edilmiş veri işleme yaklaşımlarını desteklemesini sağlar.

Kod Örneği

Şimdi, IronPDF'nin, Komut Sorgu Sorumluluğu Ayrımı (CQRS) modelini izleyen bir C# uygulaması içinde nasıl kullanılabileceğini keşfedelim. Aşağıda, IronPDF'yi bir CQRS kurulumu içinde PDF raporu oluşturmak için nasıl kullanabileceğinizi gösteren basit bir örnek bulunmaktadır. Bu örnek kavramsaldır ve bir PDF belgesi oluşturmayı bir komut olarak odaklanmaktadır.

using IronPdf;
using System.Threading.Tasks;

namespace PdfGenerationApp.Commands
{
    public class GeneratePdfReportCommand
    {
        // Command handler that generates a PDF report
        public async Task GenerateReportAsync(string reportContent, string outputPath)
        {
            // Initialize the IronPDF HTML to PDF renderer
            var renderer = new ChromePdfRenderer();
            // Use IronPDF to generate a PDF from HTML content
            var pdf = await Task.Run(() => renderer.RenderHtmlAsPdf(reportContent));
            // Save the generated PDF to a specified path
            pdf.SaveAs(outputPath);
        }
    }
}

using IronPdf;
using System.Threading.Tasks;

namespace PdfGenerationApp.Commands
{
    public class GeneratePdfReportCommand
    {
        // Command handler that generates a PDF report
        public async Task GenerateReportAsync(string reportContent, string outputPath)
        {
            // Initialize the IronPDF HTML to PDF renderer
            var renderer = new ChromePdfRenderer();
            // Use IronPDF to generate a PDF from HTML content
            var pdf = await Task.Run(() => renderer.RenderHtmlAsPdf(reportContent));
            // Save the generated PDF to a specified path
            pdf.SaveAs(outputPath);
        }
    }
}

Imports IronPdf
Imports System.Threading.Tasks

Namespace PdfGenerationApp.Commands
	Public Class GeneratePdfReportCommand
		' Command handler that generates a PDF report
		Public Async Function GenerateReportAsync(ByVal reportContent As String, ByVal outputPath As String) As Task
			' Initialize the IronPDF HTML to PDF renderer
			Dim renderer = New ChromePdfRenderer()
			' Use IronPDF to generate a PDF from HTML content
			Dim pdf = Await Task.Run(Function() renderer.RenderHtmlAsPdf(reportContent))
			' Save the generated PDF to a specified path
			pdf.SaveAs(outputPath)
		End Function
	End Class
End Namespace

Bu örnekte, GeneratePdfReportCommand, CQRS modelinde bir komutu temsil eder. reportContent olarak HTML dizesi ve PDF raporunun kaydedileceği outputPath alan bir GenerateReportAsync yöntemi içerir. IronPDF'nin HtmlToPdf sınıfı, HTML içeriklerini PDF formatına dönüştürmek için kullanılmaktadır ve bu, belirtilen yolda kaydedilir. Bu kurulum, uygulamanızın mimarisi içerisine PDF oluşturma işlevselliğini nasıl entegre edebileceğinizi, özellikle CQRS tarafından öngörülen gibi konuların net bir şekilde ayrılmasını gerektiren senaryolarda nasıl yapabileceğinizi gösterir.