c# - реализация - Почему важно переопределить GetHashCode, когда метод Equals переопределен?
java hashcode реализация (8)
Да, важно, чтобы ваш элемент использовался как ключ в словаре, или HashSet<T>
и т. Д. - поскольку он используется (при отсутствии пользовательского IEqualityComparer<T>
) для группировки элементов в ведра. Если хэш-код для двух элементов не совпадает, они никогда не могут считаться равными (равные просто не будут вызываться).
Метод GetHashCode()
должен отражать логику Equals
; Правила:
- если две вещи равны (
Equals(...) == true
), то они должны возвращать то же значение дляGetHashCode()
- если
GetHashCode()
равен, для них не обязательно быть одинаковым; это столкновение, иEquals
будут вызывать, чтобы убедиться, что это реальное равенство или нет.
В этом случае он выглядит как « return FooId;
» - это подходящая реализация GetHashCode()
. Если вы тестируете несколько свойств, обычно их объединяют с использованием кода, как показано ниже, для уменьшения диагональных коллизий (т. Е. Для new Foo(3,5)
имеет новый хеш-код для new Foo(5,3)
):
int hash = 13;
hash = (hash * 7) + field1.GetHashCode();
hash = (hash * 7) + field2.GetHashCode();
...
return hash;
О - для удобства вы можете также рассмотреть возможность предоставления ==
и !=
Операторов при переопределении Equals
и GetHashCode
.
Демонстрация того, что происходит, когда вы ошибаетесь, here .
Учитывая следующий класс
public class Foo
{
public int FooId { get; set; }
public string FooName { get; set; }
public override bool Equals(object obj)
{
Foo fooItem = obj as Foo;
return fooItem.FooId == this.FooId;
}
public override int GetHashCode()
{
// Which is preferred?
return base.GetHashCode();
//return this.FooId.GetHashCode();
}
}
Я переопределил метод Equals
потому что Foo
представляет строку для таблицы Foo
. Каков предпочтительный метод переопределения GetHashCode
?
Почему важно переопределить GetHashCode
?
Как насчет:
public override int GetHashCode()
{
return string.Format("{0}_{1}_{2}", prop1, prop2, prop3).GetHashCode();
}
Предполагая, что производительность не проблема :)
Не забывайте проверять параметр obj на значение null
при переопределении Equals()
. А также сравнить тип.
public override bool Equals(object obj)
{
if (obj == null || GetType() != obj.GetType())
return false;
Foo fooItem = obj as Foo;
return fooItem.FooId == this.FooId;
}
Причина этого: Equals
должны возвращать false при сравнении с null
. См. Также http://msdn.microsoft.com/en-us/library/bsc2ak47.aspx
Ниже, используя отражение, кажется мне лучшим вариантом с учетом публичных свойств, так как с этим вам не нужно беспокоиться о добавлении / удалении свойств (хотя это не так распространенный сценарий). Это, как мне показалось, лучше работает. (По сравнению с секундомером).
public int getHashCode()
{
PropertyInfo[] theProperties = this.GetType().GetProperties();
int hash = 31;
foreach (PropertyInfo info in theProperties)
{
if (info != null)
{
var value = info.GetValue(this,null);
if(value != null)
unchecked
{
hash = 29 * hash ^ value.GetHashCode();
}
}
}
return hash;
}
Просто добавьте ответы выше:
Если вы не переопределяете Equals, то по умолчанию используется сравнение ссылок объектов. То же самое относится к hashcode - приведение по умолчанию обычно основано на адресе памяти ссылки. Поскольку вы переопределили Equals, это означает, что правильное поведение заключается в сравнении того, что вы внедрили в Equals, а не в ссылках, поэтому вы должны сделать то же самое для hashcode.
Клиенты вашего класса ожидают, что хэш-код будет иметь аналогичную логику для метода equals, например, методы linq, которые используют IEqualityComparer, сначала сравнивают хэш-коды и только если они равны, они будут сравнивать метод Equals (), который может быть более дорогим для запуска, если бы мы не реализовали hashcode, у равного объекта, вероятно, будут разные хэш-коды (потому что они имеют другой адрес памяти) и будут ошибочно определены как не равные (Equals () даже не попадет).
Кроме того, кроме проблемы, что вы не сможете найти свой объект, если вы использовали его в словаре (потому что он был вставлен одним хэш-кодом, и когда вы его ищете, хэш-код по умолчанию, вероятно, будет другим, и снова Equals () даже не будет вызван, как объясняет Марк Гравелл в своем ответе, вы также вводите нарушение концепции словаря или хешета, которая не должна позволять идентичные ключи - вы уже заявили, что эти объекты по существу одинаковы, когда вы перегружаете Equals, чтобы вы не Не хотите, чтобы оба они были разными ключами в структуре данных, которые предполагают наличие уникального ключа. Но поскольку у них есть другой хэш-код, «тот же» ключ будет вставлен как другой.
У нас есть две проблемы, с которыми можно справиться.
Вы не можете предоставить разумный
GetHashCode()
если любое поле в объекте может быть изменено. Также часто объект никогда не будет использоваться в коллекции, которая зависит отGetHashCode()
. Таким образом, стоимость внедренияGetHashCode()
часто не стоит того, или это невозможно.Если кто-то помещает ваш объект в коллекцию, которая вызывает
GetHashCode()
и вы переопределилиEquals()
не делая корректный подходGetHashCode()
, этот человек может потратить дни, отслеживая проблему.
Поэтому по умолчанию я это делаю.
public class Foo
{
public int FooId { get; set; }
public string FooName { get; set; }
public override bool Equals(object obj)
{
Foo fooItem = obj as Foo;
return fooItem.FooId == this.FooId;
}
public override int GetHashCode()
{
// Some comment to explain if there is a real problem with providing GetHashCode()
// or if I just don't see a need for it for the given class
throw new Exception("Sorry I don't know what GetHashCode should do for this class");
}
}
Это не обязательно важно; это зависит от размера ваших коллекций и требований к производительности, и будет ли ваш класс использоваться в библиотеке, где вы не можете знать требования к производительности. Я часто знаю, что размеры моей коллекции не очень большие, и мое время более ценно, чем несколько микросекунд производительности, достигнутых благодаря созданию идеального хеш-кода; поэтому (чтобы избавиться от раздражающего предупреждения компилятором) я просто использую:
public override int GetHashCode()
{
return base.GetHashCode();
}
(Конечно, я мог бы использовать # прагма, чтобы выключить предупреждение, но я предпочитаю этот путь.)
Разумеется, если вы находитесь в положении, в котором вы нуждаетесь, производительность, чем все проблемы, упомянутые другими здесь. Самое главное - иначе вы получите неправильные результаты при извлечении элементов из хеш-набора или словаря: хеш-код не должен меняться в зависимости от времени жизни объекта (точнее, в течение времени, когда требуется хэш-код, например, ключ в словаре): например, следующее неверно, поскольку значение является общедоступным и поэтому может быть изменено извне в класс во время жизни экземпляра, поэтому вы не должны использовать его в качестве основы для хэш-кода:
class A
{
public int Value;
public override int GetHashCode()
{
return Value.GetHashCode(); //WRONG! Value is not constant during the instance's life time
}
}
С другой стороны, если значение не может быть изменено, это нормально использовать:
class A
{
public readonly int Value;
public override int GetHashCode()
{
return Value.GetHashCode(); //OK Value is read-only and can't be changed during the instance's life time
}
}
Это связано с тем, что фреймворк требует, чтобы два объекта, которые одинаковы, должны иметь один и тот же хэш-код. Если вы переопределите метод equals, чтобы выполнить специальное сравнение двух объектов, и оба объекта считаются одинаковыми с помощью метода, то хэш-код двух объектов также должен быть одинаковым. (Словари и Hashtables полагаются на этот принцип).