Что необходимо сделать, чтобы использовать класс в качестве ключа в коллекции?

Чтобы использовать класс в качестве ключа в коллекции (например, в Dictionary<TKey, TValue>), необходимо правильно реализовать методы Equals и GetHashCode.

1. Переопределить Equals(object obj):

   • Сравнить текущий экземпляр с другим объектом (obj) на равенство.
   • Убедиться, что obj не является null.
   • Убедиться, что obj имеет тот же тип, что и текущий экземпляр.
   • Сравнить значимые поля или свойства обоих объектов.

2. Переопределить GetHashCode():

   • Сгенерировать хэш-код на основе тех же значимых полей или свойств, что используются в Equals.
   • Гарантировать, что если Equals возвращает true для двух объектов, то их методы GetHashCode возвращают одно и то же значение.
   • Желательно обеспечить равномерное распределение хэш-кодов для уменьшения коллизий.

3. Опционально реализовать IEquatable<T>:

   • Предоставляет типизированный метод Equals(T other), который может быть более производительным, избегая упаковки (boxing) для типов значений.

Пример:

using System;
using System.Collections.Generic;

public class MyKey
{
    public int Id { get; }
    public string Name { get; }

    public MyKey(int id, string name)
    {
        Id = id;
        Name = name;
    }

    // Переопределяем Equals для сравнения по значениям полей
    public override bool Equals(object obj)
    {
        if (obj == null || GetType() != obj.GetType())
        {
            return false;
        }

        MyKey other = (MyKey)obj;
        return Id == other.Id && Name == other.Name;
    }

    // Переопределяем GetHashCode, используя те же поля
    public override int GetHashCode()
    {
        // Используем Tuple для удобства комбинирования хэш-кодов
        return (Id, Name).GetHashCode();
    }

    // Опционально реализуем IEquatable<T>
    public bool Equals(MyKey other)
    {
        if (other == null)
        {
            return false;
        }
        return Id == other.Id && Name == other.Name;
    }
}

Без правильной реализации этих методов, по умолчанию Dictionary будет использовать identity equality (сравнение ссылок) и дефолтную реализацию GetHashCode (основанную на ссылке), что приведет к некорректной работе коллекции при поиске ключей по значению.