C# CQRS 模式（開發者如何理解它）

步驟 1：設定 ASP.NET 應用程式

1. 啟動 Visual Studio 並選擇建立一個新專案。

2. 搜尋並選擇"ASP.NET Core Web 應用程式"項目類型。 點選"下一步"。

   CQRS 模式 C#（開發者如何操作）：圖 1 - 建立一個新的 ASP.NET 項目

3. 為你的項目命名並設定其位置。 點擊"創建"。
4. 選擇 ASP.NET Core 的"Web 應用程式（模型-視圖-控制器）"範本。 請確保您選擇的目標 .NET Core 版本符合您的需求。 點擊"創建"。

步驟 2

接下來，你需要為 CQRS 組織你的專案。 你可以透過將資料夾新增到不同的命令、查詢以及它們將使用的通用介面中來實現這一點。 在解決方案資源管理器中，右鍵單擊您的項目，轉到"新增"，然後選擇"新資料夾"。 建立三個資料夾："命令"、"查詢"和"介面"。

在"介面"資料夾中，新增指令和查詢的介面。 對於命令，您可以建立一個ICommandHandler接口，其中包含一個Handle方法，該方法接收命令並執行相應的操作。 對於查詢，您可以建立一個IQueryHandler接口，其中包含一個Handle方法，該方法接收查詢並傳回資料。

C# 中的 CQRS 模式（開發者如何理解）：圖 2 - 文件組織範例

步驟 3

現在，讓我們新增一個命令和查詢來示範一下。 假設你的應用程式管理任務，你想要新增任務（命令）和檢索任務（查詢）。

在"Interfaces"資料夾中，新增兩個介面：

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

在"命令"資料夾中，新增一個名為AddItemCommand 的類，並為其新增任務詳細資訊的屬性。 此外，新增一個實作ICommandHandler介面的AddItemCommandHandler類，其中包含向資料庫新增任務的邏輯。

在"查詢"資料夾中，新增一個名為GetTasksQuery 的類，該類表示任務請求。 新增另一個類別GetTasksQueryHandler，該類別實作IQueryHandler接口，並包含從資料庫中檢索任務的邏輯。

舉個簡單的例子，你的AddItemCommand可能看起來像這樣：

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

還有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
    }
}

如果GetItemsQuery不需要任何參數來取得任務，則其結果可能為空，此時GetItemsQueryHandler可能如下所示：

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

在 ASP.NET 控制器中，您將使用這些處理程序來處理命令和查詢。 若要新增任務，控制器操作會建立一個AddTaskCommand ，根據表單資料設定其屬性，然後將其傳遞給AddTaskCommandHandler實例進行處理。 要檢索任務，它會呼叫GetTasksQueryHandler來取得資料並將其傳遞給視圖。

將其連接到控制器

命令和查詢設定完成後，現在可以在控制器中使用它們了。 以下是在ItemsController類別中實作該功能的方法：

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

為了將所有內容連接起來，尤其是在 ASP.NET Core 中使用依賴注入 (DI) 時，您需要在Startup.cs檔案中將命令和查詢處理程序註冊到 DI 容器中。這樣，ASP.NET 就可以在需要時提供處理程序的實例。

以下是一個註冊處理程序的簡單範例：

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

在 CQRS 的實際應用中，寫入操作的資料模型與讀取操作的資料模型之間的差異是基礎性的，確保架構支援各種最佳化的資料處理方法。

程式碼範例

現在，讓我們來探討如何在遵循命令查詢職責分離 (CQRS) 模式的 C# 應用程式中使用 IronPDF。 以下是一個簡化的範例，示範如何在 CQRS 設定中使用 IronPDF 產生 PDF 報告。 本範例為概念性範例，重點在於如何透過指令產生 PDF 文件。

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

在這個例子中， GeneratePdfReportCommand表示 CQRS 模式中的一個指令。 它包含一個名為 GenerateReportAsync 的方法，該方法接受一個 HTML 字串作為reportContent ，以及一個用於保存 PDF 報告的輸出路徑。 IronPDF 的HtmlToPdf類別用於將 HTML 內容轉換為 PDF 格式，然後將其儲存到指定的路徑。 此設定說明如何將 PDF 生成功能整合到應用程式架構中，尤其是在需要像 CQRS 所提倡的那樣進行清晰的關注點分離的場景中。

CQRS 模式 C#（開發者使用方法）：圖 4 - 輸出的 PDF