.NET 帮助

CQRS 模式 C#(开发人员的工作原理)

发布 2024年四月3日
分享:

CQRS 简介

CQRS 是 "命令查询责任隔离"(Command Query Responsibility Segregation)的缩写。这是一种将数据读取与数据写入分离的模式。这种区分至关重要,原因有几个。首先,它允许对每个操作进行更灵活的优化,从而提高应用程序的性能和可扩展性。如果将命令 (写道) 和查询 (读数)您可以对它们进行独立优化。

例如,一个复杂的应用程序可能需要快速的读操作,但可以容忍较慢的写操作。通过应用 CQRS,开发人员可以为读取和写入使用不同的数据模型,隔离数据访问层,以满足每种操作的特定需求。在本文中,我们将探讨 CQRS 模式和 IronPDF 图书馆

核心概念和组成部分

CQRS 的核心在于将命令和查询操作分开,各自处理数据交互的不同方面。了解这些组件对于有效实施该模式至关重要。

  • 命令:这些命令负责更新数据。命令体现了复杂的业务逻辑,可以在不返回任何信息的情况下改变数据存储中的数据状态。命令专门负责处理写入数据任务,直接影响应用程序的状态,而不产生任何输出。例如,添加新用户或更新现有产品详细信息都是命令执行的操作。
  • 查询:查询由查询处理程序管理,在不改变系统状态的情况下检索数据或数据传输对象。它们是对数据提出的问题。例如,获取用户配置文件或列出库存中的所有产品就是查询。查询会返回数据,但确保不会修改数据或其状态。

MediatR 是在 .NET 应用程序中实现 CQRS 的常用工具之一,它是一个中介模式库。它有助于减少应用程序组件之间的耦合,使它们间接地进行通信。MediatR 通过在命令/查询及其处理程序之间进行调解,促进了命令和查询的处理。

使用 ASP.NET Core 进行实际实施

在 ASP.NET Core 中实施 CQRS 模式涉及设置您的项目,将命令和查询分开,并使用 MediatR 这样的库在它们之间进行调解。以下是如何在 ASP.NET Core 应用程序中设置 CQRS 的简化概述。

第 1 步:设置 ASP.NET 应用程序

1.启动 Visual Studio 并选择创建一个新项目。

2.搜索并选择 "ASP.NET Core Web Application "项目类型。单击下一步。

CQRS 模式 C#(如何为开发人员工作):图 1 - 创建新的 ASP.NET 项目

3.为项目命名并设置其位置。单击创建。

4.选择 "网络应用程序 (模型-视图-控制器)"模板。确保您使用的 .NET Core 版本符合您的要求。单击 "创建"。

步骤 2

接下来,你需要为 CQRS 组织你的项目。可以通过添加文件夹来分隔命令、查询和它们将使用的常用界面。在解决方案资源管理器中,右键单击项目,转到 "添加",然后是 "新建文件夹"。创建三个文件夹:"命令"、"查询 "和 "界面"。

在 "接口 "文件夹中,为命令和查询添加接口。对于命令,可以使用接口 IommandHandler,其中的方法 Handle可以接收命令并执行操作。对于查询,可以使用接口 IQueryHandler,其方法 Handle可接收查询并返回数据。

CQRS 模式 C#(如何为开发人员工作):图 2 - 如何组织文件的示例

步骤 3

现在,让我们添加一个命令和查询来演示一下。假设您的应用程序管理任务,而您想添加一个任务 (指挥部) 和检索任务 (询问).

在 "接口 "文件夹中,添加两个接口:

//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
VB   C#

在 "Commands(命令)"文件夹中添加一个类 AddItemCommand,其中包含任务详细信息的属性。同时,添加一个 AddItemCommandHandler 类,该类实现了 ICommandHandler,包含向数据库添加任务的逻辑。

在 "Queries(查询)"文件夹中,添加一个表示任务请求的类 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;
    }
}
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
VB   C#

以及 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
VB   C#

如果不需要任何参数来获取任务,GetItemsQuery 可以是空的,GetItemsQueryHandler 可以是这样的:

public class GetItemsQuery
{
    // This class might not need any properties, depending on your query
}
using CQRS_testing.Interfaces;
namespace CQRS_testing.Queries
{
    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
}
using CQRS_testing.Interfaces;
namespace CQRS_testing.Queries
{
    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
VB   C#

在 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");
    }
}
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
VB   C#

