WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C#

System.IEquatable<T> — typsichere Gleichheit

System.IEquatable<T> definiert Equals(T), einen Gleichheitsvergleich mit einem Argument des konkreten Typs. Eine konsistente Implementierung umfasst auch Equals(object), GetHashCode() sowie die Operatoren == und !=, damit sich ein eigener Typ in Sammlungen vorhersehbar verhält.

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

Syntax

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> ermöglicht es, Gleichheit für einen bestimmten Typ festzulegen; üblicherweise ist T der implementierende Typ, etwa bei ItemId : IEquatable<ItemId>. Die Methode Equals(T) gibt true zurück, wenn Werte nach der gewählten Regel gleich sind. Sie legt keine Sortierreihenfolge fest — dafür ist IComparable<T> zuständig. Die Schnittstelle ist in .NET 10 verfügbar; das Beispiel benötigt keine Preview-Funktionen.

Equals(T) sollte reflexiv, symmetrisch und transitiv sein und bei unveränderten Daten stets dasselbe Ergebnis liefern. Bei einer Klasse sollte der Vergleich mit null false zurückgeben. Überschreibe außerdem Equals(object) und GetHashCode() so, dass sie mit der typisierten Gleichheit übereinstimmen. Die Schnittstelle definiert die Operatoren == und != nicht selbst; wenn du sie bereitstellst, müssen sie derselben Regel folgen.

EqualityComparer<T>.Default verwendet IEquatable<T>, wenn der Typ die Schnittstelle implementiert. So können generische Sammlungen typisierte Gleichheit verwenden und vermeiden beim entsprechenden Vergleich das Boxing von Strukturen. Ein eigener, an eine Sammlung übergebener Comparer kann eine andere Regel anwenden. Eine Struktur explizit in object umzuwandeln, verursacht weiterhin Boxing, wie beim zweiten Aufruf im Beispiel.

Gleiche Werte müssen bei GetHashCode() identische Ergebnisse liefern; identische Hashes beweisen jedoch keine Gleichheit. Ändere keine Daten, die Gleichheit oder Hashwert bestimmen, solange ein Objekt als Schlüssel in Dictionary<TKey,TValue> oder als Element in HashSet<T> verwendet wird. Das Beispiel verwendet eine unveränderliche Struktur: Zwei Bezeichner mit Value gleich 42 sind gleich, daher weist HashSet<ItemId> das Duplikat zurück.

Beispiele

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

Ergebnis

True
True
True
True
False
1

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen