我对 Entity Framework 项目中的导航属性有疑问。

这是类 MobileUser :

[DataContract]
[Table("MobileUser")]
public class MobileUser: IEquatable<MobileUser>
{
    // constructors omitted....

    /// <summary>
    /// The primary-key of MobileUser.
    /// This is not the VwdId which is stored in a separate column
    /// </summary>
    [DataMember, Key, Required, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
    public int UserId { get; set; }

    [DataMember, Required, Index(IsUnique = true), MinLength(VwdIdMinLength), MaxLength(VwdIdMaxLength)]
    public string VwdId { get; set; }

    // other properties omitted ...

    [DataMember]
    public virtual ICollection<MobileDeviceInfo> DeviceInfos { get; private set; }

    public bool Equals(MobileUser other)
    {
        return this.UserId == other?.UserId || this.VwdId == other?.VwdId;
    }

    public override bool Equals(object obj)
    {
        if(object.ReferenceEquals(this, obj))return true;
        MobileUser other = obj as MobileUser;
        if (other == null) return false;
        return this.Equals(other);
    }

    public override int GetHashCode()
    {
        // ReSharper disable once NonReadonlyMemberInGetHashCode
        return VwdId.GetHashCode();
    }

    public override string ToString()
    {
        return "foo"; // omitted actual implementation
    }

    #region constants
    // irrelevant
    #endregion
}

相关部分是这个导航属性:

public virtual ICollection<MobileDeviceInfo> DeviceInfos { get; private set; }

这是类 MobileDeviceInfo :

[DataContract]
[Table("MobileDeviceInfo")]
public class MobileDeviceInfo : IEquatable<MobileDeviceInfo>
{
    [DataContract]
    public enum MobilePlatform
    {
        [EnumMember]
        // ReSharper disable once InconsistentNaming because correct spelling is iOS
        iOS = 1,
        [EnumMember] Android = 2,
        [EnumMember] WindowsPhone = 3,
        [EnumMember] Blackberry = 4
    }

    // constructors omitted ...

    [DataMember, Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
    public int DeviceInfoId { get; private set; }

    [DataMember, Required, Index(IsUnique = true), MinLength(DeviceTokenMinLength), MaxLength(DeviceTokenMaxLength)]
    public string DeviceToken { get; set; }

    [DataMember, Required, MinLength(DeviceNameMinLength), MaxLength(DeviceNameMaxLength)]
    public string DeviceName { get; set; }

    [DataMember, Required]
    public MobilePlatform Platform { get; set; }

    // other properties ...

    [DataMember]
    public virtual MobileUser MobileUser { get; private set; }

    /// <summary>
    ///     The foreign-key to the MobileUser.
    ///     This is not the VwdId which is stored in MobileUser
    /// </summary>
    [DataMember, ForeignKey("MobileUser")]
    public int UserId { get; set; }

    public bool Equals(MobileDeviceInfo other)
    {
        if (other == null) return false;
        return DeviceToken == other.DeviceToken;
    }

    public override string ToString()
    {
        return "Bah"; // implementation omitted

    public override bool Equals(object obj)
    {
        if (ReferenceEquals(this, obj)) return true;
        MobileDeviceInfo other = obj as MobileDeviceInfo;
        if (other == null) return false;
        return Equals(other);
    }

    public override int GetHashCode()
    {
        // ReSharper disable once NonReadonlyMemberInGetHashCode
        return DeviceToken.GetHashCode();
    }

    #region constants
    // irrelevant
    #endregion
}

如您所见，它实现了 IEquatable<MobileDeviceInfo>并覆盖 Equals和 GetHashCode来自 System.Object .

我有以下测试，我预计 Contains会调用我 Equals但事实并非如此。它似乎使用 Object.ReferenceEquals相反，所以找不到我的设备，因为它是不同的引用:

var userRepo = new MobileUserRepository((ILog)null);
var deviceRepo = new MobileDeviceRepository((ILog)null);

IReadOnlyList<MobileUser> allUser = userRepo.GetAllMobileUsersWithDevices();
MobileUser user = allUser.First();

IReadOnlyList<MobileDeviceInfo> allDevices = deviceRepo.GetMobileDeviceInfos(user.VwdId, true);
MobileDeviceInfo device = allDevices.First();
bool contains = user.DeviceInfos.Contains(device);
bool anyEqual = user.DeviceInfos.Any(x => x.DeviceToken == device.DeviceToken);
Assert.IsTrue(contains); // no, it's false

第二种方法 LINQ的 Enumerable.Any返回预期的 true .

如果我不使用 user.DeviceInfos.Contains(device)但是user.DeviceInfos.ToList().Contains(device)自 List<>.Contains 以来，它也按预期工作使用我的 Equals .

ICollection<> 的实际类型似乎是 System.Collections.Generic.HashSet<MobileDeviceInfo>但如果我使用以下代码，它也使用 HashSet<>它再次按预期工作:

bool contains = new HashSet<MobileDeviceInfo>(user.DeviceInfos).Contains(device); // true

那么为什么只比较引用和我的自定义 Equals被忽略了？

更新:

更令人困惑的是结果是false即使我把它投到 HashSet<MobileDeviceInfo> :

 // still false
bool contains2 = ((HashSet<MobileDeviceInfo>)user.DeviceInfos).Contains(device);
// but this is true as already mentioned
bool contains3 = new HashSet<MobileDeviceInfo>(user.DeviceInfos).Contains(device); 

更新 2::原因似乎是两个 HashSet 使用不同的比较器。 entity-framework-HashSet 使用:

System.Data.Entity.Infrastructure.ObjectReferenceEqualityComparer

和标准HashSet<>使用:

GenericEqualityComparer<T>

这解释了这个问题，虽然我不明白为什么 Entity Framework 使用忽略自定义的实现 Equals特定情况下的实现。这是一个令人讨厌的陷阱，不是吗？

结论:永远不要使用Contains如果您不知道将使用什么比较器或使用 Enumerable.Contains 使用自定义比较器的重载:

bool contains = user.DeviceInfos.Contains(device, EqualityComparer<MobileDeviceInfo>.Default);  // true

最佳答案

从 EF 源代码中，您可能会偶然发现 CreateCollectionCreateDelegate ，这似乎是作为连接导航属性的一部分调用的。

这会调用 EntityUtil.DetermineCollectionType 并返回 HashSet<T>作为与属性兼容的类型。

然后，装备HashSet<T> , 它会调用 DelegateFactory.GetNewExpressionForCollectionType 根据代码和描述，它处理 HashSet<T>作为特例并传递给它 ObjectReferenceEqualityComparer 在构造函数中。

所以:HashSet<T> EF 为您创建的不是使用您的相等性实现，而是使用引用相等性。

关于c# - 为什么 ICollection<>.Contains 会忽略我重写的 Equals 和 IEquatable<> 接口(interface)？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/39102651/