尤其是在使用依赖注入的情况下,要将所有内容连接起来 (DI) 在 ASP.NET Core 中,您需要在 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>();
builder.Services.AddTransient(Of ICommandHandler(Of AddItemCommand), AddItemCommandHandler)()
builder.Services.AddTransient(Of IQueryHandler(Of GetItemsQuery, IEnumerable(Of String)), GetItemsQueryHandler)()
VB   C#

在 CQRS 的实际应用中,用于写入操作的数据模型和用于读取操作的数据模型之间的区别是基础,可确保架构支持各种优化的数据处理方法。

IronPDF:C# PDF Library

CQRS 模式 C#(如何为开发人员工作):图 3 - IronPDF 网页

IronPDF 是一款面向使用 C# 编程语言的开发人员的工具,允许他们直接在其应用程序中创建、阅读和编辑 PDF 文档。该库具有用户友好性,可以更简单地集成 PDF 功能,如生成 PDF 报告、发票或文档。 来自 HTML 的表格 代码IronPDF 支持多种功能,包括编辑 PDF 中的文本和图像、设置文档安全性以及将网页转换为 PDF 格式。它的多功能性和易用性使其成为希望在项目中实现 PDF 操作的开发人员的宝贵资源。

IronPDF 的优势在于 HTML 转 PDF 功能,并保持所有布局和样式完好无损。它能从网页内容创建 PDF,适用于报告、发票和文档。HTML 文件、URL 和 HTML 字符串均可无缝转换为 PDF。

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}
using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}
Imports IronPdf

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		Dim renderer = New ChromePdfRenderer()

		' 1. Convert HTML String to PDF
		Dim htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>"
		Dim pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent)
		pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf")

		' 2. Convert HTML File to PDF
		Dim htmlFilePath = "path_to_your_html_file.html" ' Specify the path to your HTML file
		Dim pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath)
		pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf")

		' 3. Convert URL to PDF
		Dim url = "http://ironpdf.com" ' Specify the URL
		Dim pdfFromUrl = renderer.RenderUrlAsPdf(url)
		pdfFromUrl.SaveAs("URLToPDF.pdf")
	End Sub
End Class
VB   C#

代码示例

现在,让我们按照命令查询责任隔离来探讨如何在 C# 应用程序中使用 IronPDF (CQRS) 模式。下面是一个简化示例,演示如何在 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);
        }
    }
}
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
VB   C#

在本例中,GeneratePdfReportCommand 代表 CQRS 模式中的一个命令。它包括一个方法 GenerateReportAsync,该方法接收 HTML 字符串 reportContent和保存 PDF 报告的 outputPath。IronPDF 的 HtmlToPdf 类用于将 HTML 内容转换为 PDF 格式,然后保存到指定路径。该设置说明了如何将 PDF 生成功能集成到应用程序的架构中,特别是在需要明确分离关注点的场景中,正如 CQRS 所提倡的那样。

CQRS 模式 C#(如何为开发人员工作):图 4 - 输出 PDF

结论

CQRS 模式 C#(如何为开发人员工作):图 5 - IronPDF 许可证页面

总之,命令查询责任分离 (CQRS) 模式提供了一种结构化的方法,可将应用程序中读取和写入数据的责任分开。这种分离不仅明确了架构,还增强了系统的灵活性、可扩展性和性能。按照上述步骤,您可以在 ASP.NET Core 应用程序中实施 CQRS,使用 MediatR 等工具简化命令、查询及其处理程序之间的通信。

将 IronPDF 集成到基于 CQRS 的应用程序中可进一步扩展其功能,使您能够毫不费力地创建、处理和存储 PDF 文档。无论您是要生成报告、发票还是任何形式的文档,IronPDF 的全面功能和简单语法都使其成为您开发工具包中的强大工具。IronPDF 提供了 免费试用,让你在投入使用前有机会探索其功能。对于持续使用,许可证从 $749 开始,提供各种选项以满足您的项目需求。

< 前一页
在C#中(对开发人员的工作原理)
下一步 >
C# 单元测试(它如何为开发人员工作)

准备开始了吗? 版本: 2024.9 刚刚发布

免费NuGet下载 总下载量: 10,731,156 查看许可证 >