MASA Framework 命令查询职责分离
概念
CQRS
(https://learn.microsoft.com/zh-cn/azure/architecture/patterns/cqrs)是一种与领域驱动设计和事件溯源相关的架构模式, 它的全称是Command Query Responsibility Segregation, 又叫命令查询职责分离, Greg Young在2010年创造了这个术语, 它是基于Bertrand Meyer 的 CQS (Command-Query Separation 命令查询分离原则) 设计模式。
CQRS
认为不论业务多复杂在最终实现的时候, 无非是读写操作, 因此建议将应用程序分为两个方面, 即Command(命令)和Query(查询)
命令端:
关注各种业务如何处理, 更新状态进行持久化
不返回任何结果 (void)
查询端:
查询, 并从不修改数据库
CQRS的三种实现
单一数据库的CQRS
命令与读取操作的是同一个数据库, 命令端通过ORM框架将实体保存到数据库中, 查询端通过数据访问层获取数据 (数据访问层通过ORM框架或者存储过程获取数据)
双数据库的CQRS
命令与读取操作的是不同的数据库, 命令端通过ORM框架将实体保存到 写库 (Write Db), 并将本地改动推送到 读库 (Read Db), 查询端通过数据访问层访问 读库 (Read Db), 使用这种模式可以带来以下好处:
查询更简单
读操作不需要任何的完整性校验, 也不需要外键约束, 可以减少锁争用, 我们可以针对查询端单独优化, 还可以使用刚好包含每个模板需要的数据的数据库视图,使得查询变得更快更简单
提升查询端的使用体验
由于这种架构将读写彻底分离,由于一般系统是读操作远远大于写操作, 这给我们的系统带来了巨大的性能提升, 极大的提升了客户的使用体验
关注点分离
读写分离的模型可以使得关注点分离, 使得读模型会变得相对简单
事件溯源 (Event Sourcing) CQRS
通过事件溯源实现的CQRS中会将应用程序的改变都以事件的方式存储起来, 使用这种模式可以带来以下好处:
事件存储中了完整的审计跟踪, 后续出现问题时方便跟踪
可以在任何的时间点重建实体的状态, 它将有助于排查问题并修复问题
提升查询端的使用体验
查询端与命令端可以是完全不同的数据源, 查询端可以针对查询条件做针对应的优化, 或者使用像
ES
、Redis
等用来存储数据, 提升查询效率
独立缩放
命令端与查询端可以被独立缩放, 减少锁争用
当然事情有利自然也有弊, CQRS的使用固然会带来很多好处, 但同样它也会给项目带来复杂度的提升, 并且双数据库模式、事件溯源模式 (https://microservices.io/patterns/data/event-sourcing.html) 的CQRS, 使用的是最终一致性, 这些都是我们在选择技术方案时必须要考虑的
设计
上述文章中我们了解到了CQRS其本质上是一种读写分离的设计思想, 它并不是强制性的规定必须要怎样去做, 这点与之前的IEvent
(进程内事件)、IIntegrationEvent
(跨进程事件)不同, 它并不是强制性的, 根据CQRS
的设计模式我们将事件分成Command
、Query
由于Query
(查询) 是需要有返回值的, 因此我们在继承IEvent
的同时, 还额外增加了一个Result
属性用以存储结果, 我们希望将查询的结果保存到Result
中, 但它不是强制性的, 我们并没有强制性要求必须要将结果保存到Result
中。
由于Command
(命令) 是没有返回值的, 因此我们并没有额外新增Result
属性, 我们认为命令会更新数据, 那就需要用到工作单元, 因此Command
除了继承IEvent
之外, 还继承了ITransaction
,这方便了我们在Handler
中的可以通过@event.UnitOfWork
来管理工作单元, 而不需要通过构造函数来获取
但MASA Framework
(https://github.com/masastack/MASA.Framework) 并没有要求必须使用 Event Sourcing 模式
(https://microservices.io/patterns/data/event-sourcing.html) 或者 双数据库模式
的CQRS, 具体使用哪种实现, 它取决于业务的决策者
下面就就来看看MASA Framework提供的CQRS
是如何使用的
入门
安装.NET 6.0 (https://dotnet.microsoft.com/zh-cn/download/dotnet/6.0)
1.新建ASP.NET Core 空项目Assignment.CqrsDemo
,并安装Masa.Contrib.Dispatcher.Events
,Masa.Contrib.Dispatcher.IntegrationEvents
,Masa.Contrib.Dispatcher.IntegrationEvents.Dapr
,Masa.Contrib.ReadWriteSplitting.Cqrs
,Masa.Contrib.Development.DaprStarter.AspNetCore
dotnet new web -o Assignment.CqrsDemo
cd Assignment.CqrsDemodotnet add package Masa.Contrib.Dispatcher.Events --version 0.7.0-preview.9 //使用进程内事件总线
dotnet add package Masa.Contrib.Dispatcher.IntegrationEvents --version 0.7.0-preview.9 //使用跨进程事件总线
dotnet add package Masa.Contrib.Dispatcher.IntegrationEvents.Dapr --version 0.7.0-preview.9 //使用Dapr提供pubsub能力
dotnet add package Masa.Contrib.ReadWriteSplitting.Cqrs --version 0.7.0-preview.9 //使用CQRSdotnet add package Masa.Contrib.Development.DaprStarter.AspNetCore --version 0.7.0-preview.9 //开发环境下协助 Dapr Sidecar, 用于通过Dapr发布集成事件
2.注册跨进程事件总线、进程内事件总线, 修改类Program.cs
示例中未真实使用DB, 不再使用发件箱模式, 只需要使用集成事件提供的PubSub
(https://docs.dapr.io/zh-hans/developing-applications/building-blocks/pubsub/pubsub-overview/)能力即可
builder.Services.AddIntegrationEventBus(dispatcherOptions =>
{dispatcherOptions.UseDapr();//使用 Dapr 提供的PubSub能力dispatcherOptions.UseEventBus();//使用进程内事件总线
});
3.注册Dapr Starter协助管理Dapr Sidecar
(开发环境使用)
if (builder.Environment.IsDevelopment())builder.Services.AddDaprStarter();
4.新增加添加商品方法, 修改类Program.cs
app.MapPost("/goods/add", async (AddGoodsCommand command, IEventBus eventBus) =>
{await eventBus.PublishAsync(command);
});/// <summary>
/// 添加商品参数, 用于接受商品参数
/// </summary>
public record AddGoodsCommand : Command
{public string Name { get; set; }public string Cover { get; set; }public decimal Price { get; set; }public int Count { get; set; }
}
5.新增加查询商品的方法, 修改类Program.cs
app.MapGet("/goods/{id}", async (Guid id, IEventBus eventBus) =>
{var query = new GoodsItemQuery(id);await eventBus.PublishAsync(query);return query.Result;
});/// <summary>
/// 用于接收查询商品信息参数
/// </summary>
public record GoodsItemQuery : Query<GoodsItemDto>
{public Guid Id { get; set; } = default!;public override GoodsItemDto Result { get; set; }public GoodsItemQuery(Guid id){Id = id;}
}/// <summary>
/// 用于返回商品信息
/// </summary>
public class GoodsItemDto
{public Guid Id { get; set; }public string Name { get; set; }public string Cover { get; set; }public decimal Price { get; set; }public int Count { get; set; }public DateTime DateTime { get; set; }
}
6.新增Command
处理程序, 添加类CommandHandler.cs
public class CommandHandler
{/// <summary>/// 将商品添加到Db,并发送跨进程事件/// </summary>/// <param name="command"></param>/// <param name="integrationEventBus"></param>[EventHandler]public async Task AddGoods(AddGoodsCommand command, IIntegrationEventBus integrationEventBus){//todo: 模拟添加商品到db并发送添加商品集成事件var goodsId = Guid.NewGuid(); //模拟添加到db后并获取商品idawait integrationEventBus.PublishAsync(new AddGoodsIntegrationEvent(goodsId, command.Name, command.Cover, command.Price,command.Count));}
}/// <summary>
/// 跨进程事件, 发送添加商品事件
/// </summary>
/// <param name="Id"></param>
/// <param name="Name"></param>
/// <param name="Cover"></param>
/// <param name="Price"></param>
/// <param name="Count"></param>
public record AddGoodsIntegrationEvent(Guid Id, string Name, string Cover, decimal Price, int Count) : IntegrationEvent
{public Guid Id { get; set; } = Id;public string Name { get; set; } = Name;public string Cover { get; set; } = Cover;public decimal Price { get; set; } = Price;public int Count { get; set; } = Count;public override string Topic { get; set; } = nameof(AddGoodsIntegrationEvent);
}
7.新增Query
处理程序, 添加类QueryHandler.cs
public class QueryHandler
{/// <summary>/// 从缓存查询商品信息/// </summary>/// <param name="query"></param>/// <returns></returns>[EventHandler]public Task GetGoods(GoodsItemQuery query){//todo: 模拟从cache获取商品var goods = new GoodsItemDto();query.Result = goods;return Task.CompletedTask;}
}
8.新增添加商品的跨进程事件的处理服务, 修改Program.cs
app.MapPost("/integration/goods/add",[Topic("pubsub", nameof(AddGoodsIntegrationEvent))](AddGoodsIntegrationEvent @event, ILogger<Program> logger) =>{//todo: 模拟添加商品到缓存logger.LogInformation("添加商品到缓存, {Event}", @event);});// 使用 dapr 来订阅跨进程事件
app.UseRouting();
app.UseCloudEvents();
app.UseEndpoints(endpoint =>
{endpoint.MapSubscribeHandler();
});
流水账式的服务会使得
Program.cs
变得十分臃肿, 可以通过MASA Framework提供的MinimalAPIs来简化Program.cs
点击查看详情(https://blogs.masastack.com/2022/07/12/masa/framework/practice/14.%20%E6%9C%80%E5%B0%8F%20API%20-%20MinimalAPIs)
我们上面的例子是通过事件总线来完成解耦以及数据模型的同步, 使用的双数据库模式, 但读库使用的是 缓存数据库
, 在Command
端做商品的添加操作, 在Query
端只做查询, 且两端分别使用各自的数据源, 两者业务互不影响, 并且由于缓存数据库性能更强, 它将最大限度的提升性能, 使得我们有更好的使用体验。
在Masa Framework中仅仅是通过ICommand
、IQuery
将读写分开, 但这并没有硬性要求, 事实上你使用IEvent
也是可以的, CQRS只是一种设计模式, 这点我们要清楚, 它只是告诉我们要按照一个什么样的标准去做, 但具体怎么来做, 取决于业务的决策者, 除此之外, 后续Masa Framework还会增加对Event Sourcing
(事件溯源 (https://docs.microsoft.com/zh-cn/azure/architecture/patterns/event-sourcing))的支持, 通过事件重放, 允许我们随时重建到对象的任何状态
本章源码
Assignment15
https://github.com/zhenlei520/MasaFramework.Practice
CQRS架构项目:https://github.com/masalabs/MASA.EShop/tree/main/src/Services/Masa.EShop.Services.Catalog
参考
CQRS 模式
(https://learn.microsoft.com/zh-cn/azure/architecture/patterns/cqrs)
在微服务中应用简化后的 CQRS 和 DDD 模式
(https://learn.microsoft.com/zh-cn/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/apply-simplified-microservice-cqrs-ddd-patterns)
.NET现代化应用开发 - CQRS&类目管理代码剖析
(https://www.bilibili.com/video/BV1D24y1R7jE)
开源地址
MASA.Framework:https://github.com/masastack/MASA.Framework
如果你对我们的 MASA Framework 感兴趣, 无论是代码贡献、使用、提 Issue, 欢迎联系我们
《MASA Framework实战课程》已开课
点击“阅读原文”查看课程安排
MASA Framework 命令查询职责分离相关推荐
- .NET Core开发实战(第34课:MediatR:轻松实现命令查询职责分离模式(CQRS))--学习笔记(下)...
34 | MediatR:轻松实现命令查询职责分离模式(CQRS) 实际上我们在定义我的查询的时候,也可以这样定义,例如我们定义一个 MyOrderQuery,把订单的所有名称都输出出去 namesp ...
- .NET Core开发实战(第34课:MediatR:轻松实现命令查询职责分离模式(CQRS))--学习笔记(上)...
34 | MediatR:轻松实现命令查询职责分离模式(CQRS) 核心对象 IMeditator IRequese.IRequest IRequestHandler<in TRequest, ...
- 浅谈命令查询职责分离(CQRS)模式
浅谈命令查询职责分离(CQRS)模式 在常用的三层架构中,通常都是通过数据访问层来修改或者查询数据,一般修改和查询使用的是相同的实体.在一些业务逻辑简单的系统中可能没有什么问题,但是随着系统逻辑变得复 ...
- DDD 中的CQRS(命令查询职责分离)架构模型有哪些?
更多内容关注微信公众号:fullstack888 命令/查询分离(CQS) 1988 年,Bertrand Meyer 在面向对象的软件设计一书中设计了 CQS 原则.简单来说,这个原则是说程序应当要 ...
- MediatR:轻松实现命令查询职责分离模式(CQRS)
核心对象 IMediator IRequest .IRequest<T> IResuestHandler<in TRequest,TResponse> 代码展示 创建名字为Me ...
- 云计算设计模式(六)——命令和查询职责分离(CQRS)模式
云计算设计模式(六)--命令和查询职责分离(CQRS)模式 隔离,通过使用不同的接口,从操作读取数据更新数据的操作.这种模式可以最大限度地提高性能,可扩展性和安全性;支持系统在通过较高的灵活性,时间的 ...
- MASA Framework - DDD设计(1)
DDD 领域驱动设计是一个有关软件开发的方法论,它提出基于领域开发的开发模式,基于DDD理论,我们可以设计出高质量的软件模型. 它围绕业务概念构建领域模型来控制业务的复杂度,解决软件难以理解和演化的问 ...
- 用sc命令查询系统状态
用sc命令查询系统状态 sc query 语法 sc query - Enumerates status for active services & driver ...
- Docker命令查询
2019独角兽企业重金招聘Python工程师标准>>> Docker命令查询 基本语法 docker [OPTIONS] COMMAND [arg...] 一般来说,Docker 命 ...
最新文章
- 用python解“BCD解密”问题
- Linux查看文件大小的几种方法
- c++调用python操作mongo
- C++实现has-a关系的两种方法
- python字符串常量有什么区别_Python经典面试题:is与==的区别
- html音乐播放器代码自动,html5 css3音乐播放器代码
- 读Zepto源码之Data模块
- Julia: wsl ubuntu下安装、vscode及配置profile错误补正
- PHP中英双语网站的设计思路
- notepad++打开bin文件
- 拔丝芋头的Java学习日记--Day2
- 新猿木子李:0基础学python培训教程 Python操作Redis
- 整理:学术论文发表过程中的审稿人意见答复技巧
- mysql中双引号和单引号有什么区别
- Android 应用开发
- Android电话系统rild-概述篇
- Infocomm前瞻:迪威视讯重推120吋激光触控屏
- 还不了解国际化视野与交叉学科思维?收下这份让你学业职业成长的秘籍!
- Python scikit-learn特征提取讲解
- [喵咪KafKa(2)]单机模式运行KafKa
热门文章
- 默认路由及静态路由配置
- 英文文献阅读器Paper Digest使用指南
- EndNote执行Update Citations and Bibliography导致Word崩溃
- vue 输入框输入经纬度的正则表达式
- SAP中国研究院总裁芮祥麟:平台与帽子
- kaldi的egs/sitw实验调试过程(ssh.pl并行两台机器)
- 大话设计模式之爱你一万年:第二十三章 行为模式:解释器模式:在也不用担心工资计算错误了:3.解释器模式之简单计算器3.0
- Mat类的成员函数(中文+英文)
- 科目三 临时停车 与 红绿灯 路口 LTS
- ROV水下机器人的视频流获取