ENode 2.0 第一个真实案例剖析-一个简易论坛(Forum)

开发 前端
经过不断的坚持和努力,ENode 2.0的第一个真实案例终于出来了。这个案例是一个简易的论坛,开发这个论坛的初衷是为了验证用ENode框架来开发一个真实项目的可行性。目前这个论坛在UI上是使用了最终一致性,也就是说当我们发帖或回帖后不会立马显示你的帖子或回复。

前言

经过不断的坚持和努力,ENode 2.0的***个真实案例终于出来了。这个案例是一个简易的论坛,开发这个论坛的初衷是为了验证用ENode框架来开发一个真实项目的可行性。目前这个论坛在UI上是使用了最终一致性,也就是说当我们发帖或回帖后不会立马显示你的帖子或回复。当我们下一次刷新页面时,会显示出来。这点貌似很多人向我反馈不太习惯,接受不了,呵呵。我之所以这样做也是想看看最终一致性大家的接受程度如何,看来UI层面上的最终一致性,大部分人接受不了。回头我改进下效果,改为立即可以看到帖子或回复吧!另外,关于ENode是什么,本文就不多介绍了,可以参考这篇文章的介绍。本文重点介绍一下ENode是如何帮助我们开发一个基于DDD+CQRS+Event Sourcing架构的应用程序的。这个论坛使用到了ENode, EQueue两个框架,EQueue是一个分布式的消息队列组件,该组件的主体思想是参考阿里的RocketMQ。当我们使用EQueue时,面向的不是Queue,而是Topic。EQueue也是完全用C#实现的,关于EQueue详细介绍,大家可以看一下这篇文章

ENode, EQueue, Forum 开源项目地址

  1. ENode开源地址:https://github.com/tangxuehua/enode
  2. EQueue开源地址:https://github.com/tangxuehua/equeue
  3. ECommon开源地址:https://github.com/tangxuehua/ecommon
  4. Forum开源地址:https://github.com/tangxuehua/forum
  5. Forum论坛线上地址(临时域名,以后会改为enode.me):http://enode.cloudapp.net
  6. Forum论坛的equeue消息数据监控统计页面:http://enode.cloudapp.net/equeueadmin

另外,项目中如果要开发引用程序集,可以通过Nuget来获取,输入关键字ENode就能看到所有相关的Package了,如下图所示:

Forum总体架构分析

Forum采用DDD+CQRS+Event Sourcing的架构。借助于ENode,使得Forum本身无须再做技术架构方面的设计了,直接使用ENode就能完成这种架构。所以我们只要明白了ENode的架构,就知道这个Forum的架构是怎样的了。以下是ENode的架构图(已经理解了这个图的朋友请直接跳过这一节):

上图是一个CQRS架构的数据流向图。UI请求会分为两类:Command和Query。

Command用于写数据,Query用于读数据,写数据和读数据完全采用不同的架构实现。写数据支持同步和异步的方式,读数据完全走简单高效思路来实现。当我们要对系统做写操作时,如果你是用ASP.NET MVC来开发站点,那就可以在Controller中创建并发送一个Command即可。该Command会被发送到消息队列(EQueue中),然后消息队列的订阅方,也就是处理Command的进程会拉取这些Command,然后调用Command Handler完成Command的处理;Command Handler处理Command时,是调用Domain的方法来完成相关的业务逻辑操作。Domain就是DDD中的领域层,负责实现整个系统的业务逻辑。 然后由于是Event Sourcing的架构,所以Domain中任何聚合根的修改都会产生相应的领域事件(Domain Event),领域事件会先被持久化到EventStore中,持久化如果没有遇到并发冲突,成功后,则会被发布(Publish)到消息队列(EQueue中),然后消息队列的订阅方,也就是处理Domain Event的进程会拉取这些Domain Event,然后调用相关的Event Handler做相关的更新,比如有些Event Handler是会更新读库(Read DB),有些是会产生新的Command,这种我把它叫做流程管理器(Process Manager,也有人叫做Saga)。当我们有时一个业务场景需要涉及到多个聚合根的修改时,我们会需要用到Process Manager。Process Manager负责对流程进行建模,它的原理是基于事件驱动的流程实现。Process Manager处理事件,然后产生响应的Command,从而完成聚合根之间的交互。一般一个流程,我们会设计一个流程聚合根以及其他的参与该流程的聚合根,Process Manager则是用于负责协调这些聚合根之间的交互。具体的例子可以看一下ENode源代码中的BankTransferSample。

