CQRS模式C#（开发人员如何使用）

步骤 1：设置您的 ASP.NET 应用程序

1. 启动 Visual Studio 并选择创建一个新项目。
2. 搜索并选择"ASP.NET Core Web 应用程序"项目类型。点击下一步。

4. 选择 ASP.NET Core 的"Web 应用程序（模型-视图-控制器）"模板。确保您正在定位符合您要求的 .NET Core 版本。 点击创建。

步骤 2 接下来，您需要为 CQRS 组织您的项目。 点击创建。

您可以通过添加文件夹来分隔命令、查询和它们将使用的公共接口来完成这项工作。

在解决方案资源管理器中，右键单击您的项目，转到"添加"，然后选择"新建文件夹"。 创建三个文件夹："Commands"、"Queries"和"Interfaces"。 在"Interfaces"文件夹中，为您的命令和查询添加接口。 对于命令，您可能会有一个接口 ICommandHandler，其中包含一个 Handle 方法，该方法接受命令并执行操作。

对于查询，您可能会有一个接口 IQueryHandler，其中包含一个 Handle 方法，该方法接收查询并返回数据。 ### 步骤 3

假设您的应用程序管理任务，您想添加一项任务（命令）并检索任务（查询）。

在"Interfaces"文件夹中，添加两个接口： 在"Commands"文件夹中，添加一个类 AddItemCommand，包含任务详细信息的属性。

同时，添加一个类 AddItemCommandHandler，它实现了 ICommandHandler 并包含将任务添加到数据库的逻辑。

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

在"Commands"文件夹中，添加一个包含任务详细信息属性的类 AddItemCommand。 此外，添加一个实现 ICommandHandler 的类 AddItemCommandHandler，并包含将任务添加到数据库的逻辑。

在"Queries"文件夹中，添加一个表示任务请求的类 GetTasksQuery。 添加另一个实现 IQueryHandler 的类 GetTasksQueryHandler，并包含从数据库检索任务的逻辑。

作为一个简单的例子，您的 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，接受 reportContent 作为 HTML 字符串，以及一个 outputPath，PDF 报告将保存在此路径下。 IronPDF 的 HtmlToPdf 类用于将 HTML 内容转换为 PDF 格式，然后保存到指定路径。 这个设置说明了如何将 PDF 生成功能集成到您应用程序的架构中，特别是在需要按 CQRS 提倡的明确关注点分离的场景中。

！CQRS Pattern C# (开发人员如何使用)：图 4 - 输出的 PDF