EF Core添加实体时ID被修改引发跟踪冲突问题排查与解决

问题现象 #

开发关系型数据库随机数据生成库时，通过反射向DbContext添加实体时触发以下异常：

The instance of entity type 'TestEntity1' cannot be tracked because another instance with the key value '{ID: 1}' is already being tracked. When attaching existing entities, ensure that only one entity instance with a given key value is attached.

具体场景：

• TestEntity1的第一个实例初始ID为0，添加到DbSet后ID被自动改为1；
• 添加第二个手动设置ID为1的TestEntity1实例时触发上述异常。

相关实现代码、实体定义及DbContext定义见用户提供内容。

成因分析 #

1. EF Core主键默认配置行为：TestEntity1的ID为int类型且未标注[DatabaseGenerated]特性，EF Core会默认将其视为Identity（自增）列。当添加初始ID为0的实例时，EF会在SaveChangesAsync执行时自动分配自增主键值1，此时上下文的实体跟踪器中已存在ID=1的实体。
2. 随机生成ID与自增ID冲突：生成的第二个TestEntity1实例手动设置了ID=1，调用Add方法时，EF检测到跟踪器中已有相同主键的实体，因此抛出跟踪冲突异常。

修复方案 #

根据业务需求，可选择以下任意一种方案：

方案1：关闭主键自增，使用自定义生成的ID #

如果希望随机生成的ID直接生效，无需EF自动分配主键，给TestEntity1的ID添加[DatabaseGenerated(DatabaseGeneratedOption.None)]特性：

public class TestEntity1
{
    [DatabaseGenerated(DatabaseGeneratedOption.None)]
    public int ID { get; set; }
    // 其他属性保持不变
}

配置后EF会直接使用生成的ID值，不再自动修改。

方案2：调整随机ID生成逻辑，避开自增范围 #

EF Core的int自增主键默认从1开始递增，生成随机ID时，避免使用0及已被EF分配的数值，例如从1000等较大的起始值开始生成ID，从根源上避免冲突。

方案3：添加实体前检测并处理跟踪冲突 #

如果需要保留EF自增特性，同时处理可能的ID冲突，可在添加实体前检查上下文跟踪状态，处理重复主键的实体：

// 在AddEntities方法的foreach (var entityObject in pool)循环中修改：
foreach (var entityObject in pool)
{
    // 获取实体主键属性及值
    var keyProperty = entity.EntityType.GetProperty("ID")!;
    var keyValue = keyProperty.GetValue(entityObject);
    
    // 检查是否已存在相同主键的跟踪实体
    var trackedEntity = _dbContext.Find(entity.EntityType, keyValue);
    if (trackedEntity != null)
    {
        // 可选操作1：分离旧实体，允许添加新实体
        _dbContext.Entry(trackedEntity).State = EntityState.Detached;
        
        // 可选操作2：用新实体数据更新旧实体（若需要覆盖数据）
        // _dbContext.Entry(trackedEntity).CurrentValues.SetValues(entityObject);
        // continue; // 选择更新时跳过Add操作
    }
    
    dbSet.AddMethod.Invoke(dbSet.DbSet, [entityObject]);
}

额外优化：修复clearDbSet方法的潜在问题 #

当前clearDbSet通过ElementAt(1)获取RemoveRange方法，依赖方法顺序易出错，建议改为按参数类型获取：

private void clearDbSet(DbSetInfo dbSet)
{
    var entityType = dbSet.DbSetProperty.PropertyType.GetGenericArguments()[0];
    // 获取接收IEnumerable<T>的RemoveRange方法
    MethodInfo removeRangeMethod = dbSet.DbSetProperty.PropertyType
        .GetMethod("RemoveRange", new[] { typeof(IEnumerable<>).MakeGenericType(entityType) })!;
    // 获取DbSet中所有实体
    var allEntities = (IEnumerable<object>)dbSet.DbSetProperty.GetValue(_dbContext)!;
    removeRangeMethod.Invoke(dbSet.DbSet, new[] { allEntities });
}

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