Наиболее надежная реализация Equals для пользовательских классов для равенства значений в C # - PullRequest
Новая
       11

Наиболее надежная реализация Equals для пользовательских классов для равенства значений в C #

3 голосов
/ 20 февраля 2009

Скажем, у меня есть класс Point2, и я хочу реализовать следующие Equals: 

public override bool Equals ( object obj )

public bool Equals ( Point2 obj )

Это из книги Effective C # 3: 

public override bool Equals ( object obj )
{
    // STEP 1: Check for null
    if ( obj == null )
    {
        return false;
    }

    // STEP 3: equivalent data types
    if ( this.GetType ( ) != obj.GetType ( ) )
    {
        return false;
    }
    return Equals ( ( Point2 ) obj );
}

public bool Equals ( Point2 obj )
{
    // STEP 1: Check for null if nullable (e.g., a reference type)
    if ( obj == null )
    {
        return false;
    }
    // STEP 2: Check for ReferenceEquals if this is a reference type
    if ( ReferenceEquals ( this, obj ) )
    {
        return true;
    }
    // STEP 4: Possibly check for equivalent hash codes
    if ( this.GetHashCode ( ) != obj.GetHashCode ( ) )
    {
        return false;
    }
    // STEP 5: Check base.Equals if base overrides Equals()
    System.Diagnostics.Debug.Assert (
        base.GetType ( ) != typeof ( object ) );

    if ( !base.Equals ( obj ) )
    {
        return false;
    }

    // STEP 6: Compare identifying fields for equality.
    return ( ( this.X.Equals ( obj.X ) ) && ( this.Y.Equals ( obj.Y ) ) );
}

Это перебор?

Ответы [ 4 ]

3 голосов
/ 20 февраля 2009

Сложно поддерживать равенство с иерархией наследования. Вы должны понять, что именно вы имеете в виду. Вам действительно нужно наследство здесь? Если нет - если Point2 получен непосредственно из System.Object и вы можете сделать его запечатанным, жизнь станет немного проще. В этом случае я бы использовал: 

public override bool Equals (object obj)
{
    return Equals(obj as Point2);
}

public bool Equals (Point2 obj)
{
    // STEP 1: Check for null if nullable (e.g., a reference type)
    // Note use of ReferenceEquals in case you overload ==.
    if (object.ReferenceEquals(obj, null))
    {
        return false;
    }

    // STEP 2: Check for ReferenceEquals if this is a reference type
    // Skip this or not? With only two fields to check, it's probably
    // not worth it. If the later checks are costly, it could be.
    if (object.ReferenceEquals( this, obj))
    {
        return true;
    }

    // STEP 4: Possibly check for equivalent hash codes
    // Skipped in this case: would be *less* efficient

    // STEP 5: Check base.Equals if base overrides Equals()
    // Skipped in this case

    // STEP 6: Compare identifying fields for equality.
    // In this case I'm using == instead of Equals for brevity
    // - assuming X and Y are of a type which overloads ==.
    return this.X == obj.X && this.Y == obj.Y;
}
2 голосов
/ 20 февраля 2009

Не совсем - вы учитываете практически все возможности. Если этот код предназначен для чего-то иного, чем «пустое» приложение, вы должны рассмотреть преимущества этого подхода, поскольку логические ошибки из-за странного поведения равенства объектов болезненны для отладки.

1 голос
/ 20 февраля 2009

Это, конечно, больше кода, чем Я бы хотел бы написать для метода equals. Существует много избыточных проверок, таких как проверка ReferenceEquals и HashCodes (я знаю, что эти проверки избыточны, потому что последние строки в вашей функции проверяют структурное равенство). Сосредоточьтесь на простом и читаемом коде. 

public bool Equals(object o)
{
    Point2 p = o as Point2;
    if (o != null)
        return this.X == o.X && this.Y == o.Y;
    else
        return false;
}

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

1 голос
/ 20 февраля 2009

Выглядит как то, что вы хотели бы. Весь этот блок сводится к:

"если это точно такой же экземпляр, вернуть true. Если это отдельные экземпляры с одинаковыми значениями X и Y, вернуть true. Все другие случаи (ноль, другой тип, разные значения x / y) возвращают false."

...