C#和干净架构中的CQRS模式——简化的初学者指南

寒冰屋

于 2024-07-11 09:39:03 发布

阅读量109

点赞数

分类专栏： CSharp.NET 文章标签： C# CQRS

原文链接：https://www.codeproject.com/Articles/5377617/CQRS-Pattern-in-Csharp-and-Clean-Architecture-A-Si

版权

CSharp.NET 专栏收录该内容

1245 篇文章 60 订阅

订阅专栏

常见问题解答：C#和Clean Architecture中的CQRS模式

如何在C#和.NET Core中实现CQRS模式？

使用干净架构实现CQRS模式的最佳实践是什么？

在本文中，我们将探讨在具有Clean Architecture的C#中实现CQRS模式的好处。作为一名软件工程师，不断寻找有助于改进我们的工作流程、代码质量和整体软件设计的最佳开发实践和策略非常重要。我们不需要实现我们看到的所有内容，但学习和理解是有帮助的！

除了探索如何在C#中集成这些概念之外，我们还将看到使用CQRS模式和干净体系结构的好处。通过结合这两个概念，我们可以创建易于测试和维护的强大且可扩展的软件应用程序。

在本文结束时，你将掌握了解如何在C#中使用Clean Architecture实现CQRS模式所需的知识和实际示例，从而为您的团队提供一套新的开发工具和策略。

了解CQRS模式

CQRS（命令查询责任分离）模式是一种设计模式，用于在软件应用程序中分离不同的责任类型。CQRS背后的基本思想是将应用程序的操作拆分为两组：

命令，负责更改应用程序的状态
查询，在不更改任何状态的情况下检索数据

使用CQRS模式的好处包括更高的可伸缩性、简化的代码维护和更低的代码复杂性。它还允许针对系统的特定需求，并有助于解决传统CRUD架构中常见的不一致问题。

与传统的CRUD操作相比，CQRS操作由于其隔离性质而更加复杂。命令将发送到相应的命令处理程序，这些命令处理程序会改变系统的状态，查询将发送到返回只读信息的查询处理程序。

在实践中，CQRS非常适合具有复杂或快速变化的业务需求的系统，否则使用传统的基于 CRUD的设计模式将难以维护这些需求。

C#中的CQRS模式实现

若要在C#中使用.NET Core实现CQRS模式，应将命令和查询操作组织到单独的类或模块中，以确保它们符合CQRS的原则。通过实现CQRS模式，可以将实现读取命令的代码与实现更新命令的代码分开，从而提供更高效且可伸缩的应用程序。

在实现CQRS模式时，有一些最佳实践需要遵循，这些最佳实践可以优化性能并提供更好的组织。例如，将读取和写入过程识别并隔离到不同类型的模型中，并避免在它们之间共享过多的代码非常重要。

CQRS模式涉及三个主要组件：命令、命令处理程序和查询处理程序。命令表示用户执行某些操作的意图，并传递给命令处理程序，命令处理程序将操作应用于域模型。查询处理程序负责管理从读取存储中检索数据。

实现CQRS模式的挑战之一是需要将读取和写入操作完全分开，以免引入任何读写争用问题。仔细的设计和测试有助于避免这些挑战，并使CQRS模式实现取得成功。

Clean架构概述

干净架构是一种软件架构模式，它有助于以将业务代码与实现细节分开的方式组织和构建软件应用程序。它的核心思想是确保架构的设计独立于其实现中涉及的任何框架或库。通过将核心业务逻辑与基础架构和交付机制分离，该架构仍然专注于其旨在解决的业务问题。

干净的架构对软件开发有很多好处。首先，它允许轻松适应需求随时间的变化，避免了重写大量代码的需要。其次，它鼓励实现最佳实践，例如可维护性、可测试性和可伸缩性，确保代码干净且易于理解。最后，它提供了生成代码源，使其管理和维护更加高效。

Clean Architecture涉及四个主要组件：实体、用例、接口适配器和基础结构。实体的存在是为了表示应用程序中的核心业务对象。用例包含特定操作的业务逻辑。接口适配器负责将用例连接到外部世界。最后，基础结构表示最外层，包含UI和任何数据库或网络访问代码。

当我们将Clean Architecture与传统的分层架构进行比较时，我们可以看到它更加模块化和可扩展。传统的分层架构通常按层（例如表示层、业务层和数据层）分隔关注点。虽然这种方法很有帮助，但随着系统变得更加复杂，它可能会使维护变得更加困难，从而导致各层之间的相互依赖性。Clean Architecture避免了这种复杂性，因为它只专注于业务逻辑，使其不易出现架构腐烂。

使用C#实现干净的架构

在C#中实现Clean Architecture时，重要的是要认识到四个组件中的每一个所扮演的角色。实体和用例表示应用程序的核心业务逻辑，接口适配器管理用例和基础架构组件之间的通信，基础架构表示体系结构的最外层。

