Шаблон реализации Equals

Работая с объектами, нам часто явно или неявно приходится их сравнивать их друг с другом. За сравнение объектов отвечает метод Equals или его типизированная версия из IEquatable, возвращающая true в случае если объекты равны, в противном случае false. Стандартная реализация метода Equals не всегда удовлетворяет потребностям разработчика, так как она не учитывает конкретных особенностей объекта, и в этом случае, реализация конкретного Equals/IEquatable ложится на плечи самого разработчика. Каждый разработчик вправе по-своему реализовать данную функциональность (не нарушая правил Implementing the Equals Method), как ему будет удобно. У меня, как у разработчика, на этот счет со временем выработался удобный шаблон реализации метода Equals/IEquatable, состоящий из 2-х простых правил:

1. От простого к сложному: выполнять сравнение начиная с простых условий и заканчивая более сложными.
2. Понять равенство/неравенство объектов как можно раньше: делайте незамедлительный "return true/false".

Реализация шаблона на языке C# в комментариях на примере класса Foo:

class Foo : IEquatable<Foo>

{

    public override bool Equals(object obj)

    {

        Foo foo = obj as Foo;

        return this.Equals(foo);

    }

 

    public bool Equals(Foo other)

    {

        // От ПРОСТОГО к  СЛОЖНОМУ.

        // Выполняйте сравнение начиная с

        // простых условий (проверка на null, сравнение ссылок)

        // и заканчивая более сложными (сравнение содержимого).

 

        if (other == null)

        {

            // this заведомо не null.

            return false;

        }

 

        if (Object.ReferenceEquals(this, other))

        {

            // обе ссылки ссылаются на один и тот же объект.

            return true;

        }

 

        // Сравнение содержимого.

        // Здесь опишите конкретное сравнения по полям.

        //

        // От ПРОСТОГО к  СЛОЖНОМУ.

        // 1. Выделите самые простые относительно

        // операции сравнения поля и сравните их первыми.

        // Более сложные оставьте на конец.

        //

        // 2. Делайте незамедлительный "return false"

        // при первом же несовпадении.

        //

        // 3. Сравнивайте поля класса методом Equals,

        // за исключением простых типов: field.Equals(other.field)

        //

        // 4. Не забывайте в конце вызвать base.Equals(other).

 

        return true;

    }

}

Ссылки:

1. Implementing the Equals Method