如何使 FreeSql 和 CAP 进行集成

[yang-xiaodong]

本文用于描述如何使用 FreeSql 和 CAP 进行事务集成。

背景描述

在CAP中，事务对象需要交给CAP进行提交从而在事务实现提交后对缓存消息到 Broker 的 Flush 动作，而目前的Orm大部分都有自己的事务管理对象进行事务的提交。CAP官方直接原生支持使用 ADO.NET 和 EntityFrameworkCore 进行事务集成，而对于第三方ORM本文提供了一种扩展用以集成的示例。

示例

以下为在 FreeSql 中和 CAP 进行集成的示例：

1. FreeSql Repository+UnitOfWork 事务模式

public class FreeSqlRepositoryPatternTransaction : CapTransactionBase
{
    public FreeSqlRepositoryPatternTransaction(IDispatcher dispatcher, IUnitOfWork uow) : base(dispatcher)
    {
        Uow = uow;
    }

    public IUnitOfWork Uow { get; }

    public override object? DbTransaction => Uow.GetOrBeginTransaction();

    public override void Commit()
    {
        Uow.Commit();
        Flush();
    }

    public override Task CommitAsync(CancellationToken cancellationToken = default)
    {
        throw new NotImplementedException();
    }

    public override void Rollback()
    {
        Uow.Rollback();
    }

    public override Task RollbackAsync(CancellationToken cancellationToken = default)
    {
        throw new NotImplementedException();
    }

    public override void Dispose()
    {
        Uow.Dispose();
    }
}

public static class Extensions
{
      // 注意：你可以酌情修改此扩展以支持你的使用习惯，参考下方讨论内容
      public static ICapTransaction BeginTransaction(this IFreeSql freeSql,
          ICapPublisher publisher, out IRepositoryUnitOfWork uow, bool autoCommit = false)
      {
          var dispatcher = publisher.ServiceProvider.GetRequiredService<IDispatcher>();
          uow = freeSql.CreateUnitOfWork();
          var transaction = new FreeSqlRepositoryPatternTransaction(dispatcher, uow)
          {
              AutoCommit = autoCommit
          };
          return publisher.Transaction.Value = transaction;
      }
}

使用方式：

[Route("~/with/test")]
public IActionResult WithTransaction()
{
      using (var transaction = _freeSql.BeginTransaction(_capBus, out var uow, false))
      {
          _capBus.Publish("sample.rabbitmq.mysql", DateTime.Now);

          var person = _freeSql.GetRepository<Person2>();
          person.UnitOfWork = uow;
          person.Insert(new Person2() { Name = "HelloWorld2" });

          transaction.Commit();
      }

    return Ok();
}

2. FreeSql DbContext 事务模式

此扩展方式不支持使用 dbContext.UnitOfWork.Orm Api 来获得 IFreeSql 对象，请直接通过 dbContext 来获取。

public class CapUnitOfWork : IUnitOfWork
{
    private readonly CapTransactionBase _transactionBase;

    public CapUnitOfWork(CapTransactionBase transactionBase)
    {
        _transactionBase = transactionBase;
    }

    public void Dispose()
    {
        _transactionBase.Dispose();
    }

    public DbTransaction GetOrBeginTransaction(bool isCreate = true)
    {
        return _transactionBase.DbTransaction as DbTransaction;
    }

    public void Commit()
    {
        _transactionBase.Commit();

        if (EntityChangeReport.OnChange != null && EntityChangeReport.Report.Any())
        {
            EntityChangeReport.OnChange.Invoke(EntityChangeReport.Report); 
        }
    }

    public void Rollback()
    {
        _transactionBase.Rollback();
    }

    public IFreeSql Orm => throw new NotSupportedException("不支持使用此方式获取 IFreeSql 对象");
    public IsolationLevel? IsolationLevel { get; set; }
    public DbContext.EntityChangeReport EntityChangeReport { get; } = new();
    public Dictionary<string, object> States { get; } = new();
}


public static class Extensions
{
    public static DbContext WithCap(this DbContext dbContext, ICapPublisher publisher)
    {
        var dispatcher = publisher.ServiceProvider.GetRequiredService<IDispatcher>();
        var mysqlTransaction = new MySqlCapTransaction(dispatcher)
        {
            AutoCommit = false,
            DbTransaction = dbContext.UnitOfWork.GetOrBeginTransaction(true)
        };
        dbContext.UnitOfWork = new CapUnitOfWork(mysqlTransaction);
        publisher.Transaction.Value = mysqlTransaction;
        return dbContext;
    }
}

使用示例

[Route("~/with/test")]
public IActionResult WithTransaction()
{
    using var dbContext = _freeSql.CreateDbContext().WithCap(_capBus);

    _capBus.Publish("sample.rabbitmq.mysql", DateTime.Now);

    dbContext.Add(new Person2() { Name = "AAAA" });

    dbContext.SaveChanges();

    return Ok();
}

[luoyunchong]

每次CreateDbContext后，TraceAfter 事件 是否会重复绑定

[2881099]

@yang-xiaodong

问题1：

IFreeSql Orm 让使用者直接访问 IFreeSql API，与 UnitOfWork 保持一个事务。IUnitOfWork、IBaseRepository、DbContext 都有定义该属性，作用相同。DbContextScopedFreeSql : IFreeSql 这个重写类实现了这个功能，不过目前不是 public 申明。。

DbContextScopedFreeSql _ormScoped;
public IFreeSql Orm => _ormScoped ?? (_ormScoped = DbContextScopedFreeSql.Create(_fsql, null, () => this));

直接访问【单例 IFreeSql 】无法与事务保持一致。

using (var ctx = fsql.CreateDbContext()) {
  var song = ctx.Set<Song>();
  var user = ctx.Set<User>();

  song.Add(new Song());
  user.Update(...);
  ctx.Orm.Ado.ExecuteNonQuery(sql); //事务一致
  fsql.Ado.ExecuteNonQuery(sql); //错了：事务不一致

  ctx.SaveChanges();
}

问题2：

EntityChangeReport 提供实体变化的功能，需要在 Commit 时处理

public void Commit()
{
    _transactionBase.Commit();
    if (EntityChangeReport != null && EntityChangeReport.OnChange != null && EntityChangeReport.Report.Any() == true)
        EntityChangeReport.OnChange.Invoke(EntityChangeReport.Report);
}

//初始化
public DbContext.EntityChangeReport EntityChangeReport { get; } = new DbContext.EntityChangeReport();
public Dictionary<string, object> States { get; } = new Dictionary<string, object>();

[yang-xiaodong]

OK, 那么如果在当前场景下， CapUnitOfWork 这新的实例new出来的然后赋值给 DbContext.UnitOfWork，那么该对象中的 Orm 是否会被外部再次调用呢？

如果没有被外部调用，而是使用者选择是否使用 dbContext.UnitOfWork.Orm 来获取 IFreeSql 对象的话，那么我认为在此处可以抛出 throw new NotSupportExceition 异常，以代表 CapUnitOfWork 不支持此方式获取

[2881099]

DbContext 模式可以直接用 DbContext.Orm 是对的，但是用 DbContext.UnitOfWork.Orm 就错了。
Repository 模式也可以直接用 Repository.Orm 是对的，用 Repository.UnitOfWork.Orm 也错了。
如果使用者注入 IUnitOfWork 为 CapUnitOfWork 类。

使用的机率不大，但是一旦使用发生了事务问题，描述困难，坑比较深。

[2881099]

可以可以，throw new NotSupportExceition

[yang-xiaodong]

好的，感谢澄清，示例已更新