为了成功实现Clean Architecture，我们需要牢记一些最佳实践。例如，实体和用例应该与基础结构无关，并使用普通的C#类，提供解耦的体系结构，避免过度维护。此外，应用SOLID原则可确保代码灵活且易于扩展。最后，异步实现用例有助于保证更好的可伸缩性。

Clean Architecture的每个组件在整个架构的实现中都扮演着特定的角色。实体表示业务对象，用例实现业务逻辑，接口适配器处理接口转换，基础架构管理与外界的通信。仔细设计和实现最佳实践有助于避免在实现清洁架构时可能出现的任何挑战。

具有干净体系结构的C#中的CQRS模式

将CQRS模式与C#中的干净体系结构相结合，为构建可扩展和可维护的软件提供了一组方法和原则。CQRS模式通过允许分离命令和查询操作来加强单一责任原则;而Clean Architecture则坚持测试、数据和领域建模的分离。事实证明，这两种模式的集成对开发现代软件系统非常有益。

在C#中实现具有干净体系结构的CQRS模式提供了广泛的好处。干净架构模式提供的关注点分离允许开发人员将系统拆分为干净的层，使其更易于管理和维护。此外，CQRS模式的命令和查询操作分离有助于通过优化数据查询和写入操作来提高系统性能。

干净的架构构成了应用程序的基础，而CQRS模式则为每个操作提供了设计。使用干净架构实现CQRS模式应依赖于实际代码示例和对系统领域和需求的全面理解。如何实现这两种模式的一个示例是域驱动设计（DDD），其中的重点是了解问题域以定义解决方案。

C#中CQRS模式的电子商务代码示例

若要更详细地查看此组合，请考虑电子商务应用程序方案。下面是构建命令操作以添加新产品的方法：

// Command
public class AddProductCommand : IRequest<bool>
{
    public string Name { get; set; }
    public decimal Price { get; set; }
}

// Command Handler
public class AddProductCommandHandler : IRequestHandler<AddProductCommand, bool>
{
    private readonly IProductRepository _repository;

    public AddProductCommandHandler(IProductRepository repository)
    {
        _repository = repository;
    }

    public async Task<bool> Handle(
        AddProductCommand request,
        CancellationToken cancellationToken)
    {
        var product = new Product
        {
            Name = request.Name,
            Price = request.Price
        };

        await _repository.AddAsync(product);
        return true;
    }
}

// Product Repository Interface
public interface IProductRepository
{
    Task AddAsync(Product product);
}

// Product Entity
public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
}

此代码片段演示了通过处理命令操作来分离关注点，以在实现CQRS和Clean Architecture的系统中添加新产品。该AddProductCommand类定义操作所需的数据，而AddProductCommandHandler类封装执行命令的逻辑，通过抽象（Product）与领域模型（IProductRepository）交互。

C#中CQRS模式的任务管理代码示例

接下来，让我们用一个任务管理系统示例来说明C# Clean Architecture中的CQRS模式，该示例侧重于创建新任务的命令操作：

// Command
public class CreateTaskCommand : IRequest<bool>
{
    public string Title { get; set; }
    public string Description { get; set; }
}

// Command Handler
public class CreateTaskCommandHandler : IRequestHandler<CreateTaskCommand, bool>
{
    private readonly ITaskRepository _repository;

    public CreateTaskCommandHandler(ITaskRepository repository)
    {
        _repository = repository;
    }

    public async Task<bool> Handle(
        CreateTaskCommand request,
        CancellationToken cancellationToken)
    {
        var task = new TaskEntity
        {
            Title = request.Title,
            Description = request.Description
        };

        await _repository.AddAsync(task);
        return true;
    }
}

// Task Repository Interface
public interface ITaskRepository
{
    Task AddAsync(TaskEntity task);
}

// Task Entity
public class TaskEntity
{
    public int Id { get; set; }
    public string Title { get; set; }
    public string Description { get; set; }
}

此代码片段通过定义用于创建任务的明确命令操作，在干净体系结构的上下文中展示了CQRS模式。关注点的分离体现在命令、处理程序和存储库的不同角色上——所有这些都符合Clean Architecture的原则！

在C#和干净的体系结构中总结CQRS模式

使用干净的体系结构在C#中实现CQRS模式可以为您的项目带来明显的好处。通过分离读取和写入职责，可以增强性能、可伸缩性和可维护性。Clean Architecture提供了一个标准结构，该结构还支持关注点的分离，促进了清晰有序的代码库。将这两种技术结合在一起时，您将创建一个强大的框架，该框架可以彻底改变您的C#开发过程。

在进一步学习方面，网上有许多资源和教程可以继续提高您在该领域的技能。一些有用的资源包括DDD（域驱动设计）、SOLID原则和设计模式。通过利用CQRS模式和干净架构并结合最佳实践，您可以确保您的C#开发专注于性能、规模和可维护性！