CQRS之旅——旅程6(我们系统的版本管理)

旅程6：我们系统的版本管理

准备下一站:升级和迁移

“变化是生活的调味品。”威廉·考珀

此阶段的最高目标是了解如何升级包含实现CQRS模式和事件源的限界上下文的系统。团队在这一阶段实现的用户场景包括对代码的更改和对数据的更改：更改了一些现有的数据模式并添加了新的数据模式。除了升级系统和迁移数据外，团队还计划在没有停机时间的情况下进行升级和迁移，以便在Microsoft Azure中运行实时系统。

本章的工作术语定义：

本章使用了一些术语，我们将在下面进行描述。有关更多细节和可能的替代定义，请参阅参考指南中的“

深入CQRS和ES

”。

命令(Command)：命令是要求系统执行更改系统状态的操作。命令是必须服从(执行)的一种指令，例如：MakeSeatReservation。在这个限界上下文中，命令要么来自用户发起请求时的UI，要么来自流程管理器(当流程管理器指示聚合执行某个操作时)。单个接收方处理一个命令。命令总线(command bus)传输命令，然后命令处理程序将这些命令发送到聚合。发送命令是一个没有返回值的异步操作。
事件(Event)：一个事件，比如OrderConfirmed，描述了系统中发生的一些事情，通常是一个命令的结果。领域模型中的聚合引发事件。事件也可以来自其他限界上下文。多个订阅者可以处理特定的事件。聚合将事件发布到事件总线。处理程序在事件总线上注册特定类型的事件，然后将事件传递给订阅服务器。在订单和注册限界上下文中，订阅者是流程管理器和读取模型生成器。
幂等性(Idempotency)：幂等性是一个操作的特性，这意味着该操作可以多次应用而不改变结果。例如，“将x的值设置为10”的操作是幂等的，而“将x的值加1”的操作不是幂等的。在消息传递环境中，如果消息可以多次传递而不改变结果，则消息是幂等的：这可能是因为消息本身的性质，也可能是因为系统处理消息的方式。

用户故事：

在这个过程的这个阶段，团队实现了下面描述的用户故事。

不停机升级

V2版本的目标是升级系统，包括任何必要的数据迁移，而不需要把系统停机。如果这在当前实现中不可行，那么停机时间应该最小化，并且应该修改系统，以便在将来支持零停机时间升级(从V3版本开始)。

Beth(业务经理)发言：

确保我们能够在不停机的情况下进行升级，这对我们在市场中的信誉至关重要。

显示剩余座位数量

目前，当注册者创建一个订单时，没有显示每种座位类型的剩余座位数量。当注册者选择购买座位时，UI应该显示此信息。

处理不需要付费的座位

目前，当注册者选择不需要付费的座位时，UI流仍然会将注册者带到支付页面，即使不需要支付任何费用。系统应该检测什么时候没有支付，并调整流程，让注册者直接进入订单的确认页面。

架构

该应用程序旨在部署到Microsoft Azure。在旅程的这个阶段，应用程序由两个角色组成，一个包含ASP.Net MVC Web应用程序的web角色和一个包含消息处理程序和领域对象的工作角色。应用程序在写端和读端都使用Azure SQL DataBase实例进行数据存储。应用程序使用Azure服务总线来提供其消息传递基础设施。下图展示了这个高级体系结构。

在研究和测试解决方案时，可以在本地运行它，可以使用Azure compute emulator，也可以直接运行MVC web应用程序，并运行承载消息处理程序和领域域对象的控制台应用程序。在本地运行应用程序时，可以使用本地SQL Server Express数据库，并使用一个在SQL Server Express数据库实现的简单的消息传递基础设施。

有关运行应用程序的选项的更多信息，请参见附录1“

发布说明

”。

模式和概念

在旅程的这个阶段，团队处理的大多数关键挑战都与如何最好地执行从V1到V2的迁移有关。本节将介绍其中的一些挑战。

处理“事件定义发生更改”的情况

当团队检查V2的发布需求，很明显，我们需要改变在订单和注册限界上下文中使用的一些事件来适应一些新特性：RegistrationProcessManager将会改变，当订单有一个不需要付费的座位时系统将提供一个更好的用户体验。

订单和注册限界上下文使用事件源，因此在迁移到V2之后，事件存储将包含旧事件，但将开始保存新事件。当系统事件被重放时，系统必须能正确处理所有的旧事件和新事件。

团队考虑了两种方法来处理系统中的这类更改。

在基础设施中进行事件映射或过滤

在基础设施中映射和过滤事件消息是一种选择。此方法是对旧的事件消息和消息格式进行处理，在它们到达领域之前在基础设施的某个位置处理它们。您可以过滤掉不再相关的旧消息，并使用映射将旧格式的消息转换为新格式。这种方法最初比较复杂，因为它需要对基础设施进行更改，但是它可以保持领域域的纯粹，领域只需要理解当前的新事件集合就可以了。

在聚合中处理多个版本的消息

在聚合中处理多个版本的消息是另一种选择。在这种方法中，所有消息类型(包括旧消息和新消息)都传递到领域，每个聚合必须能够处理旧消息和新消息。从短期来看，这可能是一个合适的策略，但它最终会导致域模型受到遗留事件处理程序的污染。

团队为V2版本选择了这个选项，因为它包含了最少数量的代码更改。

Jana(软件架构师)发言：

当前在聚合中处理旧事件和新事件并不妨碍您以后使用第一种选择：在基础设施中使用映射/过滤机制。

履行消息幂等性

V2版本中要解决的一个关键问题是使系统更加健壮。在V1版本中，在某些场景中，可能会多次处理某些消息，导致系统中的数据不正确或不一致。

Jana(软件架构师)发言：

消息幂等性在任何使用消息传递的系统中都很重要，这不仅仅是在实现CQRS模式或使用事件源的系统中。