关于Query端,由于都是查询,这些查询都是用于UI展示数据或者为第三方接口提供数据为目的,查询对系统无副作用。我们可以用我们自己任意喜欢的方式来实现Query端。查询面向的是Read DB。上面提到,Read DB中的数据是通过Event Handler(老外叫Denormalizer)来更新的。

所以我们可以看到,整个架构中,Command端和Query端的数据源是完全分离的。Command端***的结果就是Domain Event,Domain Event是持久化在Event Store中的;Query端的数据源就是Read DB,一般可以用关系型数据库来作为存储。CQ两端的数据同步通过Domain Event来实现。

上图的CQRS架构***的好处是在架构级别以及数据存储级别,把读写都分离了。这样我们可以方便的对读或写单独做优化。另外由于使用了Event Sourcing的架构,使得我们的Command端只要持久化了Domain Event,就意味着保存了这个Domain的所有状态。这个特性,可以让我们的框架有很多设计余地,比如不必考虑Domain Event和业务数据要强一致等问题,因为Domain Event本身就是业务数据本身了,我们通过Domain Event随时可以还原出任意时刻的Domain的状态。当我们要查询Domain的当前***数据时,就走Query端即可。当然,由于Query端是异步更新的,所以Query端的数据可能会有一点点延迟。这点也就是我们平时一直讲到的最终一致性(CQ两端的数据最终会一致)。

通过上面的架构图,我们知道,一个Command发出后会经过两个阶段的处理:1)先被某个Command Service处理(调用Domain完成业务逻辑产生Domain Event);2)再被Event Service处理(响应Domain Event,完成Read DB的更新或者产生新的Command);理解这两个阶段对理解下面的Forum的项目结构很有用处。

#p#

Forum项目结构分析

 

以上是Forum的项目工程结构,项目中包含四个宿主工程,分别是:

Forum.BrokerService:

这个工程用于宿主EQueue的Broker,整个论坛中所有的Command,Domain Event的消息,都会被放在Broker上。比如Controller发送的Command会被发送到Broker,同样Domain产生的Domain Event也会被发送到Broker;然后消费者消费消息则都是从BrokerService拉取消息。由于该宿主工程不需要和用户交互,所以我部署为Windows Service。

Forum.CommandService:

这个工程就是用于处理Command的进程,同样也部署为Windows Service。

Forum.EventService:

这个工程就是用于处理Domain Event的进程,同样也部署为Windows Service。

Forum.Web:

这个就是论坛的Web站点了,不用多讲了;这个Web站点做的事情就是发送Command或者调用Query端的查询服务查询数据;Web站点只需要依赖于Forum.Commands和Forum.QueryServices即可,因为它只需要发送Command和查询数据即可。

Forum.CommandHandlers:

所有的Command Handler都在这个工程,Command Handler的职责是处理Command,调用Domain的方法完成业务逻辑;

Forum.Commands:

所有的Command都在这个工程中,每个Command都是一个DTO,会被封装为消息发送到EQueue。

Forum.Domain:

就是论坛的领域层了,所有的聚合以、工厂、领域服务,以及领域事件等都在这个工程中。这个工程是整个Forum最有价值的地方,是业务逻辑所在的工程。

Forum.Domain.Dapper:

由于Domain中可能会定义一些接口,这些接口背后的持久化需要在外部实现;如果按照经典DDD的架构,比如仓储接口是在Domain层定义,而实现则是在基础层(Infrastructure)中。而从经典DDD的分层架构图上来看,Domain层是依赖于Infrastructure层的,但是Infrastructure层中又有一些仓储的实现类要依赖于Domain层;虽然我能理解这种双向依赖,但很容易会给不少学DDD的人带来困惑,所以我更加倾向于,把Domain看做是架构的核心,其他一切都是Domain的外围。这个思想其实和六边形架构是一个思路。就是从架构上来看,不是上层依赖于下层,而是外层依赖于内层;内层通过定义出接口,外层实现接口,内层只要面向自己定义的接口即可。所以基于这个思路,我会把Forum.Domain中定义的接口,如果用Dapper来实现,那我就定义一个Forum.Domain.Dapper这样的工程,意思是实现Forum.Domain.Dapper依赖于内层的Forum.Domain。假如以后我们有一个基于EntityFramework的实现,则只要再创建一个Forum.Domain.EntityFramework这样的工程即可。所以可以看出,Forum.Domain.Dapper这种工程司机上是Forum.Domain对外部的适配器,Forum.Domain里定义好适配接口,Forum.Domain.Dapper这种工程实现这些适配接口。基于这种思想,我们的架构就没有了上层依赖下层的概念了,而是替换为内外层的关系,内层不依赖外层,外层依赖于内层,内层与外层直接通过适配器接口来交互,或者通过Domain Event也可以。这样我们就不用再去纠结经典DDD中看似双向依赖的问题了。

