将DDD对象映射到EF Core时触发InvalidOperationException异常

问题根源 #

当使用EF Core的OwnsOne映射DDD值对象时，直接在Linq查询中用==比较值对象，EF Core无法识别值对象的自定义相等逻辑，会尝试生成不存在的关联属性（如异常中的LocalAudioSourcePath.LocalAudioSourceId），从而触发InvalidOperationException。

正确解决方案 #

要实现值对象的直接比较，需从值转换配置和相等逻辑实现两方面入手：

1. 完善值对象的相等逻辑 #

确保值对象正确实现Equals、GetHashCode以及相等运算符，让EF Core和CLR都能正确判断值对象的相等性：

public sealed class LocalAudioSourcePath : ValueObject
{
    public string AbsolutePath { get; private set; }

    #pragma warning disable CS8618
    private LocalAudioSourcePath() { }
    #pragma warning restore CS8618 

    private LocalAudioSourcePath(string absolutePath)
    {
        AbsolutePath = absolutePath;
    }

    public static LocalAudioSourcePath Create(string path)
    {
        return new(path);
    }

    protected override IEnumerable<object> GetEqualityComponents()
    {
        yield return AbsolutePath;
    }

    // 重写Equals和GetHashCode
    public override bool Equals(object? obj)
    {
        if (obj is not LocalAudioSourcePath other)
            return false;
        return GetEqualityComponents().SequenceEqual(other.GetEqualityComponents());
    }

    public override int GetHashCode()
    {
        return HashCode.Combine(GetEqualityComponents());
    }

    // 实现相等运算符
    public static bool operator ==(LocalAudioSourcePath? left, LocalAudioSourcePath? right)
    {
        return Equals(left, right);
    }

    public static bool operator !=(LocalAudioSourcePath? left, LocalAudioSourcePath? right)
    {
        return !Equals(left, right);
    }
}

2. 配置EF Core的值转换与ValueComparer #

在实体配置中，为OwnsOne的値对象显式配置值转换，并指定ValueComparer告知EF Core如何比较值对象：

public class LocalAudioSourceTypeConfiguration : IEntityTypeConfiguration<LocalAudioSource>
{
    public void Configure(EntityTypeBuilder<LocalAudioSource> builder)
    {
        builder.ToTable("LocalAudioSources");
        builder.HasKey(e => e.Id);

        builder.Property(e => e.Id)
            .ValueGeneratedNever()
            .HasConversion(
                id => id.Value,
                value => AudioSourceId.FromGuid(value));

        // 配置OwnsOne时显式映射值对象属性并设置值转换
        builder.OwnsOne(e => e.Path, pathBuilder =>
        {
            // 映射值对象的核心属性到数据库列
            pathBuilder.Property(p => p.AbsolutePath)
                .HasColumnName("AbsolutePath")
                .IsRequired();

            // 为整个值对象配置转换逻辑
            pathBuilder.Property(e => e)
                .HasConversion(
                    // 写入数据库时转换为字符串
                    v => v.AbsolutePath,
                    // 从数据库读取时重建值对象
                    v => LocalAudioSourcePath.Create(v))
                // 指定值对象的比较器
                .Metadata.SetValueComparer(new ValueComparer<LocalAudioSourcePath>(
                    (left, right) => left.Equals(right),
                    value => value.GetHashCode(),
                    value => LocalAudioSourcePath.Create(value.AbsolutePath)));
        });
    }
}

3. 测试直接比较查询 #

配置完成后，即可直接在Linq查询中比较值对象：

return await _context.LocalAudioSources
    .Include(e => e.Directories)
    .SingleOrDefaultAsync(e => e.AccountId == accountId && e.Path == path, cancellationToken);

关键说明 #

• EF Core默认不会自动识别值对象的相等逻辑，必须通过ValueComparer或值转换明确告知EF如何处理值对象的比较。
• 显式配置OwnsOne的属性映射，可避免EF Core自动生成不必要的关联字段（如异常中的LocalAudioSourceId）。
• 该方案适用于EF Core 5及以上版本，更高版本对值对象的支持更完善。

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