在某些场景中，设计幂等消息是可能的，例如：使用“将座位配额设置为500”的消息，而不是“在座位配额中增加100”的消息。您可以安全地多次处理第一个消息，但不能处理第二个消息。

然而，并不总是能够使用幂等消息，因此团队决定使用Azure服务总线的重复删除特性，以确保它只传递一次消息。团队对基础设施进行了一些更改，以确保Azure服务总线能够检测重复消息，并配置Azure服务总线来执行重复消息检测。

要了解Contoso是如何实现这一点的，请参阅下面的“不让命令消息重复”一节。此外，我们需要考虑系统中的消息处理程序如何从队列和Topic检索消息。当前的方法使用Azure服务总线peek/lock机制。这是一个分成三个阶段的过程：

处理程序从队列或Topic检索消息，并在其中留下消息的锁定副本。其他客户端无法看到或访问锁定的消息。
处理程序处理消息。
处理程序从队列中删除锁定的消息。如果锁定的消息在固定时间后没有解锁或删除，则解锁该消息并使其可用，以便再次检索。

如果步骤由于某种原因失败，这意味着系统可以不止一次地处理消息。

Jana(软件架构师)发言：

该团队计划在旅程的下一阶段解决这个问题(步骤失败的问题)。更多信息，请参见第7章“

添加弹性和优化性能

”。

阻止多次处理事件

在V1中，在某些场景里，如果在处理事件时发生错误，系统可能多次处理事件。为了避免这种情况，团队修改了体系结构，以便每个事件处理程序都有自己对Azure Topic的订阅。下图显示了两个不同的模型。

在V1中，可能发生以下行为:

EventProcessor

实例从服务总线中的

所有

订阅者那里接收到

OrderPlaced

事件。
EventProcessor

实例有两个已注册的处理程序，

RegistrationProcessManagerRouter

和

OrderViewModelGenerator

处理程序类，所以会在两个里都触发调用

Handle

方法。
在

OrderViewModelGenerator

类中的

Handle

方法执行成功。
在

RegistrationProcessManagerRouter

类中的

Handle

方法抛出异常。
EventProcessor

实例捕获到异常然后抛弃掉事件消息。消息将自动放回订阅中。
EventProcessor

实例第二次从

所有

订阅者那里接收到

OrderPlaced

事件。
事件又触发两个处理方法，导致

RegistrationProcessManagerRouter

类和

OrderViewModelGenerator

第二次处理事件消息。
每当

RegistrationProcessManagerRouter

类抛出异常时，

OrderViewModelGenerator

类都会触发处理该事件。

在V2模型中，如果处理程序类抛出异常，

EventProcessor

实例将事件消息放回与该处理程序类关联的订阅。重试逻辑现在只会导致

EventProcessor

实例重试引发异常的处理程序，因此没有其他处理程序会重新处理消息。

集成事件的持久化

在V1版本中提出的一个问题是，系统如何持久化从会议管理限界上下文发送到订单和注册限界上下文的集成事件。这些事件包括关于会议创建和发布的信息，以及座位类型和配额更改的详细信息。

在V1版本中，订单和注册上下文中的

ConferenceViewModelGenerator

类通过更新视图模型并向

SeatsAvailability

聚合发送命令来处理这些事件，以告诉它更改座位配额值。

这种方法意味着订单和注册限界上下文不存储任何历史记录，这可能会导致问题。例如，其他视图从这里中查找座椅类型描述时，这里只包含座椅类型描述的最新值。因此，在其他地方重播一组事件可能会重新生成另一个包含不正确座椅类型描述的读取模型投影。

团队考虑了以下五个方法来纠正这种情况:

将所有事件保存在原始限界上下文中(会议管理限界上下文中)，并使用共享的事件存储，订单和注册限界上下文中可以访问该存储来重播这些事件。接收限界上下文可以重放事件流，直到它需要查看的之前的座椅类型描述时为止。
当所有事件到达接收限界上下文(订单和注册限界上下文)时保存它们。
让视图模型生成器中的命令处理程序保存事件，只选择它需要的那些。
让视图模型生成器中的命令处理程序保存不同的事件，实际上就是为此视图模型使用事件源。
将来自所有限界上下文的所有命令和事件消息存储在消息日志中。

第一种选择并不总是可行的。在这种特殊情况下，它可以工作，因为同一个团队同时实现了限界上下文和基础设施，使得使用共享事件存储变得很容易。

Gary(CQRS专家)发言：

尽管从纯粹主义者的角度来看，第一个选项破坏了限界上下文之间的严格隔离，但在某些场景中，它可能是一个可接受的实用解决方案。

第三种选择可能存在的风险是，所需的事件集合可能在未来发生变化。如果我们现在不保存事件，它们将永远丢失。

尽管第五个选项存储了所有命令和事件，其中一些可能永远都不需要再次引用，但它确实提供了一个完整的日志，记录了系统中发生的所有事情。这对于故障诊断很有用，还可以帮助您满足尚未确定的需求。该团队选择了这个选项而不是选项二，因为它提供了一个更通用的机制，可能具有未来的好处。

持久化事件的目的是，当订单和注册上下文需要有关当前座位配额的信息时，可以回放这些事件，以便计算剩余座位的数量。要一致地计算这些数字，必须始终以相同的顺序回放事件。这种顺序有几种选择：

会议管理限界上下文发送事件的顺序。
订单和注册上下文接收事件的顺序。
订单和注册上下文处理事件的顺序。

大多数情况下，这些顺序是相同的。没有什么正确的顺序。你只需要选择一个和它保持一致就行了。因此，选择由简单性决定。在本例中，最简单的方法是按照订单和注册限界上下文中处理程序接收事件的顺序持久化事件(第二个选项)。

Markus(软件开发人员)发言：

这种选择通常不会出现在事件源中。每个聚合会都以固定的顺序创建事件，这就是系统用于持久存储事件的顺序。在此场景中，集成事件不是由单个聚合创建的。

