О сравнении объектов по значению — 1: Beginning

Общеизвестно, что в объектной модели .NET, как и во многих других программных платформах, сравнивать объекты можно по ссылке и по значению.

Пусть есть класс Person, содержащий персональные данные — имя, фамилию, и дату рождения персоны.

1. минимально необходимый набор доработок класса для того, чтобы объекты этого класса сравнивались по значению с помощью стандартной инфраструктуры .NET;
2. минимально необходимый и достаточный набор доработок, чтобы объекты этого класса всегда сравнивались по значению с помощью стандартной инфраструктуры .NET — если явно не указано, что сравнение должно производиться по ссылке.

using System;

namespace HelloEquatable
{
    public class Person
    {
        protected static string NormalizeName(string name) => name?.Trim() ?? string.Empty;

        protected static DateTime? NormalizeDate(DateTime? date) => date?.Date;

        public string FirstName { get; }

        public string LastName { get; }

        public DateTime? BirthDate { get; }

        public Person(string firstName, string lastName, DateTime? birthDate)
        {
            this.FirstName = NormalizeName(firstName);
            this.LastName = NormalizeName(lastName);
            this.BirthDate = NormalizeDate(birthDate);
        }
    }
}

• методом Object.ReferenceEquals(Object, Object),
• методом Object.Equals(Object),
• методом Object.Equals(Object, Object),
• операторами == или !=,

var p1 = new Person("John", "Smith", new DateTime(1990, 1, 1));
var p2 = new Person("John", "Smith", new DateTime(1990, 1, 1));

bool isSamePerson =
    p1.BirthDate == p2.BirthDate &&
    p1.FirstName == p2.FirstName &&
    p1.LastName == p2.LastName;

1. Класс Person реализован таким образом, что строковые свойства FirstName и LastName всегда не равны null.
   Если FirstName или LastName неизвестны (не заданы), то в качестве признака отсутствия значения подойдет пустая строка.
   Это позволит избежать исключения NullReferenceException при обращении к свойствам и методам полей FirstName и LastName, а также коллизии при сравнении null и пустой строки (считать ли FirstName у двух объектов равными, если у одного объекта FirstName равен null, а у другого — пустой строке?).
2. Свойство BirthDate, напротив, реализовано как Nullable(Of T)-структура, т.к. в случае, если дата рождения неизвестна (не задана), то целесообразно сохранить в свойстве именно неопределенное значение, а не особое значение вида 01/01/1900, 01/01/1970, 01/01/0001 или MinValue.
3. При сравнении объектов по значению первым реализовано сравнение дат, т.к. сравнение переменных типа дата-время в общем случае будет производиться быстрее, чем сравнение строк.
4. Сравнение дат и строк реализовано с помощью оператора равенства, т.к. оператор равенства сравнивает структуры по значению, а для строк оператор равенства перегружен и так же сравнивает строки по значению.

• методом Object.Equals(Object),
• методом Object.Equals(Object, Object),
• при помещении в хеш-наборы (хеш-карты) и словари,

• Метод Equals(Object) сравнивает те поля класса, сочетание значений которых образует значение объекта.
• Метод GetHashCode() должен возвращать одинаковые значения хеш-кодов для равных объектов (т.е., для объектов, сравнение которых с помощью Equals(Object) возвращает true).
  Отсюда следует, что если у объектов различные хеш-коды, то объекты не равны; при этом неравные объекты могут иметь одинаковые хеш-коды.
  (Для получения хеш-кода обычно используется результат операции «исключающее или» значений GetHashCode() полей, которые используются в Equals для сравнения объектов по значению;
  в случае, если какое-либо поле является 32-битным целым, вместо хеш-кода этого поля может использоваться непосредственно значение поля;
  также возможны различные оптимизации для минимизации вероятности коллизий, когда два неравных объекта имеют одинаковый хеш-код.)

