PAYATHON 2026

EF Core 取消按钮时机导致服务端输出不一致

数据小陈

结论

两种输出对应不同的取消阶段:

  • 立即取消:EF Core 在开始数据库操作、等待异步任务或检查 token 时观察到 CancellationToken,一般会抛出 OperationCanceledException(常见为 TaskCanceledException)。原来的 catch (OperationCanceledException) 能捕获。
  • 等待一段时间再取消:SQL 命令已经发到 SQL Server,SqlClient 触发取消/attention,SQL Server 返回 Operation cancelled by user。这个错误通常表现为 SqlException,在 SaveChangesAsync 中又会被 EF Core 包装成 DbUpdateException。所以它不是 OperationCanceledException,原来的 catch 捕获不到。
  • Win32Exception 的 NativeErrorCode == 0 表示底层 Win32 调用返回了 ERROR_SUCCESS。这不等于 OverWrite 业务成功,也不能单独证明取消成功或失败。它只说明底层调用没有给出 Win32 错误码。判断时还要结合 cancellationToken.IsCancellationRequested、异常链,以及事务是否已提交或回滚。

原因

CancellationToken 采用协作式取消,不会强制终止线程。不同 API 观察取消的时机不同:

  1. token 在进入 BeginTransactionAsync、ExecuteSqlInterpolatedAsync、SaveChangesAsync、CommitAsync 前后被检查时,EF Core 可以直接抛出 OperationCanceledException。
  2. 命令已经执行时,取消会进入 ADO.NET/SqlClient 层。SqlClient 向 SQL Server 发送取消请求,SQL Server 返回取消错误,于是出现 SqlException: Operation cancelled by user。
  3. SaveChangesAsync 会把提供程序异常包装成 DbUpdateException,所以异常链可能是 DbUpdateException -> SqlException -> Win32Exception。
  4. 取消发生在 CommitAsync 阶段时最难判断:提交请求可能已经到达数据库。此时仅凭异常无法确认事务是否已提交,界面不能简单显示“取消成功”,应显示“结果未知,请刷新确认”。

关于 Win32Exception 错误号 0:Windows 的 0 是 ERROR_SUCCESS。它出现在取消路径中,通常说明底层清理/取消调用本身没有返回 Win32 错误,不代表数据库事务成功。若 token 已请求取消,并且异常链中有取消异常或 SQL 取消错误,应按“已取消”处理;若 token 未请求取消,则应记录为失败并排查。

推荐处理方式

不要只返回 bool。建议定义结果枚举,区分成功、未提交前取消、执行中取消、提交阶段取消但结果未知以及失败。

using System.ComponentModel;
using Microsoft.Data.SqlClient;

public enum OverwriteResult
{
    Success,
    CanceledBeforeCommit,
    CanceledDuringExecution,
    CanceledDuringCommitUnknown,
    Failed
}

public async Task<OverwriteResult> OverWrite(ISomeData data, CancellationToken cancellationToken)
{
    var strategy = _context.Database.CreateExecutionStrategy();

    try
    {
        return await strategy.ExecuteAsync(async () =>
        {
            await using var transaction =
                await _context.Database.BeginTransactionAsync(cancellationToken);

            var commitStarted = false;

            try
            {
                await _context.Database.ExecuteSqlInterpolatedAsync(
                    $"EXECUTE [dbo].[uspDeleteAllDataFromDatabase]",
                    cancellationToken);

                await _context.SaveChangesAsync(cancellationToken);

                commitStarted = true;
                await transaction.CommitAsync(cancellationToken);

                return OverwriteResult.Success;
            }
            catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested)
            {
                if (commitStarted)
                    return OverwriteResult.CanceledDuringCommitUnknown;

                await TryRollbackAsync(transaction);
                return OverwriteResult.CanceledBeforeCommit;
            }
            catch (DbUpdateException ex) when (IsCancellation(ex, cancellationToken))
            {
                await TryRollbackAsync(transaction);
                return OverwriteResult.CanceledDuringExecution;
            }
            catch (Exception ex) when (IsCancellation(ex, cancellationToken))
            {
                if (commitStarted)
                    return OverwriteResult.CanceledDuringCommitUnknown;

                await TryRollbackAsync(transaction);
                return OverwriteResult.CanceledDuringExecution;
            }
        });
    }
    catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested)
    {
        return OverwriteResult.CanceledBeforeCommit;
    }
    catch (Exception ex) when (IsCancellation(ex, cancellationToken))
    {
        return OverwriteResult.CanceledDuringExecution;
    }
    catch (Exception)
    {
        return OverwriteResult.Failed;
    }
}

private static async Task TryRollbackAsync(IDbContextTransaction transaction)
{
    try
    {
        await transaction.RollbackAsync(CancellationToken.None);
    }
    catch
    {
        // 连接已断开或事务已经结束时,rollback 可能失败,记录日志即可。
    }
}

private static bool IsCancellation(Exception ex, CancellationToken cancellationToken)
{
    if (!cancellationToken.IsCancellationRequested)
        return false;

    for (Exception? current = ex; current != null; current = current.InnerException)
    {
        if (current is OperationCanceledException)
            return true;

        if (current is SqlException sql &&
            (sql.Number == 0 ||
             sql.Message.Contains("cancelled", StringComparison.OrdinalIgnoreCase) ||
             sql.Message.Contains("canceled", StringComparison.OrdinalIgnoreCase)))
            return true;

        // Win32Exception 的 NativeErrorCode == 0 只能作为辅助信息,
        // 不能单独作为取消成功的证据。
    }

    return false;
}

还要留意:SqlException.Number 和错误消息可能随 SqlClient 版本、SQL Server 语言环境变化。生产环境不要只依赖消息文本;应结合 cancellationToken.IsCancellationRequested、结构化日志、事务状态和业务幂等校验。如果无法确认取消发生在提交前,返回“结果未知”比误报“取消成功”更安全。

给用户的提示

  • Success:覆盖成功。
  • CanceledBeforeCommit:已取消,未提交。
  • CanceledDuringExecution:数据库操作被取消,已尝试回滚;如连接中断需检查数据库状态。
  • CanceledDuringCommitUnknown:取消发生在提交阶段,无法确认是否提交,请刷新/重试或查询数据库确认。
  • Failed:不是取消导致的失败,请查看日志。

Win32Exception 的 0 是 Win32 错误码层面的“成功”,不是 OverWrite 成功。判断取消是否成功,不看这个 0,而要看取消请求、异常类型和事务最终状态。

备注:内容仅供参考。