为这些事件保存时间戳也有类似的问题。如果将来需要查看特定时间剩余的座位数量，那么时间戳可能会很有用。这里的选择是，当事件在会议管理限界上下文中创建时，还是在订单和注册限界上下文中接收时，应该创建时间戳？当会议管理限界上下文创建事件时，订单和注册限界上下文可能由于某种原因离线。因此，团队决定在会议管理有界上下文发布事件时创建时间戳。

消息排序

团队创建并运行来验证V1版本的验收测试，凸显出了消息排序的一个潜在问题：执行会议管理限界上下文的验收测试向订单和注册限界上下文发送了一系列命令，这些命令有时会出现顺序错误。

Markus(软件开发人员)发言：

当人类用户真实测试系统的这一部分时，不太会注意到这种效果，因为发出命令的时间间隔要长得多，这使得消息不太可能无序地到达。

团队考虑了两种方法来确保消息以正确的顺序到达。

第一个方法是使用消息会话，这是Azure服务总线的一个特性。如果您使用消息会话，这将确保会话内的消息以与它们发送时相同的顺序传递。
第二种方法是修改应用程序中的处理程序，通过使用发送消息时添加到消息中的序列号或时间戳来检测无序消息。如果接收处理程序检测到一条无序消息，它将拒绝该消息，并在处理了在被拒绝消息之前发送的消息之后，将其放回稍后处理的队列或Topic。

在这种情况下，首选的解决方案是使用Azure服务总线消息会话，因为这只需要对现有代码进行更少的更改。这两种方法都会给消息传递带来一些额外的延迟，但是团队并不认为这会对系统的性能产生显著的影响。

实现细节

本节描述订单和注册限界上下文的实现的一些重要功能。您可能会发现拥有一份代码拷贝很有用，这样您就可以继续学习了。您可以从

Download center

下载一个副本，或者在GitHub上查看存储库：

https://github.com/mspnp/cqrs-journey-code

。您可以从GitHub上的

Tags

页面下载V2版本的代码。

备注：不要期望代码示例与参考实现中的代码完全匹配。本章描述了CQRS过程中的一个步骤，随着我们了解更多并重构代码，实现可能会发生变化。

**添加对“不需要支付的订单”的支持

做出这一改变有三个具体的目标，它们都是相关的。我们希望:

修改

RegistrationProcessManager

类和相关聚合，以处理不需要支付的订单。
修改UI中的导航，当订单不需要支付时跳过付款步骤。
确保系统在升级到V2之后能够正确地工作，包括使用新事件和旧事件。

RegistrationProcessManager类的更改

在此之前，

RegistrationProcessManager

类在收到来自UI的注册者已完成支付的通知后发送了一个

ConfirmOrderPayment

命令。现在，如果有一个不需要支付订单，UI将直接向订单聚合发送一个

ConfirmOrder

命令。如果订单需要支付，

RegistrationProcessManager

类在从UI接收到成功支付的通知后，再向订单聚合发送一个

ConfirmOrder

命令。

Jana(软件架构师)发言：

注意，命令的名称已从

ConfirmOrderPayment

更改为

ConfirmOrder

。这反映了订单不需要知道任何关于付款的信息。它只需要知道订单已经确认。类似地，现在有一个新的

OrderConfirmed

事件用于替代旧的

OrderPaymentConfirmed

事件。

当订单聚合接收到

ConfirmOrder

命令时，它将引发一个

OrderConfirmed

事件。除被持久化外，该事件还由以下对象处理:

OrderViewModelGenerator

类，它在其中更新读取模型中的订单状态。
SeatAssignments

聚合，在其中初始化一个新的

SeatAssignments

实例。
RegistrationProcessManager

类，它在其中触发一个提交座位预订的命令。

UI的更改

UI中的主要更改是在

RegistrationController

MVC控制器类中的

SpecifyRegistrantAndPaymentDetails

action里的。之前，此action方法返回

InitiateRegistrationWithThirdPartyProcessorPayment

(action result)。现在，如果

Order

对象的新

IsFreeOfCharge

属性为true，它将返回一个

CompleteRegistrationWithoutPayment

(action result)。否则，它返回一个

CompleteRegistrationWithThirdPartyProcessorPayment

(action result)。

[HttpPost]
public ActionResult SpecifyRegistrantAndPaymentDetails(AssignRegistrantDetails command, string paymentType, int orderVersion)
{
    ...

    var pricedOrder = this.orderDao.FindPricedOrder(orderId);
    if (pricedOrder.IsFreeOfCharge)
    {
        return CompleteRegistrationWithoutPayment(command, orderId);
    }

    switch (paymentType)
    {
        case ThirdPartyProcessorPayment:

            return CompleteRegistrationWithThirdPartyProcessorPayment(command, pricedOrder, orderVersion);

        case InvoicePayment:
            break;

        default:
            break;
    }

    ...
}

CompleteRegistrationWithThirdPartyProcessorPayment

将用户重定向到

ThirdPartyProcessorPayment

action，

CompleteRegistrationWithoutPayment

方法将用户直接重定向到

ThankYou

action。

数据迁移

会议管理限界上下文在其Azure SQL数据库实例中的PricedOrders表中存储来自订单和注册限界上下文的订单信息。以前，会议管理限界上下文接收OrderPaymentConfirmed事件，现在它接收OrderConfirmed事件，该事件包含一个附加的IsFreeOfCharge属性。这将成为数据库中的一个新列。

Markus(软件开发人员)发言：

在迁移过程中，我们不需要修改该表中的现有数据，因为布尔值的默认值为false。所有现有条目都是在系统支持不需要付费的订单之前创建的。

在迁移过程中，任何正在运行的

ConfirmOrderPayment

命令都可能丢失，因为它们不再由订单聚合处理。您应该验证当前的命令总线没有这些命令。

Poe(IT运维人员)发言：

我们需要仔细计划如何部署V2版本，以便确保所有现有的、正在运行的ConfirmOrderPayment命令都由运行V1版本的工作角色实例处理。

