EF Core审计追踪中子实体OriginalValue显示更新值的问题

在.NET 6 + EF Core项目中，实现SystemSpecification及其子实体SystemSpecificationSetPoint的更新接口时，使用AutoMapper将请求数据映射到实体后，子实体的Value字段在ChangeTracker中OriginalValue与CurrentValue均为更新后的值，EF无法检测到变更，导致审计日志无法记录该字段的修改。

核心原因 #

1. 未加载关联子实体：查询主实体时未显式包含子集合SetPoints，导致子实体未被EF ChangeTracker跟踪，AutoMapper修改属性时EF无法捕获原始值。
2. 不必要的Update调用：调用_dbContext.SystemSpecifications.Update()会强制将整个实体（包括子实体）标记为Modified，覆盖ChangeTracker的原始跟踪状态。
3. AutoMapper集合映射规则问题：默认集合映射会替换目标集合，导致原有子实体被重新实例化或状态丢失，ChangeTracker无法识别变更。

解决方案 #

1. 显式加载关联子实体并移除不必要的Update调用 #

修改查询逻辑，确保加载主实体时同时包含子集合，让EF跟踪子实体的原始值；同时移除强制Update的调用，依赖EF自动跟踪变更。

public async Task<ApiResponse<bool>> Update(UpdateSystemSpecificationRequest request, CancellationToken cancellationToken)
{
    // 显式包含子集合SetPoints，确保子实体被ChangeTracker跟踪
    var systemSpecificationToUpdate = await _dbContext.SystemSpecifications
        .Include(x => x.SetPoints)
        .Where(x => x.Id == request.Id)
        .FirstOrDefaultAsync(cancellationToken);

    if (systemSpecificationToUpdate == null)
    {
        return new ApiResponse<bool>() { HasError = true, Result = false, Message = "实体不存在" };
    }

    // 映射请求数据到已跟踪的实体
    _mapper.Map(request, systemSpecificationToUpdate);

    // 移除不必要的Update调用，EF会自动跟踪变更
    // _dbContext.SystemSpecifications.Update(systemSpecificationToUpdate);

    await _dbContext.SaveChangesAsync(Guid.Parse("b8b8362e-adfd-4e2f-838b-e6440b60dab3"));

    return new ApiResponse<bool>() { HasError = false, Result = true };
}

2. 配置AutoMapper正确处理集合映射 #

确保AutoMapper在映射子集合时，匹配已有实体的主键，更新而非替换子实体。在AutoMapper Profile中添加如下配置：

public class SystemSpecificationProfile : Profile
{
    public SystemSpecificationProfile()
    {
        CreateMap<UpdateSystemSpecificationRequest, SystemSpecification>()
            // 配置子集合映射，使用目标集合的已有实体进行匹配更新
            .ForMember(dest => dest.SetPoints, opt => opt.MapFrom(src => src.SetPoints));

        // 子实体映射规则：忽略主键和外键（避免覆盖已有值），只更新业务字段
        CreateMap<UpdateSystemSpecificationSetPointRequest, SystemSpecificationSetPoint>()
            .ForMember(dest => dest.Id, opt => opt.Ignore())
            .ForMember(dest => dest.SystemSpecificationId, opt => opt.Ignore());
    }
}

3. 手动处理子实体更新（备选方案） #

如果AutoMapper集合映射仍有问题，可以手动遍历请求中的子实体，找到对应的已跟踪实体并修改属性，确保ChangeTracker捕获到每一处变更：

public async Task<ApiResponse<bool>> Update(UpdateSystemSpecificationRequest request, CancellationToken cancellationToken)
{
    var systemSpecificationToUpdate = await _dbContext.SystemSpecifications
        .Include(x => x.SetPoints)
        .Where(x => x.Id == request.Id)
        .FirstOrDefaultAsync(cancellationToken);

    if (systemSpecificationToUpdate == null)
    {
        return new ApiResponse<bool>() { HasError = true, Result = false, Message = "实体不存在" };
    }

    // 映射主实体字段
    _mapper.Map(request, systemSpecificationToUpdate);

    // 手动处理子实体更新
    foreach (var setPointRequest in request.SetPoints)
    {
        var existingSetPoint = systemSpecificationToUpdate.SetPoints.FirstOrDefault(sp => sp.Id == setPointRequest.Id);
        if (existingSetPoint != null)
        {
            // 直接修改已跟踪的子实体属性，EF会自动标记为Modified
            existingSetPoint.Type = setPointRequest.Type;
            existingSetPoint.Value = setPointRequest.Value;
            existingSetPoint.AcceptableRange = setPointRequest.AcceptableRange;
        }
        else
        {
            // 处理新增的子实体
            var newSetPoint = _mapper.Map<SystemSpecificationSetPoint>(setPointRequest);
            newSetPoint.SystemSpecificationId = systemSpecificationToUpdate.Id;
            systemSpecificationToUpdate.SetPoints.Add(newSetPoint);
        }
    }

    await _dbContext.SaveChangesAsync(Guid.Parse("b8b8362e-adfd-4e2f-838b-e6440b60dab3"));

    return new ApiResponse<bool>() { HasError = false, Result = true };
}

4. 验证审计代码的变更检测逻辑 #

确保审计代码中OnBeforeSaveChanges方法的DetectChanges()调用在遍历变更实体之前，并且正确检查子实体的IsModified状态：

private void OnBeforeSaveChanges(Guid? userId)
{
    // 先调用DetectChanges，确保所有变更被检测到
    ChangeTracker.DetectChanges();
    var auditEntries = new List<AuditEntry>();

    foreach (var entry in ChangeTracker.Entries())
    {
        if (entry.Entity is Audit || entry.State == EntityState.Detached || entry.State == EntityState.Unchanged)
            continue;
        
        var auditEntry = new AuditEntry(entry);
        auditEntry.TableName = entry.Entity.GetType().Name;
        auditEntry.UserId = userId.Value;
        auditEntries.Add(auditEntry);

        foreach (var property in entry.Properties)
        {
            string propertyName = property.Metadata.Name;
            if (property.Metadata.IsPrimaryKey() || property.Metadata.IsForeignKey())
            {
                auditEntry.KeyValues[propertyName] = property.CurrentValue;
                continue;
            }

            switch (entry.State)
            {
                case EntityState.Added:
                    auditEntry.AuditType = Domain.Entities.Enums.AuditTypeEnum.Create;
                    auditEntry.NewValues[propertyName] = property.CurrentValue;
                    break;
                case EntityState.Deleted:
                    auditEntry.AuditType = Domain.Entities.Enums.AuditTypeEnum.Delete;
                    auditEntry.OldValues[propertyName] = property.OriginalValue;
                    break;
                case EntityState.Modified:
                    // 确保只记录真正修改的属性
                    if (property.IsModified && !string.Equals(property.OriginalValue?.ToString(), property.CurrentValue?.ToString()))
                    {
                        auditEntry.ChangedColumns.Add(propertyName);
                        auditEntry.AuditType = Domain.Entities.Enums.AuditTypeEnum.Update;
                        auditEntry.OldValues[propertyName] = property.OriginalValue;
                        auditEntry.NewValues[propertyName] = property.CurrentValue;
                    }
                    break;
            }
        }
    }

    foreach (var auditEntry in auditEntries)
    {
        Audit.Add(auditEntry.ToAudit());
    }
}

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