Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / C#

System.IEquatable<T> — igualdade fortemente tipada

System.IEquatable<T> define Equals(T), uma comparação de igualdade com um argumento fortemente tipado. Uma implementação coerente inclui também Equals(object), GetHashCode() e os operadores == e !=, para que um tipo personalizado tenha um comportamento previsível nas coleções.

Versão: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Sintaxe

public readonly struct ItemId : System.IEquatable<ItemId>
{
    public int Value { get; }

    public ItemId(int value) => Value = value;

    public bool Equals(ItemId other) => Value == other.Value;
}

System.IEquatable<T> permite definir a igualdade para um tipo específico; normalmente, T é o tipo que implementa a interface, como em ItemId : IEquatable<ItemId>. O método Equals(T) devolve true quando os valores são iguais segundo a regra escolhida. Não define a ordem de ordenação — essa é a função de IComparable<T>. A interface está disponível no .NET 10; o exemplo não requer funcionalidades de pré-visualização.

Equals(T) deve ser reflexivo, simétrico e transitivo, e produzir resultados consistentes enquanto os dados não se alterarem. Numa classe, a comparação com null deve devolver false. Substitui também Equals(object) e GetHashCode(), mantendo-os coerentes com a igualdade tipada. A interface não define, por si só, os operadores == e !=; se os disponibilizares, têm de seguir a mesma regra.

EqualityComparer<T>.Default utiliza IEquatable<T> quando o tipo implementa a interface. Assim, as coleções genéricas podem recorrer à igualdade tipada e evitar o boxing de estruturas durante essa comparação. Um comparador personalizado fornecido a uma coleção pode aplicar uma regra diferente. Converter explicitamente uma estrutura para object continua a provocar boxing, como acontece na segunda chamada do exemplo.

Valores iguais têm de devolver resultados idênticos de GetHashCode(), mas hashes idênticos não provam que os valores são iguais. Não alteres os dados que determinam a igualdade ou o hash enquanto um objeto for uma chave em Dictionary<TKey,TValue> ou um elemento em HashSet<T>. O exemplo utiliza uma estrutura imutável: dois identificadores cujo Value é 42 são iguais, pelo que HashSet<ItemId> rejeita o duplicado.

Exemplos

#nullable enable
using System;
using System.Collections.Generic;

public readonly struct ItemId : IEquatable<ItemId>
{
    public int Value { get; }

    public ItemId(int value) => Value = value;

    public bool Equals(ItemId other) => Value == other.Value;
    public override bool Equals(object? obj) =>
        obj is ItemId other && Equals(other);
    public override int GetHashCode() => Value;

    public static bool operator ==(ItemId left, ItemId right) =>
        left.Equals(right);
    public static bool operator !=(ItemId left, ItemId right) =>
        !left.Equals(right);
}

public static class Program
{
    public static void Main()
    {
        var first = new ItemId(42);
        var same = new ItemId(42);
        var ids = new HashSet<ItemId> { first };

        Console.WriteLine(first.Equals(same));
        Console.WriteLine(first.Equals((object)same));
        Console.WriteLine(first == same);
        Console.WriteLine(ids.Contains(same));
        Console.WriteLine(ids.Add(same));
        Console.WriteLine(ids.Count);
    }
}

Resultado

True
True
True
True
False
1

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes