EventFlow 入门指南：构建事件溯源应用的基础

苏承根

于 2025-06-24 09:27:33 发布

阅读量580

点赞数 25

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00708/article/details/148863843

EventFlow 入门指南：构建事件溯源应用的基础

EventFlow Async/await first CQRS+ES and DDD framework for .NET 项目地址: https://gitcode.com/gh_mirrors/ev/EventFlow

前言

EventFlow 是一个基于.NET平台的事件溯源（Event Sourcing）框架，它提供了一套完整的工具集来帮助开发者构建基于领域驱动设计（DDD）的应用程序。本文将深入讲解如何使用EventFlow构建一个完整的事件溯源应用。

核心概念

在开始使用EventFlow之前，我们需要了解几个核心概念：

事件溯源（Event Sourcing）：一种持久化模式，只存储状态变化的事件而非当前状态
聚合（Aggregate）：领域模型的核心，负责维护业务规则和一致性边界
命令（Command）：表示用户或系统想要执行的操作
事件（Event）：表示已经发生的事实

初始化配置

使用EventFlow的第一步是初始化配置。最基本的初始化代码如下：

var services = new ServiceCollection();
services.AddEventFlow(ef => ef.AddDefaults(typeof(Startup).Assembly));
using var serviceProvider = services.BuildServiceProvider();

这段代码配置了EventFlow的几个重要默认值：

内存事件存储（适合开发和测试）
空快照存储（如果使用会发出警告）
EventFlow内部组件的默认实现

领域模型构建

一个完整的EventFlow领域模型通常包含以下组件：

1. 聚合标识（Aggregate Identity）

聚合标识是聚合的唯一标识符。在EventFlow中，我们可以这样定义一个简单的聚合ID：

public class ExampleId : Identity<ExampleId>
{
    public ExampleId(string value) : base(value) { }
}

2. 聚合根（Aggregate Root）

聚合根是领域模型的核心，负责维护业务规则。以下是一个简单的聚合实现：

public class ExampleAggregate : AggregateRoot<ExampleAggregate, ExampleId>,
    IEmit<ExampleEvent>
{
    private int? _magicNumber;

    public ExampleAggregate(ExampleId id) : base(id) { }

    public IExecutionResult SetMagicNumber(int magicNumber)
    {
        if (_magicNumber.HasValue)
            return ExecutionResult.Failed("Magic number already set");

        Emit(new ExampleEvent(magicNumber));
        return ExecutionResult.Success();
    }

    public void Apply(ExampleEvent aggregateEvent)
    {
        _magicNumber = aggregateEvent.MagicNumber;
    }
}

关键点：

状态变更发生在Apply方法中
Emit方法用于发布新事件
业务规则在SetMagicNumber方法中实现

3. 领域事件（Domain Event）

领域事件表示系统中已经发生的事实：

[EventVersion("example", 1)]
public class ExampleEvent : AggregateEvent<ExampleAggregate, ExampleId>
{
    public ExampleEvent(int magicNumber)
    {
        MagicNumber = magicNumber;
    }

    public int MagicNumber { get; }
}

重要提示：

使用EventVersion属性标记事件版本
事件一旦发布，其结构就不应再改变
如需修改事件结构，应使用事件升级器

4. 命令（Command）和命令处理器（Command Handler）

命令表示用户或系统想要执行的操作：

public class ExampleCommand : Command<ExampleAggregate, ExampleId>
{
    public ExampleCommand(ExampleId aggregateId, int magicNumber)
        : base(aggregateId)
    {
        MagicNumber = magicNumber;
    }

    public int MagicNumber { get; }
}

对应的命令处理器：

public class ExampleCommandHandler : 
    CommandHandler<ExampleAggregate, ExampleId, ExampleCommand>
{
    public override Task<IExecutionResult> ExecuteCommandAsync(
        ExampleAggregate aggregate,
        ExampleCommand command,
        CancellationToken cancellationToken)
    {
        return Task.FromResult(aggregate.SetMagicNumber(command.MagicNumber));
    }
}

查询模型（Read Model）

为了高效查询聚合数据，我们需要创建查询模型：

public class ExampleReadModel : IReadModel,
    IAmReadModelFor<ExampleAggregate, ExampleId, ExampleEvent>
{
    public int MagicNumber { get; private set; }

    public Task ApplyAsync(
        IReadModelContext context,
        IDomainEvent<ExampleAggregate, ExampleId, ExampleEvent> domainEvent,
        CancellationToken cancellationToken)
    {
        MagicNumber = domainEvent.AggregateEvent.MagicNumber;
        return Task.CompletedTask;
    }
}

查询模型的特点：

专为查询优化而设计
可以从多个聚合投影数据
支持多种存储后端（内存、数据库等）

完整示例

下面是一个完整的测试用例，展示了如何使用上述组件：

public class ExampleTests
{
    [Test]
    public async Task ExampleTest()
    {
        // 初始化服务容器
        var services = new ServiceCollection();
        services.AddEventFlow(ef => ef
            .AddDefaults(typeof(ExampleAggregate).Assembly)
            .UseInMemoryReadStoreFor<ExampleReadModel>());
        using var serviceProvider = services.BuildServiceProvider();

        // 获取必要服务
        var commandBus = serviceProvider.GetRequiredService<ICommandBus>();
        var queryProcessor = serviceProvider.GetRequiredService<IQueryProcessor>();
        var exampleId = ExampleId.New;

        // 执行命令并查询结果
        await commandBus.PublishAsync(new ExampleCommand(exampleId, 42), CancellationToken.None);
        var exampleReadModel = await queryProcessor.ProcessAsync(
            new ReadModelByIdQuery<ExampleReadModel>(exampleId), 
            CancellationToken.None);

        // 验证结果
        exampleReadModel.MagicNumber.Should().Be(42);
    }
}