系统将

RegistrationProcessManager

类实例的状态保存到SQL数据库表中。这个表的架构没有变化。迁移后您将看到的惟一更改是

StateValue

列中的一个新添加值。这反映了

RegistrationProcessManager

类中的

ProcessState

枚举中额外的

PaymentConfirmationReceived

值，如下面的代码示例所示：

public enum ProcessState
{
    NotStarted = 0,
    AwaitingReservationConfirmation = 1,
    ReservationConfirmationReceived = 2,
    PaymentConfirmationReceived = 3,
}

在V1版本中，事件源系统为订单聚合保存的事件包括

OrderPaymentConfirmed

事件。因此，事件存储区包含此事件类型的实例。在V2版本中，

OrderPaymentConfirmed

事件被替换为

OrderConfirmed

事件。

团队决定在V2版本中，当反序列化事件时，不在基础设施级别映射和过滤事件。这意味着，当系统从事件存储中重播这些事件时，处理程序必须同时理解旧事件和新事件。下面的代码示例在

SeatAssignmentsHandler

类中显示了这一点：

static SeatAssignmentsHandler()
{
    Mapper.CreateMap<OrderPaymentConfirmed, OrderConfirmed>();
}

public SeatAssignmentsHandler(IEventSourcedRepository<Order> ordersRepo, IEventSourcedRepository<SeatAssignments> assignmentsRepo)
{
    this.ordersRepo = ordersRepo;
    this.assignmentsRepo = assignmentsRepo;
}

public void Handle(OrderPaymentConfirmed @event)
{
    this.Handle(Mapper.Map<OrderConfirmed>(@event));
}

public void Handle(OrderConfirmed @event)
{
    var order = this.ordersRepo.Get(@event.SourceId);
    var assignments = order.CreateSeatAssignments();
    assignmentsRepo.Save(assignments);
}

您还可以在

OrderViewModelGenerator类

中看到同样的技术。

Order

类中的方法略有不同，因为这是持久化到事件存储中的事件之一。下面的代码示例显示了

Order

类中受保护构造函数的一部分：

protected Order(Guid id)
    : base(id)
{
    ...
    base.Handles<OrderPaymentConfirmed>(e => this.OnOrderConfirmed(Mapper.Map<OrderConfirmed>(e)));
    base.Handles<OrderConfirmed>(this.OnOrderConfirmed);
    ...
}

Jana(软件架构师)发言：

以这种方式处理旧事件对于这个场景非常简单，因为惟一需要更改的是事件的名称。如果事件的属性也发生了变化，情况会更加复杂。将来，Contoso将考虑在基础设施中进行映射，以避免遗留事件污染领域模型。

在UI中显示剩余座位

做出这一改变有三个具体的目标，它们都是相关的。我们想要：

修改系统，在会议系统的读模型中包含每个座位类型的剩余座位数量信息。
修改UI以显示每种座位类型的剩余座位数量。
确保升级到V2后系统功能正常。

向读模型添加关于剩余座位数量的信息

系统要能显示剩余座位数量的信息来自两个地方：

当业务客户创建新的座位类型或修改座位配额时，会议管理限界上下文将引发

SeatCreated

和

SeatUpdated

事件。
在订单和注册限界上下文中，当注册者创建一个订单的时候，可用座位(SeatsAvailability)聚合将引发SeatsReserved、SeatsReservationCancelled和AvailableSeatsChanged事件。

备注：

ConferenceViewModelGenerator

类不使用

SeatCreated

和

SeatUpdated

事件。

订单和注册限界上下文中的

ConferenceViewModelGenerator

类现在处理这些事件，并使用它们来计算和存储读模型中的座位类型数量。下面的代码示例显示了

ConferenceViewModelGenerator

类中的相关处理程序：

public void Handle(AvailableSeatsChanged @event)
{
    this.UpdateAvailableQuantity(@event, @event.Seats);
}

public void Handle(SeatsReserved @event)
{
    this.UpdateAvailableQuantity(@event, @event.AvailableSeatsChanged);
}

public void Handle(SeatsReservationCancelled @event)
{
    this.UpdateAvailableQuantity(@event, @event.AvailableSeatsChanged);
}

private void UpdateAvailableQuantity(IVersionedEvent @event, IEnumerable<SeatQuantity> seats)
{
    using (var repository = this.contextFactory.Invoke())
    {
        var dto = repository.Set<Conference>().Include(x => x.Seats).FirstOrDefault(x => x.Id == @event.SourceId);
        if (dto != null)
        {
            if (@event.Version > dto.SeatsAvailabilityVersion)
            {
                foreach (var seat in seats)
                {
                    var seatDto = dto.Seats.FirstOrDefault(x => x.Id == seat.SeatType);
                    if (seatDto != null)
                    {
                        seatDto.AvailableQuantity += seat.Quantity;
                    }
                    else
                    {
                        Trace.TraceError("Failed to locate Seat Type read model being updated with id {0}.", seat.SeatType);
                    }
                }

                dto.SeatsAvailabilityVersion = @event.Version;

                repository.Save(dto);
            }
            else
            {
                Trace.TraceWarning ...
            }
        }
        else
        {
            Trace.TraceError ...
        }
    }
}

UpdateAvailableQuantity

方法将事件上的版本与读模型的当前版本进行比较，以检测可能的重复消息。

Markus(软件开发人员)发言：

此检查仅检测重复的消息，而不是超出序列的消息。

修改UI以显示剩余的座位数量

现在，当UI向会议的读模型查询座位类型列表时，列表包括当前可用的座位数量。下面的代码示例显示了

RegistrationController

MVC控制器如何使用

SeatType

类的

AvailableQuantity

：

