Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

System.IEquatable<T> — równość z określonym typem

System.IEquatable<T> definiuje Equals(T), czyli porównanie równości z argumentem określonego typu. Spójna implementacja obejmuje też Equals(object), GetHashCode() oraz operatory == i !=, dzięki czemu własny typ zachowuje się przewidywalnie w kolekcjach.

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

Składnia

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> pozwala zdefiniować równość dla konkretnego typu; zwykle T jest typem implementującym interfejs, np. ItemId : IEquatable<ItemId>. Metoda Equals(T) zwraca true, gdy wartości są równe według przyjętej reguły. Nie określa kolejności sortowania — do tego służy IComparable<T>. Interfejs jest dostępny w .NET 10; przykład nie wymaga funkcji preview.

Equals(T) powinno być zwrotne, symetryczne i przechodnie, a przy niezmienionych danych dawać niezmienny wynik. Dla klasy porównanie z null powinno zwracać false. Nadpisz także Equals(object) i GetHashCode(), zachowując zgodność z metodą typowaną. Interfejs sam nie definiuje operatorów == i !=; jeśli je udostępniasz, muszą stosować tę samą regułę.

EqualityComparer<T>.Default korzysta z IEquatable<T>, gdy typ go implementuje. Pozwala to kolekcjom generycznym używać równości typowanej, a dla struktur unikać pakowania podczas takiego porównania. Własny comparer przekazany kolekcji może zastosować inną regułę. Jawne rzutowanie struktury na object nadal powoduje pakowanie, jak w drugim wywołaniu przykładu.

Równe wartości muszą mieć identyczny wynik GetHashCode(), ale identyczne skróty nie dowodzą równości. Nie zmieniaj danych wpływających na równość lub skrót, gdy obiekt jest kluczem w Dictionary<TKey,TValue> albo elementem HashSet<T>. Przykład używa niezmiennej struktury: dwa identyfikatory o Value równym 42 są równe, więc HashSet<ItemId> odrzuca duplikat.

Przykłady

#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);
    }
}

Wynik

True
True
True
True
False
1

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła