是否需在DatabaseContext的OnModelCreating中加try-catch修复事务回滚问题？

背景说明 #

安全扫描提出整改任务，需解决以下错误：

The database transaction is not always rolled back on errors entity framework in DatabaseContext.cs

给出的修复步骤：

• 用try {}块打开数据库连接
• 用try {}块开启数据库事务
• 关闭数据库前无未完成的事务
• 确保事务在catch {}块或finally {}块中回滚

以下是对应的DatabaseContext.cs代码：

public class DatabaseContext : DbContext, IUnitOfWork
{
    public DatabaseContext(DbContextOptions<DatabaseContext> options)
        : base(options)
    {
    }

    ...
    
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        foreach (var property in modelBuilder.Model.GetEntityTypes()
            .SelectMany(t => t.GetProperties())
            .Where(
                    p => p.ClrType == typeof(string) // Entity is a string
                && p.GetColumnType() == null // No column type is set
            ))
        {
            property.SetIsUnicode(false);
        }

        modelBuilder.ApplyConfigurationsFromAssembly(typeof(DatabaseContext).Assembly);

        ...
        modelBuilder.Entity<Person>().HasData(new Person
        {
            ..
        });
    }

    public override Task<int> SaveChangesAsync(CancellationToken cancellationToken = new CancellationToken())
    {
        foreach (var entry in this.ChangeTracker.Entries<AuditableEntity>())
        {
            switch (entry.State)
            {
                case EntityState.Added:
                    entry.Entity.CreatedDate = DateTime.UtcNow;
                    entry.Entity.CreatedBy = "system"; // this.loggedInUserService.UserId;
                    break;

                case EntityState.Modified:
                    entry.Entity.LastModifiedDate = DateTime.UtcNow;
                    entry.Entity.LastModifiedBy = "system"; // this.loggedInUserService.UserId;
                    break;
            }
        }

        return base.SaveChangesAsync(cancellationToken);
    }

    public async Task<IDbContextTransaction> BeginTransactionAsync()
    {
        if (this.currentTransaction != null)
        {
            return null;
        }

        this.currentTransaction = await this.Database.BeginTransactionAsync(IsolationLevel.ReadCommitted).ConfigureAwait(false);

        return this.currentTransaction;
    }

    public async Task CommitTransactionAsync(IDbContextTransaction transaction)
    {
        if (transaction == null)
        {
            throw new ArgumentNullException(nameof(transaction));
        }

        try
        {
            await this.SaveChangesAsync().ConfigureAwait(false);
            transaction.Commit();
        }
        catch
        {
            this.RollbackTransaction();
            throw;
        }
        finally
        {
            if (this.currentTransaction != null)
            {
                this.currentTransaction.Dispose();
                this.currentTransaction = null;
            }
        }
    }

    public void RollbackTransaction()
    {
        try
        {
            this.currentTransaction?.Rollback();
        }
        finally
        {
            if (this.currentTransaction != null)
            {
                this.currentTransaction.Dispose();
                this.currentTransaction = null;
            }
        }
    }
}

问题解答 #

不需要在OnModelCreating方法中添加try-catch块来修复该事务回滚问题，原因如下：

1. OnModelCreating的作用场景：该方法是EF Core用于在内存中构建数据库模型元数据的逻辑，仅在上下文首次初始化时执行一次，全程不涉及实际的数据库连接或事务操作——它只是配置实体与数据库的映射规则，不会产生需要回滚的数据库事务。
2. 现有事务逻辑已覆盖修复要求：安全扫描指出的问题核心是「事务出错时未始终回滚」，你的代码中CommitTransactionAsync和RollbackTransaction方法已经处理了异常回滚逻辑：
   • 在CommitTransactionAsync中，若SaveChangesAsync或事务提交抛出异常，会立即调用RollbackTransaction执行回滚，且在finally块中释放事务资源，避免未完成事务残留；
   • RollbackTransaction方法也确保了回滚操作后释放事务资源，符合「关闭数据库前无未完成事务」的要求。

额外优化建议 #

如果要进一步完善事务逻辑，可以关注以下点：

• 检查BeginTransactionAsync中，当已有currentTransaction时返回null的逻辑是否符合业务预期——考虑改为抛出异常，避免调用者误以为事务已成功开启；
• 确保所有业务代码中使用事务的场景，都严格遵循「开启事务→执行操作→提交/异常回滚」的流程，避免遗漏事务处理。

内容的提问来源于stack exchange，提问作者One Developer