Forum.Domain.Tests:

这个工程就是对Forum.Domain的一个测试工程。每个测试用例会模拟Controller发起Command,然后***检查Domain中的状态是否正确修改。

Forum.QueryServices:

这个工程定义了Query端的所有查询接口,Forum.Web站点依赖于这个工程中的查询服务接口;然后这些查询接口的实现则是放在Forum.QueryServices.Dapper中。Forum.QueryServices与Forum.QueryServices.Dapper之间的关系和Forum.Domain与Forum.Domain.Dapper之间的关系类似,这里就不在重复了。

Forum.Denormalizers.Dapper:

这个工程中的就是所有的Denormalizer,Denormalizer就是负责处理Domain Event,然后更新读库。然后由于目前使用Dapper实现数据持久化,所以工程名以Dapper结尾。

Forum.Infrastructure:

这是一个基础工程,存放所有基础的公共的东西,比如一些业务无关的服务或配置信息或全局变量等东西;需要强调的是:这里的Forum.Infrastructure和经典DDD中的Infrastructure不是同一个概念。DDD中的Infrastructure是一个逻辑上的分层,领域层中所有的技术支撑实现都在Infrastructure中;而这里的Infrastructure,则仅仅只是一些Common的基础的公用的东西,Infrastructure不是为了为其它哪一层服务的,它可以被其他任何项目使用;

好了,以上简单介绍了每个工程的作用和设计目的。下面我们来看看Forum的领域模型的设计吧!

Forum的Domain Model的设计

  • 核心功能需求分析:
    1. 提供用户注册、登录、注销三个功能;注册用户时需要验证用户名是否唯一;
    2. 提供发帖、回帖、修改帖子、修改回复,以及回复的回复这些基本核心功能;
    3. 系统管理员可以对论坛版块进行维护;
  • 聚合识别:识别出来的聚合有:论坛账号、帖子、回复、版块这四个。
  • 再分析下每个聚合我们所关心的信息:账号的最少信息应该有:账号名称+密码;版块要有名称即可;帖子要有标题、内容、发帖人、发帖时间、所属版块;回复要有回复内容、回复时间、回复人、所属版块,父回复(可以为空);
  • 场景走查:注册就是创建账号(账号唯一性的设计后面在详细分析);登录本质就是调用Query端的查询服务查找账号是否存在,所以不需要Domain做什么处理,注销也是;发帖就是创建帖子;回帖就是创建回复;修改帖子就是对帖子聚合根做修改;修改回复就是对回复聚合根做修改;版块添加就是创建一个版块聚合根;
  • 关键业务规则识别:1)账号名称不能重复;2)帖子必须要有所属版块和发帖人;3)回复必须要有一个对应的帖子和回复人;
  • 关键业务规则的实现:
    1. 如何实现账号名称不能重复?首先它是一条业务规则,所以必须在Domain里实现,而不应该在Command Handler里。然后由于Event Sourcing的架构,天生有一个缺陷就是无法实现唯一性约束这种需求。所以我们需要在Domain中显式设计出可以表达聚合根索引的东西,我把它们叫做IndexStore,表示是一种聚合根索引的存储。这个思路非常类似于在经典DDD中,我们有仓储(Repository)的概念,仓储维护了所有的聚合根;而我这里的IndexStore则是维护了聚合根的索引信息。有了这个索引信息后,我们就能在注册新账号时,在Domain中设计一个RegisterAccountService这样的领域服务,领域服务里通过AccountIndexStore来检查账号名称是否重复,如果不重复,则将当前账号名称添加到AccountIndexStore中,如果重复,则报异常。另外一个非业务的点需要考虑,那就是如何实现并发注册用户的处理。我们可以在Command Handler中实现db级别的锁(但不不需要锁整个账号表,而是锁一个其他表中的某一条记录),确保同一时刻,不会有两个Account名称添加到AccountIndexStore中;我们通过RegisterAccountService把“账号名称不能重复”的这个业务规则显式的表达出来,从而在代码级别体现领域内实现了这个业务规则。以前,如果没有用Event Sourcing,我们可能会依赖db的唯一索引来实现这个唯一性,虽然功能上也可以实现,但实际上账号名称不能重复的这个业务规则没有体现在领域内。这点也是我这次通过实现基于Event Sourcing而实现的唯一性验证而想到的点。
    2. 帖子必须要有所属版块和发帖人,这条业务规则很容易保证,只要在帖子聚合根上,对版块和发帖子判断是否为空就行了;
    3. 回复必须要有一个对应的帖子和回复人,也是同理,只要在构造函数中判断是否为空即可;