private OrderViewModel CreateViewModel()
{
    var seatTypes = this.ConferenceDao.GetPublishedSeatTypes(this.ConferenceAlias.Id);
    var viewModel =
        new OrderViewModel
        {
            ConferenceId = this.ConferenceAlias.Id,
            ConferenceCode = this.ConferenceAlias.Code,
            ConferenceName = this.ConferenceAlias.Name,
            Items =
                seatTypes.Select(
                    s =>
                        new OrderItemViewModel
                        {
                            SeatType = s,
                            OrderItem = new DraftOrderItem(s.Id, 0),
                            AvailableQuantityForOrder = s.AvailableQuantity,
                            MaxSelectionQuantity = Math.Min(s.AvailableQuantity, 20)
                        }).ToList(),
        };

    return viewModel;
}

数据迁移

保存会议读模型数据的数据库有一个新列来保存用于检查重复事件的版本号，而保存座位类型读模型数据有一个新列来保存可用的座椅数量。

作为数据迁移的一部分，有必要为每个可用座位(SeatsAvailability)聚合重放事件存储中的所有事件，以便正确计算可用数量。

不让命令消息重复

系统目前使用Azure服务总线传输消息。当系统从

ConferenceProcessor类

的启动代码初始化Azure服务总线时，它配置Topic来检测重复的消息，如下面的

ServiceBusConfig

类的代码示例所示：

private void CreateTopicIfNotExists() 
{     
    var topicDescription =         
        new TopicDescription(this.topic)         
        {             
            RequiresDuplicateDetection = true,
            DuplicateDetectionHistoryTimeWindow = topic.DuplicateDetectionHistoryTimeWindow,         
        };     
    try     
    {         
        this.namespaceManager.CreateTopic(topicDescription);     
    }     
    catch (MessagingEntityAlreadyExistsException) { } 
}

备注：您可以在Settings.xml文件中配置DuplicateDetectionHistoryTimeWindow
可以向Topic元素添加这个属性。默认值是1小时。

但是，为了使重复检测工作正常，您必须确保每个消息都有一个惟一的ID。下面的代码示例显示了

MarkSeatsAsReserved

命令:

public class MarkSeatsAsReserved : ICommand
{
    public MarkSeatsAsReserved()
    {
        this.Id = Guid.NewGuid();
        this.Seats = new List<SeatQuantity>();
    }

    public Guid Id { get; set; }

    public Guid OrderId { get; set; }

    public List<SeatQuantity> Seats { get; set; }

    public DateTime Expiration { get; set; }
}

CommandBus

类中的

BuildMessage

方法使用命令Id创建一个惟一的消息Id, Azure服务总线可以使用这个消息Id来检测重复：

private BrokeredMessage BuildMessage(Envelope command) 
{ 
    var stream = new MemoryStream(); 
    ...

    var message = new BrokeredMessage(stream, true);
    if (!default(Guid).Equals(command.Body.Id))
    {
        message.MessageId = command.Body.Id.ToString();
    }

...

    return message;
}

保证消息顺序

团队决定使用Azure服务总线消息会话来保证系统中的消息顺序。

系统从

ConferenceProcessor

类中的

OnStart

方法配置Azure服务总线Topic和订阅。Settings.xml配置文件中的配置指定了具体的订阅使用会话。

ServiceBusConfig

类中的以下代码示例显示了系统如何创建和配置订阅。

private void CreateSubscriptionIfNotExists(NamespaceManager namespaceManager, TopicSettings topic, SubscriptionSettings subscription)
{
    var subscriptionDescription =
        new SubscriptionDescription(topic.Path, subscription.Name)
        {
            RequiresSession = subscription.RequiresSession
        };

    try
    {
        namespaceManager.CreateSubscription(subscriptionDescription);
    }
    catch (MessagingEntityAlreadyExistsException) { }
}

以下来自

SessionSubscriptionReceiver

类的代码示例演示了如何使用会话接收消息：

private void ReceiveMessages(CancellationToken cancellationToken)
{
    while (!cancellationToken.IsCancellationRequested)
    {
        MessageSession session;
        try
        {
            session = this.receiveRetryPolicy.ExecuteAction<MessageSession>(this.DoAcceptMessageSession);
        }
        catch (Exception e)
        {
            ...
        }

        if (session == null)
        {
            Thread.Sleep(100);
            continue;
        }


        while (!cancellationToken.IsCancellationRequested)
        {
            BrokeredMessage message = null;
            try
            {
                try
                {
                    message = this.receiveRetryPolicy.ExecuteAction(() => session.Receive(TimeSpan.Zero));
                }
                catch (Exception e)
                {
                    ...
                }

                if (message == null)
                {
                    // If we have no more messages for this session, exit and try another.
                    break;
                }

                this.MessageReceived(this, new BrokeredMessageEventArgs(message));
            }
            finally
            {
                if (message != null)
                {
                    message.Dispose();
                }
            }
        }

        this.receiveRetryPolicy.ExecuteAction(() => session.Close());
    }
}

private MessageSession DoAcceptMessageSession()
{
    try
    {
        return this.client.AcceptMessageSession(TimeSpan.FromSeconds(45));
    }
    catch (TimeoutException)
    {
        return null;
    }
}

Markus(软件开发人员)发言：

您可能会发现，将使用消息会话的

ReceiveMessages

方法的这个版本与

SubscriptionReceiver

类中的原始版本进行比较是很有用的。

您必须确保当你发送消息包含一个会话ID，这样才能使用消息会话接收一条消息。系统使用事件的SourceID作为会话ID，如下面的代码示例所示的

EventBus

类中的

BuildMessage

方法：

var message = new BrokeredMessage(stream, true);
message.SessionId = @event.SourceId.ToString();

通过这种方式，您可以确保以正确的顺序接收来自单个源的所有消息。

Poe(IT运维人员)发言：

在V2版本中，团队更改了系统创建Azure服务总线Topic和订阅的方式。之前，

SubscriptionReceiver

类创建了它们(如果它们还不存在)。现在，系统在应用程序启动时使用配置数据创建它们。这发生在启动过程的早期，以避免在系统初始化订阅之前将消息发送到Topic时丢失消息的风险。

