Marten项目中的静态代码生成与实时聚合问题解析

问题背景

在Marten这个.NET生态中的事件溯源和文档数据库库中，开发人员发现了一个关于静态代码生成与实时聚合(Live Aggregation)功能之间的不一致性问题。这个问题在使用Wolverine框架时表现得尤为明显，导致聚合状态无法正确重建。

问题现象

当开发者使用dotnet run -- codegen write命令进行静态代码生成时，生成的代码与运行时动态编译生成的代码存在差异。具体表现为：

1. 静态生成的代码会先创建一个空的聚合对象，然后尝试应用事件
2. 动态生成的代码则直接返回由工厂方法创建的聚合对象

这种差异导致在使用静态代码生成时，聚合状态无法正确初始化，特别是当第一个事件是创建事件时。

技术细节分析

聚合定义示例

public record TodoCreated(Guid TodoId, string Description);
public record TodoUpdated(Guid TodoId, string Description);

public class Todo
{
    public Guid Id { get; set; }
    public string Description { get; set; } = null!;

    public static Todo Create(TodoCreated @event) => new()
    {
        Id = @event.TodoId,
        Description = @event.Description,
    };

    public void Apply(TodoUpdated @event)
    {
        Description = @event.Description;
    }
}

配置方式

var marten = builder.Services.AddMarten(opts =>
{
    opts.Connection(builder.Configuration.GetConnectionString("Marten")!);
    opts.Projections.LiveStreamAggregation<Todo>();
});

问题代码对比

静态生成的代码：

public Repro.Api.Domain.Todo Create(Marten.Events.IEvent @event, Marten.IQuerySession session)
{
    var todo = new Repro.Api.Domain.Todo();  // 先创建空对象
    switch (@event)
    {
        case Marten.Events.IEvent<Repro.Api.Domain.Events.TodoCreated> event_TodoCreated1:
            todo = Repro.Api.Domain.Todo.Create(event_TodoCreated1.Data);
            break;
    }
    return null;  // 错误地返回null
}

动态生成的代码：

public Repro.Api.Domain.Todo Create(Marten.Events.IEvent @event, Marten.IQuerySession session)
{
    switch (@event)
    {
        case Marten.Events.IEvent<Repro.Api.Domain.Events.TodoCreated> event_TodoCreated1:
            return Repro.Api.Domain.Todo.Create(event_TodoCreated1.Data);  // 直接返回正确对象
    }
    return null;
}

问题根源

1. 代码生成逻辑不一致：静态代码生成器在处理聚合创建时采用了不同的策略，先创建空对象再赋值，而不是直接使用工厂方法
2. 返回值处理错误：静态生成的代码在switch语句后错误地返回了null，而不是返回处理后的聚合对象
3. 初始化顺序问题：空对象的创建可能导致聚合状态不完整，特别是当聚合有必须初始化的字段时

解决方案与变通方法

官方修复

这个问题已在Marten 7.x版本中得到修复。开发者可以升级到最新版本解决此问题。

临时解决方案

1. 使用私有构造函数：将聚合的构造函数设为私有或内部，可以强制代码生成器使用工厂方法
2. 自定义投影：使用CustomProjection替代简单的聚合投影，虽然代码量增加但可控性更强

public class TodoProjection : CustomProjection<Todo, Guid>
{
    public TodoProjection()
    {
        Slicer = new ByStreamId<Todo>();
        IncludeType<TodoCreated>();
        IncludeType<TodoUpdated>();
    }

    public override ValueTask ApplyChangesAsync(DocumentSessionBase session, EventSlice<Todo, Guid> slice, 
        CancellationToken cancellation, ProjectionLifecycle lifecycle = ProjectionLifecycle.Inline)
    {
        foreach (var e in slice.Events())
        {
            switch (e.Data)
            {
                case TodoCreated created:
                    slice.Aggregate ??= new Todo { Id = e.StreamId, Description = created.Description };
                    break;
                case TodoUpdated updated:
                    slice.Aggregate ??= new Todo { Id = e.Id };
                    slice.Aggregate.Description = updated.Description;
                    break;
            }
        }
        return new ValueTask();
    }
}

最佳实践建议

1. 明确聚合创建方式：为聚合定义清晰的创建工厂方法
2. 构造函数控制：考虑将聚合构造函数设为私有，强制使用工厂方法
3. 版本兼容性检查：升级到最新Marten版本以获得修复
4. 测试验证：对静态代码生成和动态编译两种模式都进行测试验证

总结

这个问题揭示了代码生成技术在复杂场景下的潜在陷阱。Marten团队通过修复这个问题，提高了静态代码生成与动态编译之间的一致性，为开发者提供了更可靠的基础设施支持。对于使用事件溯源和CQRS模式的.NET开发者来说，理解这类问题的本质有助于更好地设计和调试自己的领域模型。