#p#

以注册新用户为例,展示代码实现

客户端JS通过angularJS提交注册信息:

  1. $scope.submit = function () {  
  2.         if (isStringEmpty($scope.newAccount.accountName)) {  
  3.             $scope.errorMsg = '请输入账号。';  
  4.             return false;  
  5.         }  
  6.         if (isStringEmpty($scope.newAccount.password)) {  
  7.             $scope.errorMsg = '请输入密码。';  
  8.             return false;  
  9.         }  
  10.         if (isStringEmpty($scope.newAccount.confirmPassword)) {  
  11.             $scope.errorMsg = '请输入密码确认。';  
  12.             return false;  
  13.         }  
  14.         if ($scope.newAccount.password != $scope.newAccount.confirmPassword) {  
  15.             $scope.errorMsg = '密码输入不一致。';  
  16.             return false;  
  17.         }  
  18.  
  19.         $http({  
  20.             method: 'POST',  
  21.             url: '/account/register',  
  22.             data: $scope.newAccount  
  23.         })  
  24.         .success(function (result, status, headers, config) {  
  25.             if (result.success) {  
  26.                 $window.location.href = '/home/index';  
  27.             } else {  
  28.                 $scope.errorMsg = result.errorMsg;  
  29.             }  
  30.         })  
  31.         .error(function (result, status, headers, config) {  
  32.             $scope.errorMsg = result.errorMsg;  
  33.         });  
  34.     }; 

