CAP项目中事务与异步消息发布的注意事项

问题背景

在使用CAP（一个流行的.NET分布式事务解决方案）时，开发者可能会遇到一个典型问题：当使用BeginTransactionAsync方法开启事务并发布消息时，消息可能会在事务提交之前就被发送出去，这显然不符合预期行为。

问题复现

通过以下代码可以复现该问题：

public class TransactionsWithEventPublishTest
{
    [Fact]
    public async Task ShouldPublishEventWhenTransactionSucceed()
    {
        using var scope = factory.Services.CreateScope();
        var dbContext = scope.ServiceProvider.GetRequiredService<ApplicationDbContext>();
        var publisher = scope.ServiceProvider.GetRequiredService<ICapPublisher>();
        
        // 问题代码 - 消息可能在事务提交前发送
        await using var transaction = await MyBeginTransactionAsync(dbContext,publisher);
        
        // 正常工作的代码
        // await using var transaction = await dbContext.Database.BeginTransactionAsync(publisher, autoCommit: false);
        
        await dbContext.MockDatas.AddAsync(new MockData { Name = "test" });
        await publisher.PublishAsync("test", "test");
        await dbContext.SaveChangesAsync();
        await transaction.CommitAsync();
    }
    
    // 问题方法
    protected async Task<IDbContextTransaction> MyBeginTransactionAsync(DbContext context,ICapPublisher publisher)
    {
        return await context.Database.BeginTransactionAsync(publisher, autoCommit: false);
    }
}

根本原因

这个问题源于.NET中AsyncLocal的限制。AsyncLocal用于在异步控制流中保持上下文，但它无法跨越异步方法边界正确传播上下文信息。当我们将BeginTransactionAsync包装在另一个异步方法中时，事务上下文就会丢失，导致CAP无法正确地将消息发布与事务绑定。

解决方案

1. 直接调用API：最简单的方法是直接调用BeginTransactionAsync，而不是通过中间异步方法包装。

2. 避免异步包装：如果必须使用包装方法，应该避免使用async/await：

protected Task<IDbContextTransaction> MyBeginTransactionAsync(DbContext context, ICapPublisher publisher)
{
    return context.Database.BeginTransactionAsync(publisher, autoCommit: false);
}

设计考量

虽然有人提出可以设计新的API如BeginTransactionAndRunAsync来支持全链路异步操作，但CAP团队认为这不是一个好的设计选择。同样，提供scope级别的publisher目前也不在计划中。

最佳实践

1. 尽量直接使用CAP提供的事务API，避免不必要的包装
2. 如果必须包装，确保不破坏AsyncLocal的上下文传播
3. 在测试环境中验证消息确实是在事务提交后才发送
4. 考虑使用同步方法替代异步方法，如果上下文传播是关键需求

总结

在分布式事务处理中，保证消息发布与数据库事务的原子性至关重要。CAP通过AsyncLocal机制实现了这一点，但开发者需要注意避免在异步方法中破坏这一机制。理解这一限制有助于编写出更可靠的分布式事务代码。