Что такое контракт между equals и hashCode?

Контракт между equals() и hashCode() в C# и Unity

В контексте C# и Unity, контракт между Equals() и GetHashCode() — это набор правил, которые должны соблюдаться при переопределении этих методов, чтобы коллекции (особенно хэш-таблицы) работали корректно. Хотя Unity использует C#, где эти методы определены в базовом классе Object, их правильная реализация критична для производительности и корректности логики.

Основные правила контракта

1. Согласованность во времени: Если два объекта равны согласно методу Equals(), то их хэш-коды, возвращаемые GetHashCode(), должны быть одинаковыми. Обратное не обязательно верно — одинаковые хэш-коды не гарантируют равенство объектов (возможна коллизия).

2. Стабильность хэш-кода: Хэш-код объекта должен оставаться постоянным на протяжении всего времени жизни объекта, если только поля, участвующие в вычислении Equals(), не изменяются. В Unity это особенно важно для объектов, которые могут кэшироваться или использоваться в словарях.

3. Эффективность вычислений: GetHashCode() должен быть быстрым, так как вызывается часто (например, при работе с Dictionary<TKey, TValue>, HashSet<T>).

Пример нарушения контракта в Unity

Представьте класс PlayerData, который хранит данные игрока:

public class PlayerData
{
    public string PlayerId { get; set; }
    public int Score { get; set; }
    
    public override bool Equals(object obj)
    {
        if (obj is PlayerData other)
        {
            return this.PlayerId == other.PlayerId;
        }
        return false;
    }
    
    // НЕПРАВИЛЬНО: GetHashCode не согласован с Equals
    public override int GetHashCode()
    {
        return Score.GetHashCode(); // Хэш зависит только от Score!
    }
}

Проблема: Два объекта с одинаковым PlayerId (а значит, равные по Equals()) могут иметь разные хэш-коды, если их Score различается. Это приведет к ошибкам при использовании в Dictionary или HashSet.

Правильная реализация

public class PlayerData
{
    public string PlayerId { get; set; }
    public int Score { get; set; }
    
    public override bool Equals(object obj)
    {
        if (obj is PlayerData other)
        {
            return this.PlayerId == other.PlayerId;
        }
        return false;
    }
    
    // ПРАВИЛЬНО: GetHashCode использует те же поля, что и Equals
    public override int GetHashCode()
    {
        return PlayerId?.GetHashCode() ?? 0;
    }
}

Особенности в Unity

• MonoBehaviour и ScriptableObject: Эти классы уже имеют реализацию Equals() и GetHashCode(), основанную на ссылочной семантике. Переопределять их нужно с осторожностью, обычно только для структур данных.

• Структуры (struct): В C# структуры по умолчанию реализуют покомпонентное сравнение через ValueType.Equals(). Для сложных структур рекомендуется переопределять оба метода для повышения производительности.

• Использование в коллекциях:

  • Dictionary<PlayerData, T> будет работать некорректно при нарушении контракта
  • HashSet<PlayerData> может содержать дубликаты
  • Производительность поиска в хэш-таблицах деградирует при плохих хэш-функциях

Рекомендации для Unity-разработчиков

1. Всегда переопределяйте оба метода вместе, если изменяете логику равенства
2. Используйте неизменяемые поля для вычисления хэш-кода
3. Для составных хэшей применяйте комбинацию через HashCode.Combine() (C# 7.3+):

public override int GetHashCode()
{
    return HashCode.Combine(PlayerId, Score);
}

1. Тестируйте с коллекциями типа Dictionary и HashSet

Нарушение контракта между Equals() и GetHashCode() — одна из самых коварных ошибок, которая может долго оставаться незамеченной, но приводить к случайным сбоям в работе коллекций, особенно в многопоточных сценариях или при сериализации/десериализации данных в Unity.