Controller处理请求:

  1. [HttpPost]  
  2. [AjaxValidateAntiForgeryToken]  
  3. [AsyncTimeout(5000)]  
  4. public async Task<ActionResult> Register(RegisterModel model, CancellationToken token)  
  5. {  
  6.     var command = new RegisterNewAccountCommand(model.AccountName, model.Password);  
  7.     var result = await _commandService.Execute(command, CommandReturnType.EventHandled);  
  8.  
  9.     if (result.Status == CommandStatus.Failed)  
  10.     {  
  11.         if (result.ExceptionTypeName == typeof(DuplicateAccountException).Name)  
  12.         {  
  13.             return Json(new { success = false, errorMsg = "该账号已被注册,请用其他账号注册。" });  
  14.         }  
  15.         return Json(new { success = false, errorMsg = result.ErrorMessage });  
  16.     }  
  17.  
  18.     _authenticationService.SignIn(result.AggregateRootId, model.AccountName, false);  
  19.     return Json(new { success = true });  

CommandHandler处理Command:

  1. [Component(LifeStyle.Singleton)]  
  2. public class AccountCommandHandler : ICommandHandler<RegisterNewAccountCommand>  
  3. {  
  4.     private readonly ILockService _lockService;  
  5.     private readonly RegisterAccountService _registerAccountService;  
  6.  
  7.     public AccountCommandHandler(ILockService lockService, RegisterAccountService registerAccountService)  
  8.     {  
  9.         _lockService = lockService;  
  10.         _registerAccountService = registerAccountService;  
  11.     }  
  12.  
  13.     public void Handle(ICommandContext context, RegisterNewAccountCommand command)  
  14.     {  
  15.         _lockService.ExecuteInLock(typeof(Account).Name, () =>  
  16.         {  
  17.             context.Add(_registerAccountService.RegisterNewAccount(command.Id, command.Name, command.Password));  
  18.         });  
  19.     }  

RegisterAccountService领域服务:

  1. /// <summary>提供账号注册的领域服务,封装账号注册的业务规则,比如账号唯一性检查  
  2.     /// </summary>  
  3.     [Component(LifeStyle.Singleton)]  
  4.     public class RegisterAccountService  
  5.     {  
  6.         private readonly IIdentityGenerator _identityGenerator;  
  7.         private readonly IAccountIndexStore _accountIndexStore;  
  8.         private readonly AggregateRootFactory _factory;  
  9.  
  10.         public RegisterAccountService(IIdentityGenerator identityGenerator, AggregateRootFactory factory, IAccountIndexStore accountIndexStore)  
  11.         {  
  12.             _identityGenerator = identityGenerator;  
  13.             _factory = factory;  
  14.             _accountIndexStore = accountIndexStore;  
  15.         }  
  16.  
  17.         /// <summary>注册新账号  
  18.         /// </summary>  
  19.         /// <param name="accountIndexId"></param>  
  20.         /// <param name="accountName"></param>  
  21.         /// <param name="accountPassword"></param>  
  22.         /// <returns></returns>  
  23.         public Account RegisterNewAccount(string accountIndexId, string accountName, string accountPassword)  
  24.         {  
  25.             //首先创建一个新账号  
  26.             var account = _factory.CreateAccount(accountName, accountPassword);  
  27.  
  28.             //先判断该账号是否存在  
  29.             var accountIndex = _accountIndexStore.FindByAccountName(account.Name);  
  30.             if (accountIndex == null)  
  31.             {  
  32.                 //如果不存在,则添加到账号索引  
  33.                 _accountIndexStore.Add(new AccountIndex(accountIndexId, account.Id, account.Name));  
  34.             }  
  35.             else if (accountIndex.IndexId != accountIndexId)  
  36.             {  
  37.                 //如果存在但和当前的索引ID不同,则认为是账号有重复  
  38.                 throw new DuplicateAccountException(accountName);  
  39.             }  
  40.  
  41.             return account;  
  42.         }  
  43.     } 

EventHandler处理Domain Event:

  1. [Component(LifeStyle.Singleton)]  
  2. public class AccountEventHandler : BaseEventHandler, IEventHandler<NewAccountRegisteredEvent>  
  3. {  
  4.     public void Handle(IEventContext context, NewAccountRegisteredEvent evnt)  
  5.     {  
  6.         using (var connection = GetConnection())  
  7.         {  
  8.             connection.Insert(  
  9.                 new 
  10.                 {  
  11.                     Id = evnt.AggregateRootId,  
  12.                     Name = evnt.Name,  
  13.                     Password = evnt.Password,  
  14.                     CreatedOn = evnt.Timestamp,  
  15.                     UpdatedOn = evnt.Timestamp,  
  16.                     Version = evnt.Version  
  17.                 }, Constants.AccountTable);  
  18.         }  
  19.     }  

结束语

好了,大概就这些吧。好久没写文章了,都不知道该怎么写了,呵呵。接下来准备再好好分享下ENode,EQueue最近几个月在不断完善中我遇到的一些技术问题。对了,大家可以去体验下这个论坛的功能哦,虽然很简单,但基本的功能还是有的。http://enode.cloudapp.net/

责任编辑:林师授 来源: netfocus的博客
相关推荐

2013-07-08 10:40:02

2009-05-06 19:04:32

LinuxMoonlight 2预览版

2020-11-13 07:08:51

Spring Boot应用Spring

2016-08-24 15:12:41

LXDLinux容器

2023-09-21 22:43:17

Django框架

2021-04-07 13:38:27

Django项目视图

2013-01-14 09:44:58

JavaScriptJSJS框架

2012-02-08 11:15:38

HibernateJava

2011-03-21 14:24:13

Debian 6

2010-07-30 14:58:06

Flex应用

2011-03-03 21:04:08

bug程序员

2013-10-30 22:10:28

Clouda程序

2010-08-04 13:16:23

Flex项目

2009-10-23 09:21:08

2022-10-17 10:28:05

Web 组件代码

2009-09-22 10:00:08

曙光BBSBBS站

2011-12-29 15:18:54

开放平台

2012-05-25 15:20:38

XNA

2023-05-19 08:49:58

SQLAlchemy数据库

2018-08-22 17:32:45

点赞
收藏

51CTO技术栈公众号