.NET7下如何获取EF实体实例中用于构建关联的所有属性？

问题描述 #

需要实现通用仓储的StoreAsync方法，要求添加实体时自动跟踪与之关联的现有实体。原实现通过反射获取所有类类型属性并附加，但存在以下问题：

• 误处理非实体类属性（如委托、记录、string等）
• 未区分关联实体是否存在于数据库中，直接附加可能导致外键约束错误

原代码：

public async Task StoreAsync(TEntity model, CancellationToken cancellationToken = default)
{
    foreach (var prop in model.GetType().GetProperties().Where(p => p.GetType().IsClass))
    {
        var related = prop.GetValue(model)!;
        if (_dbContext.Entry(related).State == EntityState.Detached)
            _dbContext.Attach(prop.GetValue(model));
    }

    await _dbContext.Set<TEntity>().AddAsync(model, cancellationToken);
    await _dbContext.SaveChangesAsync(cancellationToken);
}

解决方案 #

1. 利用EF Core元数据获取关联属性 #

EF Core的DbContext.Model包含所有实体的元数据，可通过此准确获取实体的导航属性（即关联属性），避免反射误判非实体类型。

2. 区分关联实体状态并处理 #

• 若关联实体主键为空（或为类型默认值），视为新实体，需调用Add而非Attach
• 若主键有值，视为已存在实体，调用Attach跟踪

修正后的代码实现 #

public async Task StoreAsync(TEntity model, CancellationToken cancellationToken = default)
{
    var entityType = _dbContext.Model.FindEntityType(typeof(TEntity));
    if (entityType == null)
        throw new InvalidOperationException($"{typeof(TEntity)} is not registered as an EF Core entity.");

    var navigationProperties = entityType.GetNavigations();

    foreach (var nav in navigationProperties)
    {
        if (nav.IsCollection)
        {
            // 处理集合类型关联属性
            var collection = (IEnumerable)nav.PropertyInfo.GetValue(model);
            if (collection == null) continue;

            foreach (var item in collection)
            {
                HandleRelatedEntity(item);
            }
        }
        else
        {
            // 处理单个实体关联属性
            var relatedEntity = nav.PropertyInfo.GetValue(model);
            if (relatedEntity == null) continue;

            HandleRelatedEntity(relatedEntity);
        }
    }

    await _dbContext.Set<TEntity>().AddAsync(model, cancellationToken);
    await _dbContext.SaveChangesAsync(cancellationToken);
}

private void HandleRelatedEntity(object relatedEntity)
{
    var entry = _dbContext.Entry(relatedEntity);
    if (entry.State != EntityState.Detached)
        return;

    // 获取关联实体的主键属性
    var entityType = entry.Metadata;
    var primaryKey = entityType.FindPrimaryKey();
    if (primaryKey == null)
        throw new InvalidOperationException($"Entity {relatedEntity.GetType()} has no primary key defined.");

    var keyProperty = primaryKey.Properties.First();
    var keyValue = keyProperty.PropertyInfo.GetValue(relatedEntity);
    var defaultValue = keyProperty.ClrType.GetDefaultValue();

    // 根据主键值判断实体是否为新
    if (keyValue == null || keyValue.Equals(defaultValue))
    {
        _dbContext.Add(relatedEntity);
    }
    else
    {
        _dbContext.Attach(relatedEntity);
    }
}

关键说明 #

• 元数据导航属性：GetNavigations()仅返回EF Core标记为关联的属性，精准过滤非实体类型
• 集合处理：针对一对多/多对多的集合类型关联，遍历每个元素进行状态判断
• 主键判断：通过主键值区分新实体与已存在实体，避免Attach新实体导致的外键错误

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