自定义键类<字符串、布尔值>字典中不存在

Question

我正在尝试弄清楚如何使用自定义类作为字典中的键。我的班级

public class Enabler
{
    public string Name { get; set; }
    public bool Enabled { get; set; }
    public override int GetHashCode()
    {
        return Name.GetHashCode() ^ Enabled.GetHashCode();
    }
    public override bool Equals(object obj)
    {
        return Equals(obj as Enabler);
    }
    public bool Equals(Enabler obj)
    {
        return obj != null && obj.Name == this.Name;
    }
}

当我尝试使用它时：

Dictionary<Enabler, List<AppSettingsElement>> appSettings = new Dictionary<Enabler, List<AppSettingsElement>>();
appSettings.Add(new Enabler {Name = "none", Enabled = true }, new List<AppSettingsElement>());
Enabler myKey = new Enabler { Name = "none" };
appSettings[myKey].Add(new AppSettingsElement { Comment = text, Name = name, Value = "value" });
//last line throws "myKey not found in dictionary" error. 

我做错了什么？

Answer 1

您的Equals和GetHashCode方法需要兼容。现在，您的GetHashCode方法会考虑 Enabled ，但Equals不会，这可能导致无法找到东西。从GetHashCode中删除Enabled检查：

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

或将其添加到Equals：

    public bool Equals(Enabler obj)
    {
        return obj != null && obj.Name == this.Name
            && obj.Enabled == this.Enabled;
    }

请注意，对于第二个选项，myKey需要具有Enabled = true才能成为匹配。

注意：可变键是一个可怕的主意。您应该考虑：

public Enabler(string name, bool enabled)
{
    Name = name;
    Enabled = enabled;
}
public string Name { get; }
public bool Enabled { get; }

使其不可变。

注意：如果您将其设置为不可变，则将其作为struct也可能有意义，因此：

public struct Enabler
{ ... }

并修复null检查：

public override bool Equals(object obj)
    => Equals(obj is Enabler e && Equals(e));
public bool Equals(Enabler obj)
    => obj.Name == this.Name && obj.Enabled == this.Enabled;

无论哪种方式，您还应该Enabler实现IEquatable<Enabler>，即

public class Enabler : IEquatable<Enabler>

或

public struct Enabler : IEquatable<Enabler>