• x.Equals(y) returns the same value as y.Equals(x).
• If (x.Equals(y) && y.Equals(z)) returns true, then x.Equals(z) returns true.
• x.Equals(null) returns false.
• Successive calls to x.Equals(y) return the same value as long as the objects referenced by x and y are not modified.
• И ряд других, в частности, касающихся правил сравнения значений чисел с плавающей точкой.

using System;

namespace HelloEquatable
{
    public class Person
    {
        protected static string NormalizeName(string name) => name?.Trim() ?? string.Empty;

        protected static DateTime? NormalizeDate(DateTime? date) => date?.Date;

        public string FirstName { get; }

        public string LastName { get; }

        public DateTime? BirthDate { get; }

        public Person(string firstName, string lastName, DateTime? birthDate)
        {
            this.FirstName = NormalizeName(firstName);
            this.LastName = NormalizeName(lastName);
            this.BirthDate = NormalizeDate(birthDate);
        }

        public override int GetHashCode() =>
            this.FirstName.GetHashCode() ^
            this.LastName.GetHashCode() ^
            this.BirthDate.GetHashCode();

        protected static bool EqualsHelper(Person first, Person second) =>
            first.BirthDate == second.BirthDate &&
            first.FirstName == second.FirstName &&
            first.LastName == second.LastName;

        public override bool Equals(object obj)
        {
            if ((object)this == obj)
                return true;

            var other = obj as Person;

            if ((object)other == null)
                return false;

            return EqualsHelper(this, other);
        }
    }
}

• Если какое-либо из используемых полей содержит null, то для него вместо значения GetHashCode() обычно используется ноль.
• Класс Person реализован таким образом, что ссылочные поля FirstName и LastName не могут содержать null, а поле BirthDate является Nullable(Of T)-структурой, для которой в случае неопределенного значения GetHashCode() возвращает ноль, и исключения NullReferenceException при вызове GetHashCode() не возникает.
• Если бы поля класса Person могли содержать null, то метод GetHashCode() был бы реализован следующим образом:
  
  GetHashCode()

  public override int GetHashCode() =>
      this.FirstName?.GetHashCode() ?? 0 ^
      this.LastName?.GetHashCode() ?? 0 ^
      this.BirthDate?.GetHashCode() ?? 0;
  

1. Вначале ссылка на текущий объект (this) сравнивается со ссылкой на входящий объектом, и если ссылки равны, возвращается true (это один и тот же объект, и сравнение по значению не имеет смысла, в т.ч. из соображений производительности).
2. Затем выполняется приведение входящего объекта к типу Person с помощью оператора as. Если результат приведения — null, то возвращается false (либо входящая ссылка изначально была равна null, либо входящий объект имеет несовместимый с классом Person тип, и заведомо не равен текущему объекту).
3. Затем выполняется сравнение полей двух объектов класса Person по значению, и возвращается соответствующий результат.
   Для читабельности кода и возможного повторного использования, сравнение объектов непосредственно по значению вынесено во вспомогательный метод EqualsHelper.

Пока мы реализовали только минимально необходимую функциональность для сравнения объектов по значению, но уже появляются вопросы.

Первый вопрос больше теоретический.

x.Equals(null) returns false.

public override bool Equals(Object obj) {
    //this is necessary to guard against reverse-pinvokes and
    //other callers who do not use the callvirt instruction
    if (this == null)
        throw new NullReferenceException();

    String str = obj as String;
    if (str == null)
        return false;

    if (Object.ReferenceEquals(this, obj))
        return true;

    if (this.Length != str.Length)
        return false;

     return EqualsHelper(this, str);
}

• (для классов, не структур) если ссылки на текущий и входящий объект равны, то возвращается true;
• и уже вторым требованием — если ссылка на входящий объекта равна null, то возвращается false.

А вот второй вопрос по реализации метода Equals(Object) интереснее, и имеет прикладное значение.

x.Equals(y) returns the same value as y.Equals(x).

Об этом, а также о вопросах реализации полного набора доработок класса для сравнения его объектов по значению, поговорим в следующих публикациях.