然而，只有当消息按正确的顺序传递到总线上时，会话才能保证按顺序传递消息。如果系统异步发送消息，则必须特别注意确保消息以正确的顺序放在总线上。在我们的系统中，来自每个单独聚合实例的事件按顺序到达是很重要的，但是我们不关心来自不同聚合实例的事件的顺序。因此，尽管系统异步发送事件，

EventStoreBusPublisher

实例仍然会在发送下一个事件之前等待前一个事件已发送的确认。以下来自

TopicSender

类的示例说明了这一点：

public void Send(Func<BrokeredMessage> messageFactory)
{
    var resetEvent = new ManualResetEvent(false);
    Exception exception = null;
    this.retryPolicy.ExecuteAction(
        ac =>
        {
            this.DoBeginSendMessage(messageFactory(), ac);
        },
        ar =>
        {
            this.DoEndSendMessage(ar);
        },
        () => resetEvent.Set(),
        ex =>
        {
            Trace.TraceError("An unrecoverable error occurred while trying to send a message:\r\n{0}", ex);
            exception = ex;
            resetEvent.Set();
        });

    resetEvent.WaitOne();
    if (exception != null)
    {
        throw exception;
    }
}

Jana(软件架构师)发言：

此代码示例展示了系统如何使用

Transient Fault Handling Application Block

来让异步调用可靠。

有关消息排序和Azure服务总线的更多信息，请参见

Microsoft Azure Queues and Microsoft Azure Service Bus Queues – Compared and Contrasted

有关异步发送消息和排序的信息，请参阅博客文章

Microsoft Azure Service Bus Splitter and Aggregator

从会议管理限界上下文中持久化事件

团队决定创建一个包含所有发送的命令和事件的消息日志。这将使订单和注册限界上下文能够从会议管理限界上下文查询此日志，以获取其构建读模型所需的事件。这不是事件源，因为我们没有使用这些事件来重建聚合的状态，尽管我们使用类似的技术来捕获和持久化这些集成事件。

Gary(CQRS专家)发言：

此消息日志确保不会丢失任何消息，以便将来能够满足其他需求。

向消息添加额外元数据

系统现在将所有消息保存到消息日志中。为了方便查询特定命令或事件，系统现在向每个消息添加了更多的元数据。以前，惟一的元数据是事件类型，现在，事件元数据包括事件类型、命名空间、程序集和路径。系统将元数据添加到EventBus类中的事件和CommandBus类中的命令中。

捕获消息并将消息持久化到消息日志中

系统使用Azure服务总线中对会议/命令和会议/事件topic的额外订阅来接收系统中每条消息的副本。然后，它将消息附加到Azure表存储中。下面的代码示例显示了

AzureMessageLogWriter

类的实例，它用于将消息保存到表中：

public class MessageLogEntity : TableServiceEntity 
{ 
    public string Kind { get; set; }     
    public string CorrelationId { get; set; }     
    public string MessageId { get; set; }     
    public string SourceId { get; set; }     
    public string AssemblyName { get; set; }     
    public string Namespace { get; set; }     
    public string FullName { get; set; }     
    public string TypeName { get; set; }     
    public string SourceType { get; set; }     
    public string CreationDate { get; set; }     
    public string Payload { get; set; } 
}

Kind属性指定消息是命令还是事件。MessageId和CorrelationId属性由消息传递基础设施设置的，其余属性是从消息元数据中设置的。

下面的代码示例显示了这些消息的分区和RowKey的定义：

PartitionKey = message.EnqueuedTimeUtc.ToString("yyyMM"),
RowKey = message.EnqueuedTimeUtc.Ticks.ToString("D20") + "_" + message.MessageId

注意，RowKey保存了消息最初发送的顺序，并添加到消息ID上，以确保惟一性，以防两条消息同时入队。

Jana(软件架构师)发言：

这与事件存储不同，在事件存储区中，分区键标识聚合实例，而RowKey标识聚合的版本号。

数据迁移

当Contoso将系统从V1迁移到V2时，它将使用消息日志在订单和注册限界上下文中重建会议和价格订单的读模型。

Gary(CQRS专家)发言：

Contoso可以在需要重建与聚合无关的事件构建的读模型时来使用消息日志，例如来自会议管理限界上下文的集成事件。

会议读模型包含会议的信息，并包含来自会议管理限界上下文的ConferenceCreated、ConferenceUpdated、ConferencePublished、ConferenceUnpublished、SeatCreated和SeatUpdated事件的信息。

价格订单读模型持有来自于SeatCreated和SeatUpdated事件的信息，这些事件来自于会议管理限界上下文。

然而，在V1中，这些事件消息没有被持久化，因此读模型不能在V2中重新填充。为了解决这个问题，团队实现了一个数据迁移实用程序，它使用一种最佳方法来生成包含要存储在消息日志中的丢失数据的事件。例如，在迁移到V2之后，消息日志不包含ConferenceCreated事件，因此迁移实用程序在会议管理限界上下文使用的数据库中找到这些信息，并创建丢失的事件。您可以在MigrationToV2项目的Migrator类中的GeneratePastEventLogMessagesForConferenceManagement方法中看到这是如何完成的。

Markus(软件开发人员)发言：

您可以在这个类中看到，Contoso还将所有现有的事件源事件复制到消息日志中。

如下面所示，

Migrator

类中的

RegenerateViewModels

方法重新构建读取的模型。它通过调用

Query

方法从消息日志中检索所有事件，然后使用

ConferenceViewModelGenerator

和

PricedOrderViewModelUpdater

类来处理消息。

