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. İleri'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-Görünüm-Denetleyici)" şablonunu seçin. Gereksinimlerinize uygun olan .NET Core sürümünü hedeflediğinizden emin olun. Oluştur'a tıklayın.

Adım 2

Sonrasında, projenizi CQRS için organize etmeye yöneleceksiniz. Bunu, emirlere, sorgulara ve kullanacakları ortak ara yüzlere 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çin. Üç klasör oluşturun: "Commands", "Queries" ve "Interfaces".

"Interfaces" klasöründe, komutlarınız ve sorgularınız için ara yüzler ekleyin. Bir komut için, bir komutu alarak ve işlemi gerçekleştiren bir "Handle" yöntemine sahip bir ICommandHandler ara yüzüne sahip olabilirsiniz. Bir sorgu için, bir sorgu alarak ve veri döndüren bir IQueryHandler ara yüzüne sahip olabilirsiniz.

Adım 3

Şimdi, demonstra etmek için bir komut ve sorgu ekleyelim. Varsayalım ki uygulamanız görevleri yönetiyor ve bir görev eklemek (komut) ve görevleri geri almak (sorgu) istiyorsunuz.

"Interfaces" klasörüne iki ara yü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 ayrıntıları için özellikler içeren bir AddItemCommand sınıfı ekleyin. Ayrıca, ICommandHandler uygulayan ve veritabanına bir görev ekleme mantığını içeren bir AddItemCommandHandler sınıfı ekleyin.

"Queries" klasörüne, görevler için bir istek temsil eden bir GetTasksQuery sınıfı ekleyin. IQueryHandler uygulayan ve veritabanından görevleri geri alma mantığını içeren bir başka GetTasksQueryHandler sınıfı ekleyin.

Basit bir örnek için, AddItemCommandiniz şö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

Eğer görevleri almak için herhangi bir parametreye ihtiyaç duyulmazsa GetItemsQuery boş olabilir ve GetItemsQueryHandler şu şekilde 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 denetçilerinizde, bu işleyicileri komutları ve sorguları işlemek için kullanırsınız. Bir görev eklemek için, denetçi eylemi bir AddTaskCommand oluşturur, form verilerinden gelen özelliklerini ayarlar ve ardından onu bir AddTaskCommandHandler örneğine geçerek işler. Görevleri almak için, veriyi almak ve bakış açısına geçirmek üzere bir GetTasksQueryHandler çağırır.

Bir Kontrolde Bağlantı Kurma

Komutlarınızı ve sorgularınızı ayarladıktan sonra, şimdi bunları denetçilerinizde kullanabilirsiniz. Bunu bir ItemsController sınıfında şu şekilde yapabilirsiniz:

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, komut ve sorgu işleyicilerinizi Startup.cs dosyasında DI konteyneri ile kaydetmeniz gerekecek. Bu şekilde, ASP.NET işleyici örneklerinizi ihtiyaç duyulduğunda sağlayabilir.

İşte bir işleyiciyi kaydetmenin çok temel bir örneği:

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 uygulamasında, yazma işlemleri için veri modelinin ve okuma işlemleri için olanın ayrımı temeldir, böylece mimari, veriyi ele almak için çeşitli ve optimize edilmiş yaklaşımları destekler.

Kod Örneği

Şimdi, Command Query Responsibility Segregation (CQRS) deseni izleyen bir C# uygulamasında IronPDF'in nasıl kullanılabileceğini inceleyelim. Aşağıda, CQRS kurulumunda bir PDF raporu oluşturmak için IronPDF'in nasıl kullanılabileceğini gösteren basitleştirilmiş bir örnek bulunmaktadır. Bu örnek kavramsal olup, bir komut olarak bir PDF belgesi oluşturma üzerine odaklanı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 deseninde bir komutu temsil eder. GenerateReportAsync metodu içerir, bu metot reportContent olarak bir HTML dizgisi ve PDF raporunun kaydedileceği bir outputPath alır. IronPDF'in HtmlToPdf sınıfı, HTML içeriğini PDF formatına dönüştürmek için kullanılır ve belirtilen yola kaydedilir. Bu kurulum, PDF oluşturma işlevselliğini uygulamanızın mimarisine nasıl entegre edebileceğinizin bir örneğini sunar, özellikle CQRS'nin teşvik ettiği gibi net sorumlulukların ayrılması gereken senaryolarda.