EF Core使用值对象ClientId查询Client时出现无后备字段错误

定义的实体类与值对象 #

Client实体类 #

public class Client
{
    public int Id { get; set; }
    public ClientId ClientId { get; set; }
}

ClientId值对象（记录类型） #

public record ClientId
{
    private ClientId() { }

    public ClientId(string clientId)
    {
        if (!CanCreate(clientId))
            throw new ArgumentException($"'{nameof(clientId)}' must be 32 bytes long Base64Url encoded string.");

        Value = clientId;
    }

    public string Value { get; private init; }

    public static bool CanCreate(string clientId)
    {
        return !string.IsNullOrEmpty(clientId) && Base64UrlEncoder.Validate(clientId, out int length) && length == 32;
    }
}

查询方法实现 #

public async Task<T?> FindByClientId<T>(ClientId clientId, Expression<Func<Client, T>> selector, CancellationToken cancellationToken = default,
    params Expression<Func<Client, object>>[] include)
{
    if (selector is null) throw new ArgumentNullException(nameof(selector));

    var baseQuery = _dbContext.Clients.AsNoTrackingWithIdentityResolution()
        .Where(p => p.ClientId == clientId);
    
    return await include.Aggregate(baseQuery, (current, inc) => current.Include(inc))
        .Select(selector)
        .SingleOrDefaultAsync(cancellationToken);
}

抛出的异常 #

System.InvalidOperationException: No backing field could be found for property 'ClientId.ClientId' and the property does not have a getter.

Client配置类 #

public class ClientConfiguration : IEntityTypeConfiguration<Client>
{
    public void Configure(EntityTypeBuilder<Client> builder)
    {
        builder.OwnsOne(p => p.ClientId, buildAction =>
        {
            buildAction.Property(p => p.Value)
            .HasColumnName(nameof(Client.ClientId))
            .HasMaxLength(43);

            buildAction.HasIndex(p => p.Value).IsUnique();
        });
    }
}

核心问题分析 #

1. Record类型的隐式属性干扰EF Core解析：你用record定义ClientId，编译器会自动为主构造函数的clientId参数生成一个隐式的ClientId属性，但这个属性没有公共getter，且你的ClientId有私有无参构造函数，EF Core处理自有实体时会尝试访问这个不存在的有效属性，导致报错。
2. 值对象实例比较的映射问题：查询中直接写p.ClientId == clientId，EF Core无法将这个值对象实例的相等性比较正确转换为数据库字段的比较，转而尝试解析记录类型的隐式属性，最终触发异常。

解决方案 #

方案1：将ClientId改为普通类并完善值相等逻辑 #

把record换成普通类，避免编译器生成隐式属性，同时重写相等判断方法：

public class ClientId
{
    private ClientId() { }

    public ClientId(string value)
    {
        if (!CanCreate(value))
            throw new ArgumentException($"'{nameof(value)}' must be 32 bytes long Base64Url encoded string.");

        Value = value;
    }

    public string Value { get; }

    public static bool CanCreate(string value)
    {
        return !string.IsNullOrEmpty(value) && Base64UrlEncoder.Validate(value, out int length) && length == 32;
    }

    public override bool Equals(object? obj)
    {
        return obj is ClientId other && Value == other.Value;
    }

    public override int GetHashCode()
    {
        return Value.GetHashCode();
    }
}

方案2：调整查询条件，直接比较Value属性 #

修改Where子句，直接用值对象的Value字段做比较，让EF Core能正确生成SQL：

var baseQuery = _dbContext.Clients.AsNoTrackingWithIdentityResolution()
    .Where(p => p.ClientId.Value == clientId.Value);

方案3：保留Record类型，配置EF Core忽略隐式属性 #

如果坚持用record，在配置中明确忽略编译器生成的隐式ClientId属性：

public class ClientConfiguration : IEntityTypeConfiguration<Client>
{
    public void Configure(EntityTypeBuilder<Client> builder)
    {
        builder.OwnsOne(p => p.ClientId, buildAction =>
        {
            // 忽略编译器自动生成的隐式ClientId属性
            buildAction.Ignore(c => c.ClientId);
            
            buildAction.Property(p => p.Value)
                .HasColumnName(nameof(Client.ClientId))
                .HasMaxLength(43);

            buildAction.HasIndex(p => p.Value).IsUnique();
        });
    }
}

额外建议 #

• 自定义值对象时，重写Equals和GetHashCode是最佳实践，既能保证业务上的值相等判断正确，也能让EF Core更好地处理相关的查询逻辑。
• 使用自有实体映射值对象时，要明确告诉EF Core需要映射的属性，避免编译器自动生成的隐式成员造成解析混乱。

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