internal void RegenerateViewModels(AzureEventLogReader logReader, string dbConnectionString)
{
    var commandBus = new NullCommandBus();

    Database.SetInitializer<ConferenceRegistrationDbContext>(null);

    var handlers = new List<IEventHandler>();
    handlers.Add(new ConferenceViewModelGenerator(() => new ConferenceRegistrationDbContext(dbConnectionString), commandBus));
    handlers.Add(new PricedOrderViewModelUpdater(() => new ConferenceRegistrationDbContext(dbConnectionString)));

    using (var context = new ConferenceRegistrationMigrationDbContext(dbConnectionString))
    {
        context.UpdateTables();
    }

    try
    {
        var dispatcher = new MessageDispatcher(handlers);
        var events = logReader.Query(new QueryCriteria { });

        dispatcher.DispatchMessages(events);
    }
    catch
    {
        using (var context = new ConferenceRegistrationMigrationDbContext(dbConnectionString))
        {
            context.RollbackTablesMigration();
        }

        throw;
    }
}

Jana(软件架构师)发言：

查询可能不会很快，因为它将从多个分区检索实体。

注意这个方法如何使用

NullCommandBus

实例来接收来自

ConferenceViewModelGenerator

实例的任何命令，因为我们只是在这里重新构建读模型。

以前，

PricedOrderViewModelGenerator

使用

ConferenceDao

类来获取关于座位的信息。现在，它是自治的，并直接处理

SeatCreated

和

SeatUpdated

事件来维护这些信息。作为迁移的一部分，必须将此信息添加到读模型中。在前面的代码示例中，

PricedOrderViewModelUpdater

类只处理

SeatCreated

和

SeatUpdated

事件，并将缺失的信息添加到价格订单读模型中。

从V1迁移到V2

从V1迁移到V2需要更新已部署的应用程序代码并迁移数据。在生产环境中执行迁移之前，应该始终在测试环境中演练迁移。以下是所需步骤：

将V2版本部署到Azure的staging环境中。V2版本有一个

MaintenanceMode

属性，最初设置为true。在此模式下，应用程序向用户显示一条消息，说明站点当前正在进行维护，而工作角色将不处理消息。
准备好之后，将V2版本(仍然处于维护模式，MaintenanceMode为true)切换到Azure生产环境中。
让V1版本(现在在staging环境中运行)运行几分钟，以确保所有正在运行的消息都完成了它们的处理。
运行迁移程序来迁移数据(参见下面)。
成功完成数据迁移后，将每种工作角色的MaintenanceMode属性更改为false。
V2版本现在运行在Azure中。

Jana(软件架构师)发言：

团队考虑使用单独的应用程序在升级过程中向用户显示一条消息，告诉他们站点正在进行维护。然而，在V2版本中使用MaintenanceMode属性提供了一个更简单的过程，并为应用程序添加了一个潜在有用的新特性。

Poe(IT运维人员)发言：

由于对事件存储的更改，不可能执行从V1到V2的无停机升级。然而，团队所做的更改将确保从V2迁移到V3将不需要停机时间。

Markus(软件开发人员)发言：

团队对迁移实用程序应用了各种优化，例如批处理操作，以最小化停机时间。

下面几节总结了从V1到V2的数据迁移。这些步骤中的一些在前面已经讨论过，涉及到应用程序的特定更改或增强。

团队为V2引入的一个更改是，将所有命令和事件消息的副本保存在消息日志中，以便作为未来的证据，通过捕获将来可能使用的所有内容来保证应用程序的安全性。迁移过程考虑到了这个新特性。

因为迁移过程复制了大量的数据，所以您应该在Azure工作角色中运行迁移过程，以最小化成本。迁移实用程序是一个控制台应用程序，因此您可以使用Azure和远程桌面服务。有关如何在Azure角色实例中运行应用程序的信息，请参见

Using Remote Desktop with Microsoft Azure Roles

。

Poe(IT运维人员)发言：

在一些组织中，安全策略不允许您在Azure生产环境使用远程桌面服务。但是，您只需要一个在迁移期间承载远程桌面会话的工作角色，您可以在迁移完成后删除它。您还可以将迁移代码作为工作角色而不是控制台应用程序运行，并确保它记录迁移的状态，以便您验证。

为会议管理限界上下文生成过去的日志消息

迁移过程的一部分是在可能的情况下重新创建V1版本处理后丢弃的消息，然后将它们添加到消息日志中。在V1版本中，所有从会议管理限界上下文发送到订单和注册限界上下文的集成事件都以这种方式丢失了。系统不能重新创建所有丢失的事件，但可以创建表示迁移时系统状态的事件。

有关更多信息，请参见本章前面的“从会议管理限界上下文中持久化事件”一节。

迁移事件源里的事件

在V2版本中，事件存储为每个事件存储额外的元数据，以便于查询事件。迁移过程将所有事件从现有事件存储复制到具有新模式的新事件存储。

Jana(软件架构师)发言：

原始事件不会以任何方式更新，而是被视为不可变的。

同时，系统将所有这些事件的副本添加到V2版本中引入的消息日志中。

有关更多信息，请参见

MigrationToV2

项目中

Migrator

类中的

MigrateEventSourcedAndGeneratePastEventLogs

。

重建读模型**

V2版本包括对订单和注册限界上下文中读模型定义的几个更改。

MigrationToV2

项目在订单和注册限界上下文中重新构建会议的读模型和价格订单的读模型。

有关更多信息，请参见本章前面的“从会议管理限界上下文中持久化事件”一节。

对测试的影响

在这个过程的这个阶段，测试团队继续扩展验收测试集合。他们还创建了一组测试来验证数据迁移过程。

再说SpecFlow

之前，这组SpecFlow测试以两种方式实现：通过自动化web浏览器模拟用户交互，或者直接在MVC控制器上操作。这两种方法都有各自的优缺点，我们在第4章“

扩展和增强订单和注册限界上下文

”中讨论过。

在与另一位专家讨论了这些测试之后，团队还实现了第三种方法。从领域驱动设计(DDD)方法的角度来看，UI不是领域模型的一部分，核心团队的重点应该是在领域专家的帮助下理解领域，并在领域中实现业务逻辑。UI只是机械部分，用于使用户能够与领域进行交互。因此，验收测试应该包括验证领域模型是否以领域专家期望的方式工作。因此，团队使用SpecFlow创建了一组验收测试，这些测试旨在在不影响系统UI部分的情况下测试领域。

