EF Core SaveChangesInterceptor如何获取新增记录的主键值？

问题本质 #

• 对于数据库生成的主键（比如自增ID），EF Core在SavingChangesAsync阶段还未与数据库交互，因此无法获取到新生成的主键值。
• 当SavedChangesAsync触发时，EF Core已完成数据提交，会自动将新增实体的状态从Added改为Unchanged，这是变更追踪的默认行为。

解决方案 #

通过在SavingChangesAsync中暂存新增实体，到SavedChangesAsync阶段再处理这些实体，此时就能获取到数据库生成的主键。

完整代码实现 #

public class CustomSaveChangesInterceptor : ISaveChangesInterceptor
{
    // 暂存新增实体的集合
    private readonly List<object> _addedEntities = new();

    public async ValueTask<InterceptionResult<int>> SavingChangesAsync(DbContextEventData eventData, InterceptionResult<int> result, CancellationToken cancellationToken = default)
    {
        if (eventData.Context == null)
            return await ValueTask.FromResult(result);

        // 收集所有新增状态的实体
        _addedEntities.AddRange(
            eventData.Context.ChangeTracker.Entries()
                .Where(entry => entry.State == EntityState.Added)
                .Select(entry => entry.Entity)
        );

        return await ValueTask.FromResult(result);
    }

    public async ValueTask<int> SavedChangesAsync(SaveChangesCompletedEventData eventData, int result, CancellationToken cancellationToken = default)
    {
        // 处理暂存的新增实体，此时已获取到数据库生成的ID
        foreach (var entity in _addedEntities)
        {
            // 示例：假设实体继承自带Id属性的BaseEntity，可根据实际情况调整
            if (entity is BaseEntity baseEntity)
            {
                Console.WriteLine($"新增实体ID：{baseEntity.Id}");
                // 在这里执行你的业务逻辑，比如日志记录、关联数据更新等
            }
            // 也可以针对特定实体类型处理
            // else if (entity is User user)
            // {
            //     Console.WriteLine($"新增用户ID：{user.Id}");
            // }
        }

        // 清空集合，避免内存泄漏
        _addedEntities.Clear();

        return await ValueTask.FromResult(result);
    }
}

// 示例基类，根据你的实体结构调整
public abstract class BaseEntity
{
    public int Id { get; set; }
}

补充说明 #

1. 非统一基类处理：如果你的实体没有统一基类，可以通过反射获取主键属性，或者针对具体实体类型单独判断处理。
2. 线程安全：如果DbContext处于多线程场景下，建议使用ConcurrentBag<object>替代List<object>保证线程安全。
3. 客户端生成主键：如果使用客户端生成的主键（如Guid），可直接在SavingChangesAsync阶段获取主键值，无需暂存实体。

内容的提问来源于stack exchange，提问作者Anthony Burton