EF Core通用仓储实现Upsert方法的方案探讨

要将AddRange和UpdateRange合并为通用的Upsert批量方法，核心思路是利用EF Core的实体元数据获取主键信息，判断每个实体是否已存在于数据库中，再分别执行新增或更新操作，无需额外定义接口约定实体属性。

基础实现版本 #

public virtual void UpsertRange(ICollection<T> entries)
{
    var dbSet = _context.Set<T>();
    var entityType = _context.Model.FindEntityType(typeof(T));
    var primaryKeys = entityType.FindPrimaryKey().Properties;

    foreach (var entry in entries)
    {
        // 获取当前实体的主键值数组
        var keyValues = primaryKeys.Select(pk => pk.GetGetter().GetClrValue(entry)).ToArray();
        // 先检查上下文缓存，再查询数据库
        var existingEntity = dbSet.Find(keyValues);

        if (existingEntity == null)
        {
            dbSet.Add(entry);
        }
        else
        {
            // 将传入实体的属性值同步到已跟踪的实体上
            _context.Entry(existingEntity).CurrentValues.SetValues(entry);
        }
    }
}

关键逻辑说明 #

• 通用主键处理：通过_context.Model.FindEntityType(typeof(T))获取实体元数据，自动提取主键（支持单主键和复合键），无需硬编码Id属性或定义接口。
• 实体存在性判断：Find方法优先检查上下文的跟踪缓存，再查询数据库，比直接调用FirstOrDefault更高效。
• 更新逻辑：使用CurrentValues.SetValues将传入实体的属性值覆盖到已跟踪的实体，EF Core会自动记录变更，后续调用SaveChanges时生成Update语句。

大数量场景优化版本 #

如果批量处理的实体数量较多，循环调用Find会产生多次数据库查询，可通过批量查询优化性能：

public virtual void UpsertRange(ICollection<T> entries)
{
    var dbSet = _context.Set<T>();
    var entityType = _context.Model.FindEntityType(typeof(T));
    var primaryKeys = entityType.FindPrimaryKey().Properties;

    // 提取所有传入实体的主键值集合
    var entryKeyValues = entries.Select(entry => 
        primaryKeys.Select(pk => pk.GetGetter().GetClrValue(entry)).ToArray()
    ).ToList();

    // 批量查询数据库中已存在的实体（EF Core 5+支持复合键的Contains查询）
    var existingEntities = dbSet.Where(entity => 
        entryKeyValues.Any(key => 
            primaryKeys.Zip(key, (pk, val) => pk.GetGetter().GetClrValue(entity).Equals(val)).All(b => b)
        )
    ).ToList();

    // 构建主键-实体字典，快速匹配
    var existingKeyDict = existingEntities.ToDictionary(
        entity => primaryKeys.Select(pk => pk.GetGetter().GetClrValue(entity)).ToArray(),
        entity => entity,
        new KeyValueEqualityComparer()
    );

    foreach (var entry in entries)
    {
        var keyValues = primaryKeys.Select(pk => pk.GetGetter().GetClrValue(entry)).ToArray();
        if (existingKeyDict.TryGetValue(keyValues, out var existingEntity))
        {
            _context.Entry(existingEntity).CurrentValues.SetValues(entry);
        }
        else
        {
            dbSet.Add(entry);
        }
    }
}

// 自定义数组比较器，用于主键值数组的字典匹配
public class KeyValueEqualityComparer : IEqualityComparer<object[]>
{
    public bool Equals(object[] x, object[] y)
    {
        if (x.Length != y.Length)
            return false;
        return x.Zip(y, (a, b) => a.Equals(b)).All(b => b);
    }

    public int GetHashCode(object[] obj)
    {
        return obj.Aggregate(0, (hash, val) => hash ^ val.GetHashCode());
    }
}

优化点说明 #

• 仅执行一次数据库查询获取所有已存在的实体，减少IO开销。
• 通过自定义比较器构建主键字典，实现O(1)时间复杂度的实体匹配。
• 兼容复合键场景，无需额外修改代码。

内容的提问来源于stack exchange，提问作者Nick Farsi