下面的代码示例显示了SelfRegistrationEndToEndWithDomain.feature文件，该文件在Conference.AcceptanceTests项目中的Features\Domain\Registration文件夹里，注意When和Then子句怎么使用命令和事件的。

Gary(CQRS专家)发言：

通常，如果您的领域模型只使用聚合，您会期望When子句发送命令，Then子句查看事件或异常。然而，在本例中，领域模型包含一个通过发送命令来响应事件的流程管理器。测试将检查是否发送了所有预期的命令，并引发了所有预期的事件。

Feature: Self Registrant end to end scenario for making a Registration for a Conference site with Domain Commands and Events
    In order to register for a conference
    As an Attendee
    I want to be able to register for the conference, pay for the Registration Order and associate myself with the paid Order automatically


Scenario: Make a reservation with the selected Order Items
Given the list of the available Order Items for the CQRS summit 2012 conference
    | seat type                 | rate | quota |
    | General admission         | $199 | 100   |
    | CQRS Workshop             | $500 | 100   |
    | Additional cocktail party | $50  | 100   |
And the selected Order Items
    | seat type                 | quantity |
    | General admission         | 1        |
    | Additional cocktail party | 1        |
When the Registrant proceeds to make the Reservation
    # command:RegisterToConference
Then the command to register the selected Order Items is received 
    # event: OrderPlaced
And the event for Order placed is emitted
    # command: MakeSeatReservation
And the command for reserving the selected Seats is received
    # event: SeatsReserved
And the event for reserving the selected Seats is emitted
    # command: MarkSeatsAsReserved
And the command for marking the selected Seats as reserved is received
    # event: OrderReservationCompleted 
And the event for completing the Order reservation is emitted
    # event: OrderTotalsCalculated
And the event for calculating the total of $249 is emitted

下面的代码示例显示了feature文件的一些步骤实现。这些步骤使用命令总线发送命令。

[When(@"the Registrant proceed to make the Reservation")]
public void WhenTheRegistrantProceedToMakeTheReservation()
{
    registerToConference = ScenarioContext.Current.Get<RegisterToConference>();
    var conferenceAlias = ScenarioContext.Current.Get<ConferenceAlias>();

    registerToConference.ConferenceId = conferenceAlias.Id;
    orderId = registerToConference.OrderId;
    this.commandBus.Send(registerToConference);

    // Wait for event processing
    Thread.Sleep(Constants.WaitTimeout);
}

[Then(@"the command to register the selected Order Items is received")]
public void ThenTheCommandToRegisterTheSelectedOrderItemsIsReceived()
{
    var orderRepo = EventSourceHelper.GetRepository<Registration.Order>();
    Registration.Order order = orderRepo.Find(orderId);

    Assert.NotNull(order);
    Assert.Equal(orderId, order.Id);
}

[Then(@"the event for Order placed is emitted")]
public void ThenTheEventForOrderPlacedIsEmitted()
{
    var orderPlaced = MessageLogHelper.GetEvents<OrderPlaced>(orderId).SingleOrDefault();

    Assert.NotNull(orderPlaced);
    Assert.True(orderPlaced.Seats.All(
        os => registerToConference.Seats.Count(cs => cs.SeatType == os.SeatType && cs.Quantity == os.Quantity) == 1));
}

在迁移过程中发现的bug

当测试团队在迁移之后在系统上运行测试时，我们发现订单和注册限界上下文中座位类型的数量与迁移之前的数量不同。调查揭示了以下原因。

如果会议从未发布过，则会议管理限界上下文允许业务客户删除座位类型，但不会引发集成事件向订单和注册限界上下文报告这一情况。所以，当业务客户创建新的座位类型时，订单和注册限界上下文从会议管理限界上下文接收事件，而不是当业务客户删除座位类型时。

迁移过程的一部分创建一组集成事件，以替换V1版本处理后丢弃的事件。它通过读取会议管理限界上下文使用的数据库来创建这些事件。此过程没有为已删除的座位类型创建集成事件。

总之，在V1版本中，已删除的座位类型错误地出现在订单和注册限界上下文的读模型中。在迁移到V2版本之后，这些已删除的座位类型没有出现在订单和注册限界上下文的读模型中。

Poe(IT运维人员)发言：

测试迁移过程不仅验证迁移是否按预期运行，而且可能揭示应用程序本身的bug。

总结

在我们旅程的这个阶段，我们对系统进行了版本控制，并完成了V2伪生产版本。这个新版本包含了一些额外的功能和特性，比如支持不需要付费的订单和在UI中显示更多信息。

我们还对基础设施做了一些改变。例如，我们使更多的消息具有幂等性，现在持久化集成事件。下一章将描述我们旅程的最后阶段，我们将继续增强基础设施，并在准备发布V3版本时加强系统。

旅程6：我们系统的版本管理

本章的工作术语定义：

用户故事：

不停机升级

显示剩余座位数量

处理不需要付费的座位

架构

模式和概念

处理“事件定义发生更改”的情况

在基础设施中进行事件映射或过滤

在聚合中处理多个版本的消息

履行消息幂等性

阻止多次处理事件

集成事件的持久化

消息排序

实现细节

**添加对“不需要支付的订单”的支持

RegistrationProcessManager类的更改

UI的更改

数据迁移

在UI中显示剩余座位

向读模型添加关于剩余座位数量的信息

修改UI以显示剩余的座位数量

数据迁移

不让命令消息重复

保证消息顺序

从会议管理限界上下文中持久化事件

向消息添加额外元数据

捕获消息并将消息持久化到消息日志中

数据迁移

从V1迁移到V2

为会议管理限界上下文生成过去的日志消息

迁移事件源里的事件

重建读模型**

对测试的影响

再说SpecFlow

在迁移过程中发现的bug

总结

你可能也喜欢